<spanid="com-vmware-vcenter-package"></span><h1>com.vmware.vcenter package<aclass="headerlink"href="#module-com.vmware.vcenter"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-authentication-client-module"></span><h2>com.vmware.vcenter.authentication_client module<aclass="headerlink"href="#module-com.vmware.vcenter.authentication_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.authentication_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.authentication_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.authentication_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Token</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.authentication_client.Token"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Token</span></code> interface provides operations for obtaining an access token.</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>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Token.IssueSpec</span></code> class contains arguments required for token
exchange.</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>grant_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of <codeclass="docutils literal notranslate"><spanclass="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>
indicates that a token exchange is being performed.
When clients pass a value of this class as a parameter, the
attribute must be one of
<codeclass="docutils literal notranslate"><spanclass="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>. When methods
return a value of this class as a return value, the attribute will
be one of <codeclass="docutils literal notranslate"><spanclass="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code>.</p></li>
<li><p><strong>resource</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Indicates the location of the target service or resource where the
client intends to use the requested security token.
If None, it is inferred from other arguments.</p></li>
<li><p><strong>audience</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The logical name of the target service where the client intends to
use the requested security token. This serves a purpose similar to
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Token.IssueSpec.resource</span></code> attribute, but with the client
providing a logical name rather than a location.
If None, it is inferred from other arguments.</p></li>
<li><p><strong>scope</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of space-delimited, case-sensitive strings, that allow the
client to specify the desired scope of the requested security token
in the context of the service or resource where the token will be
used.
If None, it is inferred from other arguments.</p></li>
<li><p><strong>requested_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – An identifier for the type of the requested security token. If the
requested type is unspecified, the issued token type is at the
discretion of the server and may be dictated by knowledge of the
requirements of the service or resource indicated by the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Token.IssueSpec.resource</span></code> or
If None, it is inferred from other arguments.</p></li>
<li><p><strong>subject_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>A security token that represents the identity of the party on
behalf of whom exchange is being made. Typically, the subject of
this token will be the subject of the security token issued. Token
is base64-encoded.</p>
<p>The attribute is required when the value of the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Token.IssueSpec.grant_type</span></code> attribute is
This attribute is currently required. In the future, the class may
support grant-types other than
<codeclass="docutils literal notranslate"><spanclass="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code> for which the
value may be None.</p>
</p></li>
<li><p><strong>subject_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>An identifier, that indicates the type of the security token in the
This attribute is currently required. In the future, the class may
support grant-types other than
<codeclass="docutils literal notranslate"><spanclass="pre">urn:ietf:params:oauth:grant-type:token-exchange</span></code> for which the
value may be None.</p>
</p></li>
<li><p><strong>actor_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A security token that represents the identity of the acting party.
Typically, this will be the party that is authorized to use the
requested security token and act on behalf of the subject.
None if not needed for the specific case of exchange.</p></li>
<li><p><strong>actor_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – An identifier, that indicates the type of the security token in the
<codeclass="sig-name descname"><spanclass="pre">issue</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.authentication_client.Token.issue"title="Permalink to this definition">¶</a></dt>
<dd><p>Provides a token endpoint as defined in <aclass="reference external"href="https://tools.ietf.org/html/rfc6749#section-3.2">RFC 6749</a>.</p>
<ddclass="field-odd"><p><aclass="reference internal"href="com.vmware.html#com.vmware.oauth2_client.TokenInfo"title="com.vmware.oauth2_client.TokenInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.oauth2_client.TokenInfo</span></code></a> class that contains a
if <aclass="reference internal"href="#com.vmware.vcenter.authentication_client.Token.IssueSpec"title="com.vmware.vcenter.authentication_client.Token.IssueSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Token.IssueSpec</span></code></a> is missing a required attribute,
includes an unsupported attribute value (other than
<spanid="com-vmware-vcenter-certificate-management-client-module"></span><h2>com.vmware.vcenter.certificate_management_client module<aclass="headerlink"href="#module-com.vmware.vcenter.certificate_management_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.certificate_management_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.certificate_management_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.certificate_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">X509CertChain</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cert_chain</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.certificate_management_client.X509CertChain"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">X509CertChain</span></code> class contains x509 certificate chain. This class was
added in vSphere API 6.7.2.</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>cert_chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Certificate chain in base64 format. This attribute was added in
<spanid="com-vmware-vcenter-compute-client-module"></span><h2>com.vmware.vcenter.compute_client module<aclass="headerlink"href="#module-com.vmware.vcenter.compute_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute_client</span></code> module provides classes for managing
compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Policies</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.compute_client.Policies"title="Permalink to this definition">¶</a></dt>
<strong>Warning:</strong> This class is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</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>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.compute.Policy'</span></em><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for the compute policy. <strong>Warning:</strong> This class attribute is
available as Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview APIs
might only be applicable to specific environments.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capability</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.compute_client.Policies.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.Summary</span></code> class contains commonly used information about a
compute policy. <strong>Warning:</strong> This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</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>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy. <strong>Warning:</strong> This attribute is available
as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.Policy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the policy. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the policy. <strong>Warning:</strong> This attribute is available
as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</p></li>
<li><p><strong>capability</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the capability this policy is based on. <strong>Warning:</strong>
This attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.compute.policies.Capability</span></code>. When methods
return a value of this class as a return value, the attribute will
<codeclass="sig-name descname"><spanclass="pre">create</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.compute_client.Policies.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new compute policy in VMware Cloud on AWS. Usage beyond
VMware Cloud on AWS is not supported. <strong>Warning:</strong> This method is
available as Technology Preview. These are early access APIs provided
to test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code>) – Specification for the new policy to be created. The new policy will
be an instance of the capability that has the creation type (see
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a specific compute policy in VMware Cloud on AWS. Usage beyond
VMware Cloud on AWS is not supported. <strong>Warning:</strong> This method is
available as Technology Preview. These are early access APIs provided
to test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy to be deleted.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a specific compute policy in VMware Cloud on
AWS. Usage beyond VMware Cloud on AWS is not supported. <strong>Warning:</strong>
This method is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the policy for which information should be retrieved.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.compute_client.Policies.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the compute policies available in this
vCenter server in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS
is not supported. <strong>Warning:</strong> This method is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.compute_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.compute_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-crypto-manager-client-module"></span><h2>com.vmware.vcenter.crypto_manager_client module<aclass="headerlink"href="#module-com.vmware.vcenter.crypto_manager_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.crypto_manager_client</span></code> module provides classes for
managing key providers and cryptographic keys.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.crypto_manager_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.crypto_manager_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-datastore-client-module"></span><h2>com.vmware.vcenter.datastore_client module<aclass="headerlink"href="#module-com.vmware.vcenter.datastore_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.datastore_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DefaultPolicy</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.datastore_client.DefaultPolicy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DefaultPolicy</span></code> class provides methods related to storage policies
associated with datastore object. The <aclass="reference internal"href="#com.vmware.vcenter.datastore_client.DefaultPolicy.get"title="com.vmware.vcenter.datastore_client.DefaultPolicy.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">DefaultPolicy.get()</span></code></a> method
provides information about the default storage policy associated with the
specific datastore. This class was added in vSphere API 6.7.</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>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.datastore_client.DefaultPolicy.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the identifier of the current default storage policy associated
with the specified datastore. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore for which the default policy is
requested.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.datastore_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.datastore_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-deployment-client-module"></span><h2>com.vmware.vcenter.deployment_client module<aclass="headerlink"href="#module-com.vmware.vcenter.deployment_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ApplianceSize</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.deployment_client.ApplianceSize"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code> class defines the vCenter Server Appliance sizes.
This enumeration was added in vSphere API 7.0.0.0.</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 <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceSize"title="com.vmware.vcenter.deployment_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">LARGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='LARGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceSize.LARGE"title="Permalink to this definition">¶</a></dt>
<dd><p>Appliance size of ‘large’. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">MEDIUM</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='MEDIUM')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceSize.MEDIUM"title="Permalink to this definition">¶</a></dt>
<dd><p>Appliance size of ‘medium’. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">SMALL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='SMALL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceSize.SMALL"title="Permalink to this definition">¶</a></dt>
<dd><p>Appliance size of ‘small’. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">TINY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='TINY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceSize.TINY"title="Permalink to this definition">¶</a></dt>
<dd><p>Appliance size of ‘tiny’. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">XLARGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceSize(string='XLARGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceSize.XLARGE"title="Permalink to this definition">¶</a></dt>
<dd><p>Appliance size of ‘extra large’. This class attribute was added in vSphere
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ApplianceState</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.deployment_client.ApplianceState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ApplianceState</span></code> class defines the various states the vCenter
Appliance can be in. This enumeration was added in vSphere API 6.7.</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 <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceState"title="com.vmware.vcenter.deployment_client.ApplianceState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceState</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CONFIGURED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceState(string='CONFIGURED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.CONFIGURED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance has been configured. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">CONFIG_IN_PROGRESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceState(string='CONFIG_IN_PROGRESS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.CONFIG_IN_PROGRESS"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is in the process of being configured. This class attribute
<codeclass="sig-name descname"><spanclass="pre">FAILED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceState(string='FAILED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance configuration has failed. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">INITIALIZED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceState(string='INITIALIZED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.INITIALIZED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is initialized and ready to be configured. This class
<codeclass="sig-name descname"><spanclass="pre">NOT_INITIALIZED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceState(string='NOT_INITIALIZED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.NOT_INITIALIZED"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is in the process of being initialized and not ready for
configuration. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">QUESTION_RAISED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceState(string='QUESTION_RAISED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceState.QUESTION_RAISED"title="Permalink to this definition">¶</a></dt>
<dd><p>The deployment script has raised a question and is waiting for an answer to
continue with the appliance configuration. This class attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ApplianceType</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.deployment_client.ApplianceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ApplianceType</span></code> class defines the vCenter appliance types. This
enumeration was added in vSphere API 6.7.</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 <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceType"title="com.vmware.vcenter.deployment_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceType</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">PSC_EXTERNAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceType(string='PSC_EXTERNAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceType.PSC_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>An external Platform Services Controller. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">VCSA_EMBEDDED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceType(string='VCSA_EMBEDDED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EMBEDDED"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an embedded Platform Services Controller.
This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">VCSA_EXTERNAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceType(string='VCSA_EXTERNAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ApplianceType.VCSA_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an external Platform Services Controller.
This class attribute was added in vSphere API 6.7.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CheckInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">result</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">source_info</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.deployment_client.CheckInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CheckInfo</span></code> class describes the result of the appliance deployment
check. This class was added in vSphere API 6.7.</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>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.CheckStatus"title="com.vmware.vcenter.deployment_client.CheckStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CheckStatus</span></code></a>) – Status of the check. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>result</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notifications"title="com.vmware.vcenter.deployment_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the check. This attribute was added in vSphere API 6.7.
This attribute will be None if result is not available at the
current step of the task.</p></li>
<li><p><strong>source_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.SourceInfo"title="com.vmware.vcenter.deployment_client.SourceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information collected from the source machine. This attribute was
added in vSphere API 7.0.0.0.
This attribute is used only for upgrade and migrate.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CheckStatus</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.deployment_client.CheckStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CheckStatus</span></code> class defines the status of the checks. This
enumeration was added in vSphere API 6.7.</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 <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.CheckStatus"title="com.vmware.vcenter.deployment_client.CheckStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CheckStatus</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAILED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CheckStatus(string='FAILED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.CheckStatus.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>A fatal error was encountered when running the sanity checks. This class
<codeclass="sig-name descname"><spanclass="pre">SUCCESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CheckStatus(string='SUCCESS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.CheckStatus.SUCCESS"title="Permalink to this definition">¶</a></dt>
<dd><p>All checks have completed successfully. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DataMigrationEstimate</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">estimated_export_time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">estimated_import_time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">required_free_disk_space_on_source</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.deployment_client.DataMigrationEstimate"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DataMigrationEstimate</span></code> {class contains estimated time and disk space
required for the vCenter Server database migration. This class was added in
vSphere API 7.0.0.0.</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>estimated_export_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The time estimated to export data from the source vCenter Server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>estimated_import_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The time estimated to import data to the upgraded vCenter Server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>required_free_disk_space_on_source</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code>) – The extra free space required on source vCenter Server. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DataMigrationInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">core</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">core_events_tasks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">all</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">core_events_tasks_with_deferred</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">all_with_deferred</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.deployment_client.DataMigrationInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DataMigrationInfo</span></code> {class contains the disk space requirements and
time estimates for the different choices available to migrate the vCenter
Server data. This class was added in vSphere API 7.0.0.0.</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>core</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate"title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataMigrationEstimate</span></code></a>) – Migrate only core data and configuration from vCenter Server.
Events, tasks, and stats will not be migrated. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>core_events_tasks</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate"title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataMigrationEstimate</span></code></a>) – Migrate core, events, and tasks from vCenter Server. Stats will not
be migrated. This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>all</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate"title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataMigrationEstimate</span></code></a>) – Migrate all data from vCenter Server. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>core_events_tasks_with_deferred</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate"title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataMigrationEstimate</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Migrate core, events, and tasks from vCenter Server. Events and
tasks will be migrated after the upgrade. Stats will not be
migrated. This attribute was added in vSphere API 7.0.0.0.
This attribute will be available only if the source database is
using an external database.</p></li>
<li><p><strong>all_with_deferred</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.DataMigrationEstimate"title="com.vmware.vcenter.deployment_client.DataMigrationEstimate"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataMigrationEstimate</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Migrate all data from vCenter Server. Events, tasks, and stats will
be migrated after the upgrade. This attribute was added in vSphere
API 7.0.0.0.
This attribute will be available only if the source database is
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HistoryMigrationOption</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.deployment_client.HistoryMigrationOption"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HistoryMigrationOption</span></code> class defines the vCenter history migration
option choices. This enumeration was added in vSphere API 6.7.</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 <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption"title="com.vmware.vcenter.deployment_client.HistoryMigrationOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HistoryMigrationOption</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ALL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HistoryMigrationOption(string='ALL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption.ALL"title="Permalink to this definition">¶</a></dt>
<dd><p>All history data will be migrated along with the core data. This class
<codeclass="sig-name descname"><spanclass="pre">EVENTS_TASKS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HistoryMigrationOption(string='EVENTS_TASKS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption.EVENTS_TASKS"title="Permalink to this definition">¶</a></dt>
<dd><p>Only event data and task data will be migrated along with the core data.
This class attribute was added in vSphere API 6.7.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HistoryMigrationSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">data_set</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">defer_import</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.deployment_client.HistoryMigrationSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HistoryMigrationSpec</span></code> class defines how vCenter history data will be
migrated. vCenter History data includes</p>
<ulclass="simple">
<li><p>Statistics</p></li>
<li><p>Events</p></li>
<li><p>Tasks</p></li>
</ul>
<p>. This class was added in vSphere API 6.7.</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>data_set</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.HistoryMigrationOption"title="com.vmware.vcenter.deployment_client.HistoryMigrationOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HistoryMigrationOption</span></code></a>) – Defines what part of vCenter historical data will be migrated along
with core data. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>defer_import</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Defines how vCenter history will be migrated. If set to true,
vCenter history will be migrated separately after successful
upgrade(supported scenarios are upgrade from 6.0 or 6.5 to 6.7) or
migration, otherwise it will be migrated along with core data
during the upgrade or migration process. vCSA upgrade with deferred
import is no longer supported for target version 7.0 and later.
This attribute was added in vSphere API 6.7.
If None, vCenter historical data won’t be deferred and will be
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ImportHistory</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.deployment_client.ImportHistory"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImportHistory</span></code> class provides methods for managing the import of
vCenter historical data, e.g. Tasks, Events and Statistics, when is is
imported separately from the upgrade or migration process. This class was
added in vSphere API 6.7.</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">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</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.deployment_client.ImportHistory.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImportHistory.CreateSpec</span></code> class contains information to create and
start vCenter historical data deferred import. This class was added in
vSphere API 6.7.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the vCenter history import task. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the vCenter history import task. This attribute was
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImportHistory.Info</span></code> class contains attributes to describe the state
of vCenter history import task. This class was added in vSphere API 6.7.</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>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a>) – The progress info of this task. This attribute was added in vSphere
API 6.7.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">#status</span></code> is one of
<li><p><strong>result</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notifications"title="com.vmware.vcenter.deployment_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Result of the operation. If an operation reports partial results
before it completes, this attribute could be <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> before
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.CommonInfo.status</span></code> has the
value <aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>. The
value could change as the operation progresses. This attribute was
added in vSphere API 6.7.
This attribute will be None if result is not available at the
current step of the operation.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the operation associated with the task.</p></li>
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service containing the operation.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the operation associated with the task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Parent of the current task.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target created by the operation or an existing
one the operation performed on.
This attribute will be None if the operation has no target or
multiple targets.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
<li><p><strong>cancelable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
value may change as the operation progresses.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
If None the description of why the operation failed will be
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
<codeclass="sig-name descname"><spanclass="pre">cancel</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels the task for importing vCenter historical data. This method was
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the current status of the vCenter historical data import. This
<codeclass="sig-name descname"><spanclass="pre">pause</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.pause"title="Permalink to this definition">¶</a></dt>
<dd><p>Pauses the task for importing vCenter historical data. This method was
<codeclass="sig-name descname"><spanclass="pre">resume</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.ImportHistory.resume"title="Permalink to this definition">¶</a></dt>
<dd><p>Resumes the task for importing vCenter historical data. This method was
<codeclass="sig-name descname"><spanclass="pre">start</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</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.deployment_client.ImportHistory.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates and starts task for importing vCenter historical data. This
method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec"title="com.vmware.vcenter.deployment_client.ImportHistory.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ImportHistory.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>An optional <codeclass="docutils literal notranslate"><spanclass="pre">ImportHistory.CreateSpec</span></code> info that can be passed
for creating a new historical data import task and starts it.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Install</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.deployment_client.Install"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Install</span></code> class provides methods to configure the installation of the
appliance. This class was added in vSphere API 6.7.</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">InstallSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vcsa_embedded</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">auto_answer</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.deployment_client.Install.InstallSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Install.InstallSpec</span></code> class contains information used to configure
the appliance installation. This class was added in vSphere API 6.7.</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>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec"title="com.vmware.vcenter.deployment_client.Install.VcsaEmbeddedSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.VcsaEmbeddedSpec</span></code></a>) – Spec used to configure an embedded vCenter Server. This field
describes how the embedded vCenter Server appliance should be
configured. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>auto_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Use the default option for any questions that may come up during
appliance configuration. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VcsaEmbeddedSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">standalone</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">replicated</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ceip_enabled</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.deployment_client.Install.VcsaEmbeddedSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Install.VcsaEmbeddedSpec</span></code> class contains information used to
configure an embedded standalone or replicated vCenter Server. This class
was added in vSphere API 6.7.</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>standalone</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.StandaloneSpec"title="com.vmware.vcenter.deployment_client.StandaloneSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StandaloneSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a standalone embedded vCenter Server. This
field describes how the standalone vCenter Server appliance should
be configured. This attribute was added in vSphere API 6.7.
If None, will default to None.</p></li>
<li><p><strong>replicated</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ReplicatedSpec"title="com.vmware.vcenter.deployment_client.ReplicatedSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicatedSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Spec used to configure a replicated embedded vCenter Server. This
field describes how the replicated vCenter Server appliance should
be configured. This attribute was added in vSphere API 6.7.
If None, will default to None.</p></li>
<li><p><strong>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether CEIP should be enabled or disabled. This attribute was
<codeclass="sig-name descname"><spanclass="pre">cancel</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel the appliance installation that is in progress. This method was
<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.deployment_client.Install.check"title="Permalink to this definition">¶</a></dt>
<dd><p>Run sanity checks using the InstallSpec parameters passed. This method
was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Install.InstallSpec"title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.InstallSpec</span></code></a>) – InstallSpec parameters to run sanity check with.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Install.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the parameters used to configure the ongoing appliance
installation. This method was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">start</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.deployment_client.Install.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Start the appliance installation. This method was added in vSphere API
6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Install.InstallSpec"title="com.vmware.vcenter.deployment_client.Install.InstallSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Install.InstallSpec</span></code></a>) – InstallSpec parameters to configure the appliance install.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LocationSpec</span></code> class is used to pass the container ESXi or vCenter
server of the VM to patch the size of this appliance. This class was added
in vSphere API 6.7.</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>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the container. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the container. This attribute was added in
vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
This attribute is only relevant if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is
true and and <codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is None, the CA certificate will be
used for verification. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is true and
<codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is set then the thumbprint will be used for
verification. No verification will be performed if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code>
value is set to false. This attribute was added in vSphere API 6.7.
If None, ssl_verify true will be used.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator account on the host. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator account password. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Migrate</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.deployment_client.Migrate"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Migrate</span></code> class provides methods to configure the migration of this
appliance from an existing vCenter for Windows. This class was added in
vSphere API 7.0.0.0.</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>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Migrate.MigrateSpec</span></code> class contains the fields to migrate an
existing vCenter Server for Windows to an appliance. This class was added
in vSphere API 7.0.0.0.</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>source_vc_windows</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Migrate.SourceVcWindows"title="com.vmware.vcenter.deployment_client.Migrate.SourceVcWindows"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.SourceVcWindows</span></code></a>) – Information specific to the Windows vCenter Server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>existing_migration_assistant</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Migrate.MigrationAssistantSpec"title="com.vmware.vcenter.deployment_client.Migrate.MigrationAssistantSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.MigrationAssistantSpec</span></code></a>) – Information specific to the Migration Assistant that is running on
the Windows vCenter Server. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>history</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec"title="com.vmware.vcenter.deployment_client.HistoryMigrationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HistoryMigrationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Determines how vCenter history will be migrated during the
migration process. vCenter history consists of:</p>
<ul>
<li><p>Statistics</p></li>
<li><p>Events</p></li>
<li><p>Tasks</p></li>
</ul>
<p>By default only core data will be migrated. Use this spec to define
which part of vCenter history data will be migrated and when. This
attribute was added in vSphere API 7.0.0.0.
If None, only core database content will be migrated.</p>
</p></li>
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Migrate.VcsaEmbeddedSpec"title="com.vmware.vcenter.deployment_client.Migrate.VcsaEmbeddedSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.VcsaEmbeddedSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information specific to an embedded vCenter Server. This attribute
was added in vSphere API 7.0.0.0.
Only required if the vCenter Server that is going to be migrated is
an embedded vCenter Server.</p></li>
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Migrate.PscSpec"title="com.vmware.vcenter.deployment_client.Migrate.PscSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.PscSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information specific to a Platform Services Controller. This
attribute was added in vSphere API 7.0.0.0.
Only required if the vCenter Server that is going to be migrated is
a Platform Services Controller.</p></li>
<li><p><strong>active_directory</strong> (<aclass="reference internal"href="com.vmware.vcenter.deployment.html#com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec"title="com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information specific to the Active Directory server to which the
source windows vCenter Server is joined. This attribute was added
in vSphere API 7.0.0.0.
If None, existing appliance will not be joined to an Active
Directory.</p></li>
<li><p><strong>auto_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Use the default option for any questions that may come up during
appliance configuration. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">MigrationAssistantSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">https_port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumbprint</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.deployment_client.Migrate.MigrationAssistantSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Migrate.MigrationAssistantSpec</span></code> class contains the information
needed to connect to the Migration Assistant that is running on the source
windows vCenter Server machine. This class was added in vSphere API
7.0.0.0.</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>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port being used by Migration Assistant. This attribute
was added in vSphere API 7.0.0.0.
If None, port 9123 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – SHA1 thumbprint of the Migration Assistant SSL certificate that
will be used for verification. This attribute was added in vSphere
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">PscSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ceip_enabled</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.deployment_client.Migrate.PscSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Migrate.PscSpec</span></code> class contains information used to migrate a
windows Platform Service Controller to Platform Service Controller
appliance. This class was added in vSphere API 7.0.0.0.</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>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Customer experience improvement program should be enabled or
disabled for this Platform Services Controller migration. This
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SourceVcWindows</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">hostname</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">username</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</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.deployment_client.Migrate.SourceVcWindows"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Migrate.SourceVcWindows</span></code> class contains information about the
windows vCenter Server that is going to be migrated. This class was added
in vSphere API 7.0.0.0.</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>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the source Windows
machine. This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO account with administrative privilege to perform the
migration operation. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VcsaEmbeddedSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ceip_enabled</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.deployment_client.Migrate.VcsaEmbeddedSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Migrate.VcsaEmbeddedSpec</span></code> class contains information used to migrate
an embedded vCenter Server for Windows to embedded vCenter Server
appliance. This class was added in vSphere API 7.0.0.0.</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>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Customer experience improvement program should be enabled or
disabled for this embedded vCenter Server migration. This attribute
<codeclass="sig-name descname"><spanclass="pre">cancel</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Migrate.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel the appliance migration that is in progress. This method was
<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.deployment_client.Migrate.check"title="Permalink to this definition">¶</a></dt>
<dd><p>Run sanity checks using the MigrateSpec parameters passed. This method
was added in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Migrate.MigrateSpec"title="com.vmware.vcenter.deployment_client.Migrate.MigrateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.MigrateSpec</span></code></a>) – MigrateSpec parameters to run sanity check on.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Migrate.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the MigrateSpec parameters used to configure the ongoing appliance
migration. This method was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">start</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.deployment_client.Migrate.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Start the appliance migration. This method was added in vSphere API
7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Migrate.MigrateSpec"title="com.vmware.vcenter.deployment_client.Migrate.MigrateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Migrate.MigrateSpec</span></code></a>) – MigrateSpec parameters to configure the appliance migration.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notification</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resolution</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.deployment_client.Notification"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Notification</span></code> class contains attributes to describe any
info/warning/error messages that Tasks can raise. This class was added in
vSphere API 6.7.</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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The notification id. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The time the notification was raised/found. This attribute was
added in vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if the time information is available.</p></li>
<li><p><strong>message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The notification message. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>resolution</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The resolution message, if any. This attribute was added in vSphere
API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> for warnings and errors.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notifications</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <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.deployment_client.Notifications"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Notifications</span></code> class contains info/warning/error messages that can
be reported be the task. This class was added in vSphere API 6.7.</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>info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Notification"title="com.vmware.vcenter.deployment_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Info notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an info was reported by the task.</p></li>
<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.vcenter.deployment_client.Notification"title="com.vmware.vcenter.deployment_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Warning notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an warning was reported by the task.</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.vcenter.deployment_client.Notification"title="com.vmware.vcenter.deployment_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Error notification messages reported. This attribute was added in
vSphere API 6.7.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an error was reported by the task.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Operation</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.deployment_client.Operation"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Operation</span></code> class defines the supported vCenter appliance deployment
operations. This enumeration was added in vSphere API 6.7.</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 <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Operation"title="com.vmware.vcenter.deployment_client.Operation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Operation</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">INSTALL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Operation(string='INSTALL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.INSTALL"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance installation is in progress. This class attribute was added
<codeclass="sig-name descname"><spanclass="pre">MIGRATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Operation(string='MIGRATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.MIGRATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance migration is in progress. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">RESTORE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Operation(string='RESTORE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.RESTORE"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance restoration is in progress. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">ROLLBACK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Operation(string='ROLLBACK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.ROLLBACK"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance is being rolled back to an unconfigured state. This class
<codeclass="sig-name descname"><spanclass="pre">UPGRADE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Operation(string='UPGRADE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Operation.UPGRADE"title="Permalink to this definition">¶</a></dt>
<dd><p>The appliance upgrade is in progress. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Question</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.deployment_client.Question"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Question</span></code> class provides methods to get the question raised during
deployment and to answer them. This class was added in vSphere API 6.7.</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">AnswerSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">question_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">answer_val</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.deployment_client.Question.AnswerSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Question.AnswerSpec</span></code> class contains attributes to describe the
answer to a raised question. This class was added in vSphere API 6.7.</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>question_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Id of the question being answered. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>answer_val</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The answer value. This attribute was added in vSphere API 6.7.</p></li>
<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">questions</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.deployment_client.Question.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Question.Info</span></code> class contains attributes to describe questions
raised during the deployment process. This class was added in vSphere API
6.7.</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>questions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Question.Question"title="com.vmware.vcenter.deployment_client.Question.Question"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Question.Question</span></code></a>) – One or more questions raised during the deployment. This attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Question</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">question</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_answer</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">possible_answers</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.deployment_client.Question.Question"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Question.Question</span></code> class contains attributes to describe a
deployment question. This class was added in vSphere API 6.7.</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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Id of the question raised. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>question</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message describing the question. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Question.QuestionType"title="com.vmware.vcenter.deployment_client.Question.QuestionType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Question.QuestionType</span></code></a>) – Type of the question raised. This attribute was added in vSphere
API 6.7.</p></li>
<li><p><strong>default_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Default answer value. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>possible_answers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Possible answers values. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">QuestionType</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.deployment_client.Question.QuestionType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Question.QuestionType</span></code> class defines the type of the question
raised. This enumeration was added in vSphere API 6.7.</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">QuestionType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ABORT_RETRY_IGNORE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">QuestionType(string='ABORT_RETRY_IGNORE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.QuestionType.ABORT_RETRY_IGNORE"title="Permalink to this definition">¶</a></dt>
<dd><p>Question with answer values Abort/Retry/Ignore. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">OK_CANCEL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">QuestionType(string='OK_CANCEL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.QuestionType.OK_CANCEL"title="Permalink to this definition">¶</a></dt>
<dd><p>Question with answer values Ok/Cancel. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">YES_NO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">QuestionType(string='YES_NO')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.QuestionType.YES_NO"title="Permalink to this definition">¶</a></dt>
<dd><p>Question with answer values Yes/No. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">answer</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.deployment_client.Question.answer"title="Permalink to this definition">¶</a></dt>
<dd><p>Supply answer to the raised question. This method was added in vSphere
API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Question.AnswerSpec"title="com.vmware.vcenter.deployment_client.Question.AnswerSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Question.AnswerSpec</span></code></a>) – AnswerSpec with the answer to the raised question.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Question.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the question that was raised during the configuration. This method
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">RemotePscSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">psc_hostname</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">https_port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sso_admin_password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumbprint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_verify</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.deployment_client.RemotePscSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">RemotePscSpec</span></code> class contains information used to configure an
external vCenter Server that registers with a remote PSC. This class was
added in vSphere API 6.7.</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>psc_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the remote PSC to which
this configuring vCenter Server will be registered to. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification when ssl_verify field is set to true. This attribute
was added in vSphere API 6.7.
This attribute is only relevant if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is
true and and <codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is None, the CA certificate will be
used for verification. If <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is true and
<codeclass="docutils literal notranslate"><spanclass="pre">sslThumbprint</span></code> is set then the thumbprint will be used for
verification. No verification will be performed if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code>
value is set to false. This attribute was added in vSphere API 6.7.
If None, <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> true will be used.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicatedPscSpec</span></code> class contains information used to check if the
configuring PSC can be replicated to the remote PSC. This class was added
in vSphere API 6.7.</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>sso_site_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO sitename that will be used in PSC replication. This
attribute was added in vSphere API 6.7.
If None, default-first-site will be used.</p></li>
<li><p><strong>partner_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the partner PSC appliance.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
This attribute is only relevant if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ReplicatedSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">partner_hostname</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">https_port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sso_admin_password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumbprint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_verify</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.deployment_client.ReplicatedSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicatedSpec</span></code> class contains information used to check if the
configuring vCenter Server can be replicated to the remote PSC. This class
was added in vSphere API 6.7.</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>partner_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the partner PSC appliance.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the external PSC appliance. This attribute was
added in vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
This attribute is only relevant if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled. This attribute was
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SourceInfo</span></code> {class contains information about the source vCenter
Server system and the database migration options. This class was added in
vSphere API 7.0.0.0.</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>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the source vCenter Server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Source vCenter Server version. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>deployment_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceType"title="com.vmware.vcenter.deployment_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceType</span></code></a>) – Deployment type of the source vCenter Server. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>deployment_size</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceSize"title="com.vmware.vcenter.deployment_client.ApplianceSize"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ApplianceSize</span></code></a>) – Deployment size of the source vCenter Server. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO domain name of the source vCenter Server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>active_directory_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain name of the Active Directory server to which the source
vCenter Server is joined. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>dns_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP addresses of the DNS servers of the Active Directory server.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>data_migration_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.DataMigrationInfo"title="com.vmware.vcenter.deployment_client.DataMigrationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataMigrationInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains all the available migrate options, estimated export and
import time and the space required to migrate the data. This
attribute was added in vSphere API 7.0.0.0.
This attribute will be available if estimate data is available for
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StandalonePscSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">sso_site_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sso_admin_password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sso_domain_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.StandalonePscSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">StandalonePscSpec</span></code> class contains information used to configure a
standalone PSC appliance. This class was added in vSphere API 6.7.</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>sso_site_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO site name used for this PSC. This attribute was added in
vSphere API 6.7.
If None, default-first-site will be used.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to be used to configure this appliance. This
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StandaloneSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">sso_admin_password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sso_domain_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.StandaloneSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">StandaloneSpec</span></code> class contains information used to configure a
standalone embedded vCenter Server appliance. This class was added in
vSphere API 6.7.</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>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>sso_domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to be used to configure this appliance. This
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_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.deployment_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.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Upgrade</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.deployment_client.Upgrade"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Upgrade</span></code> class provides methods to configure the upgrade of this
appliance from an existing vCenter appliance. This class was added in
vSphere API 6.7.</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">PscSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ceip_enabled</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.deployment_client.Upgrade.PscSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Upgrade.PscSpec</span></code> class contains information used to upgrade a
Platform Service Controller appliance. This class was added in vSphere API
6.7.</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>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Customer experience improvement program should be enabled or
disabled for this Platform Services Controller upgrade. This
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Upgrade.SourceApplianceSpec</span></code> class contains information used to
connect to the appliance used as the source for an upgrade. This class was
added in vSphere API 6.7.</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>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the source appliance. This attribute was added in
vSphere API 6.7.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 thumbprint of the server SSL certificate will be used for
verification. This attribute was added in vSphere API 6.7.
This attribute is only relevant if <codeclass="docutils literal notranslate"><spanclass="pre">sslVerify</span></code> is None or has the
value true.</p></li>
<li><p><strong>ssl_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL verification should be enabled or disabled for the source
appliance validations. By default it is enabled and will use SSL
certificate for verification. If thumbprint is provided, will use
thumbprint for the verification. This attribute was added in
vSphere API 6.7.
If None, ssl_verify true will be used.</p></li>
<li><p><strong>sso_admin_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account on the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>sso_admin_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SSO administrator account password. This attribute was added in
vSphere API 6.7.</p></li>
<li><p><strong>root_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password of the root user on the source appliance. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>ssh_verify</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Appliance SSH verification should be enabled or disabled. By
default it is disabled and will not use any verification. If
thumbprint is provided, thumbprint verification will be performed.
This attribute was added in vSphere API 6.7.
If None, ssh_verify true will be used.</p></li>
<li><p><strong>ssh_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MD5 thumbprint of the server SSH key will be used for verification.
This attribute was added in vSphere API 6.7.
This attribute is only relevant if <codeclass="docutils literal notranslate"><spanclass="pre">sshVerify</span></code> is None or has the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpgradeSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">source_appliance</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">source_location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">history</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vcsa_embedded</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">psc</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">auto_answer</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.deployment_client.Upgrade.UpgradeSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Upgrade.UpgradeSpec</span></code> class contains information used to configure
the appliance upgrade. This class was added in vSphere API 6.7.</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>source_appliance</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec"title="com.vmware.vcenter.deployment_client.Upgrade.SourceApplianceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.SourceApplianceSpec</span></code></a>) – Source appliance spec. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.LocationSpec"title="com.vmware.vcenter.deployment_client.LocationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocationSpec</span></code></a>) – Source location spec. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>history</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.HistoryMigrationSpec"title="com.vmware.vcenter.deployment_client.HistoryMigrationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HistoryMigrationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Determines how vCenter history will be migrated during the upgrade
process. vCenter history consists of:</p>
<ul>
<li><p>Statistics</p></li>
<li><p>Events</p></li>
<li><p>Tasks</p></li>
</ul>
<p>By default only core data will be migrated. Use this spec to define
which part of vCenter history data will be migrated and when. This
attribute was added in vSphere API 6.7.
If None, only core database content will be migrated.</p>
</p></li>
<li><p><strong>vcsa_embedded</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec"title="com.vmware.vcenter.deployment_client.Upgrade.VcsaEmbeddedSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.VcsaEmbeddedSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information that are specific to this embedded vCenter Server. This
attribute was added in vSphere API 6.7.
If None, ceip_enabled for embedded vcenter server upgrade will
default to enabled.</p></li>
<li><p><strong>psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.PscSpec"title="com.vmware.vcenter.deployment_client.Upgrade.PscSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.PscSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information that are specific to this Platform Services Controller.
This attribute was added in vSphere API 6.7.
If None, ceip_enabled for psc upgrade will default to enabled.</p></li>
<li><p><strong>auto_answer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Use the default option for any questions that may come up during
appliance configuration. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VcsaEmbeddedSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ceip_enabled</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.deployment_client.Upgrade.VcsaEmbeddedSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Upgrade.VcsaEmbeddedSpec</span></code> class contains information used to upgrade
a Embedded vCenter Server appliance. This class was added in vSphere API
6.7.</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>ceip_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Customer experience improvement program should be enabled or
disabled for this embedded vCenter Server upgrade. This attribute
<codeclass="sig-name descname"><spanclass="pre">cancel</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.cancel"title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel the appliance upgrade that is in progress. This method was added
<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.deployment_client.Upgrade.check"title="Permalink to this definition">¶</a></dt>
<dd><p>Run sanity checks using the UpgradeSpec parameters passed. This method
was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.UpgradeSpec</span></code></a>) – UpgradeSpec parameters to run sanity check on.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.Upgrade.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the UpgradeSpec parameters used to configure the ongoing appliance
upgrade. This method was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">start</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.deployment_client.Upgrade.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Start the appliance installation. This method was added in vSphere API
6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"title="com.vmware.vcenter.deployment_client.Upgrade.UpgradeSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Upgrade.UpgradeSpec</span></code></a>) – UpgradeSpec parameters to configure the appliance upgrade.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.deployment_client.</span></code><codeclass="sig-name descname"><spanclass="pre">VerificationMode</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.deployment_client.VerificationMode"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VerificationMode</span></code> class defines the verification modes for SSL
certificates or SSH connections. This enumeration was added in vSphere API
6.7.</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 <aclass="reference internal"href="#com.vmware.vcenter.deployment_client.VerificationMode"title="com.vmware.vcenter.deployment_client.VerificationMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VerificationMode</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VerificationMode(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.VerificationMode.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>No verification will be performed. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">THUMBPRINT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VerificationMode(string='THUMBPRINT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.deployment_client.VerificationMode.THUMBPRINT"title="Permalink to this definition">¶</a></dt>
<dd><p>Passed thumbprint will be used for verification. This class attribute was
<spanid="com-vmware-vcenter-guest-client-module"></span><h2>com.vmware.vcenter.guest_client module<aclass="headerlink"href="#module-com.vmware.vcenter.guest_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.guest_client</span></code> module provides classes for managing
guest customization specifications in the vCenter Server.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AdapterMapping</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mac_address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">adapter</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.guest_client.AdapterMapping"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AdapterMapping</span></code> class specifies the association between a virtual
network adapter and its IP settings. This class was added in vSphere API
7.0.0.0.</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>mac_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The MAC address of a network adapter being customized. This
attribute was added in vSphere API 7.0.0.0.
If None, the customization process maps the the settings from the
list of AdapterMappings.IPSettings in the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CustomizationSpec.interfaces</span></code> to the virtual machine’s
network adapters, in PCI slot order. The first virtual network
adapter on the PCI bus is assigned interfaces[0].IPSettings, the
second adapter is assigned interfaces[1].IPSettings, and so on.</p></li>
<li><p><strong>adapter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.IPSettings"title="com.vmware.vcenter.guest_client.IPSettings"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IPSettings</span></code></a>) – The IP settings for the associated virtual network adapter. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ConfigurationSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">windows_config</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">linux_config</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.guest_client.ConfigurationSpec"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CustomizationSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">configuration_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">global_dns_settings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">interfaces</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.guest_client.CustomizationSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpec</span></code> class contains information required to customize
a virtual machine when deploying it or migrating it to a new host. This
class was added in vSphere API 7.0.0.0.</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>configuration_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.ConfigurationSpec"title="com.vmware.vcenter.guest_client.ConfigurationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConfigurationSpec</span></code></a>) – Settings to be applied to the guest during the customization. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>global_dns_settings</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.GlobalDNSSettings"title="com.vmware.vcenter.guest_client.GlobalDNSSettings"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GlobalDNSSettings</span></code></a>) – Global DNS settings constitute the DNS settings that are not
specific to a particular virtual network adapter. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>interfaces</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.guest_client.AdapterMapping"title="com.vmware.vcenter.guest_client.AdapterMapping"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AdapterMapping</span></code></a>) – IP settings that are specific to a particular virtual network
adapter. The <aclass="reference internal"href="#com.vmware.vcenter.guest_client.AdapterMapping"title="com.vmware.vcenter.guest_client.AdapterMapping"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AdapterMapping</span></code></a> class maps a network adapter’s
MAC address to its <aclass="reference internal"href="#com.vmware.vcenter.guest_client.IPSettings"title="com.vmware.vcenter.guest_client.IPSettings"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IPSettings</span></code></a>. May be empty if there are
no network adapters, else should match number of network adapters
configured for the VM. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CustomizationSpecs</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.guest_client.CustomizationSpecs"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs</span></code> class provides methods to manage guest
customization specifications in the vCenter Server. 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">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">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">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.CreateSpec</span></code> class contains specification
information and specification object that can be passed to the
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.create"title="com.vmware.vcenter.guest_client.CustomizationSpecs.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">CustomizationSpecs.create()</span></code></a> method. This class was added in vSphere
API 7.0.0.0.</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>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpec"title="com.vmware.vcenter.guest_client.CustomizationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpec</span></code></a>) – The specification object. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the specification. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the specification. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">names</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">os_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.guest_client.CustomizationSpecs.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.FilterSpec</span></code> class contains attributes used to
filter the results when listing guest customization specifications (see
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.list"title="com.vmware.vcenter.guest_client.CustomizationSpecs.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">CustomizationSpecs.list()</span></code></a>). If multiple attributes are specified,
only guest customization specifications matching all of the attributes
match the filter. 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>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that guest customization specifications must have to match
the filter (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Summary.name</span></code>). This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>. When methods return
a value of this class as a return value, the attribute will contain
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Format</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.guest_client.CustomizationSpecs.Format"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Format</span></code> class specifies the formats the
customization specification can be exported to. This enumeration was added
in vSphere API 7.0.0.0.</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">Format</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">JSON</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Format(string='JSON')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Format.JSON"title="Permalink to this definition">¶</a></dt>
<dd><p>JSON format. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">XML</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Format(string='XML')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Format.XML"title="Permalink to this definition">¶</a></dt>
<dd><p>XML format. This class attribute was added in vSphere API 7.0.0.0.</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">last_modified</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</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.guest_client.CustomizationSpecs.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Info</span></code> class describes a guest customization
specification and the timestamp when it was last modified. This is returned
by the <aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.get"title="com.vmware.vcenter.guest_client.CustomizationSpecs.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">CustomizationSpecs.get()</span></code></a> method. This class was added in
vSphere API 7.0.0.0.</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>last_modified</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the specification was last modified. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Spec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Spec</span></code></a>) – The Spec object including specification and metadata information.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Metadata</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Metadata"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Metadata</span></code> class contains metadata i.e. name and
description related to a customization specification. This class was added
in vSphere API 7.0.0.0.</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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the specification. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the specification. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">OsType</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.guest_client.CustomizationSpecs.OsType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.OsType</span></code> class defines the types of guest
operating systems for which guest customization is supported. 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">OsType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">OsType(string='LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.LINUX"title="Permalink to this definition">¶</a></dt>
<dd><p>A customization specification for a Linux guest operating system. This
class attribute was added in vSphere API 6.7.1.</p>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">OsType(string='WINDOWS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType.WINDOWS"title="Permalink to this definition">¶</a></dt>
<dd><p>A customization specification for a Windows guest operating system. This
class attribute was added in vSphere API 6.7.1.</p>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.guest.CustomizationSpec'</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for a vCenter guest customization specification. This class
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Spec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">fingerprint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Spec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Spec</span></code> class contains the specification
information and specification object. This is passed to the
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.set"title="com.vmware.vcenter.guest_client.CustomizationSpecs.set"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">CustomizationSpecs.set()</span></code></a> method. This class was added in vSphere API
7.0.0.0.</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>fingerprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The fingerprint is a unique identifier for a given version of the
configuration. Each change to the configuration will update this
value. A client cannot change this value. If specified when
updating a specification, the changes will only be applied if the
current fingerprint matches the specified fingerprint. This field
can be used to guard against updates that has happened between the
specification content was read and until it is applied. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpec"title="com.vmware.vcenter.guest_client.CustomizationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpec</span></code></a>) – The specification object. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the specification. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the specification. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">os_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">last_modified</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.guest_client.CustomizationSpecs.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Summary</span></code> class contains commonly used information
about a guest customization 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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the guest customization specification. This attribute was
added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.guest.CustomizationSpec</span></code>. When methods return
a value of this class as a return value, the attribute will be an
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the guest customization specification. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>os_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"title="com.vmware.vcenter.guest_client.CustomizationSpecs.OsType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.OsType</span></code></a>) – Guest operating system type for which that this guest customization
specification applies. This attribute was added in vSphere API
6.7.1.</p></li>
<li><p><strong>last_modified</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Date and tme when this guest customization specification was last
modified. This attribute was added in vSphere API 6.7.1.</p></li>
<codeclass="sig-name descname"><spanclass="pre">create</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.guest_client.CustomizationSpecs.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a customization specification. This method was added in vSphere
API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.CreateSpec</span></code></a>) – The information i.e. name, description and the settings i.e
hostname, ip address etc for the new customization specification
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a customization specification with the specified identifier.
This method was added in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the customization specification that needs to be
deleted.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">export</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">format</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.export"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the content of the customization specification in the specified
format. Note that any passwords in the customization specification will
be set to blank values during the export method. This method was added
in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the customization specification that has to be
returned.
The parameter must be an identifier for the resource type:
<li><p><strong>format</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Format"title="com.vmware.vcenter.guest_client.CustomizationSpecs.Format"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Format</span></code></a>) – The format in which the customization specification has to be
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the guest customization specification from vCenter with the
specified identifier. This method was added in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the customization specification.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">import_specification</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">customization_spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.import_specification"title="Permalink to this definition">¶</a></dt>
<dd><p>Converts a well formatted string to a
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.CreateSpec</span></code></a>. The resulting object can be
passed to <aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.create"title="com.vmware.vcenter.guest_client.CustomizationSpecs.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">CustomizationSpecs.create()</span></code></a> method. This method was
added in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>customization_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – content to be converted to the spec.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</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.guest_client.CustomizationSpecs.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1000 visible (subject to permission
checks) guest customization specifications in vCenter matching the
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.FilterSpec</span></code></a>. 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>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching guest customization specifications for
which information should be returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.FilterSpec</span></code></a> with all attributes None
which means all guest customization specifications match the
<codeclass="sig-name descname"><spanclass="pre">set</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets an existing specification, possibly after retrieving (by using
<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.get"title="com.vmware.vcenter.guest_client.CustomizationSpecs.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">CustomizationSpecs.get()</span></code></a>) and editing it. This method was added
in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the customization specification that needs to be set.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.CustomizationSpecs.Spec"title="com.vmware.vcenter.guest_client.CustomizationSpecs.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CustomizationSpecs.Spec</span></code></a>) – The new specification that will overwrite the existing
if the user doesn’t have the required privileges.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.guest_client.Domain">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Domain</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">workgroup</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain_username</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain_password</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.guest_client.Domain"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Domain</span></code> class specifies the information needed to join a workgroup
or domain. This structure maps to the Identification key in the sysprep.xml
answer file. These values are transferred into the sysprep.xml file that
VirtualCenter stores on the target virtual disk. For more information about
performing unattended installation, check
<aclass="reference external"href="https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx">https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx</a>. This
class was added in vSphere API 7.0.0.0.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.Domain.Type"title="com.vmware.vcenter.guest_client.Domain.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Domain.Type</span></code></a>) – The type of network to join after the customization. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>workgroup</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The workgroup that the virtual machine should join. This attribute
was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Domain.Type.WORKGROUP"title="com.vmware.vcenter.guest_client.Domain.Type.WORKGROUP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Domain.Type.WORKGROUP</span></code></a>.</p></li>
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain to which the virtual machine should be joined. This
attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"title="com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Domain.Type.DOMAIN</span></code></a>.</p></li>
<li><p><strong>domain_username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain user that has permission to join the domain after
virtual machine is joined. This attribute was added in vSphere API
7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"title="com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Domain.Type.DOMAIN</span></code></a>.</p></li>
<li><p><strong>domain_password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain user password that has permission to join the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Domain.domain_username</span></code> after customization. This attribute
was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"title="com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Domain.Type.DOMAIN</span></code></a>.</p></li>
<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.guest_client.Domain.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Domain.Type</span></code> class defines the types of network the virtual machine
should join to after the customization is completed. This enumeration was
added in vSphere API 7.0.0.0.</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">DOMAIN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='DOMAIN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Domain.Type.DOMAIN"title="Permalink to this definition">¶</a></dt>
<dd><p>The virtual machine should be be joined to a domain. This class attribute
<codeclass="sig-name descname"><spanclass="pre">WORKGROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='WORKGROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Domain.Type.WORKGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>The virtual machine should be be joined to a workgroup. This class
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">GlobalDNSSettings</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dns_suffix_list</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">dns_servers</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.guest_client.GlobalDNSSettings"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">GlobalDNSSettings</span></code> class specifies a collection of global IP
settings in the guest operating system. In Linux, DNS server settings are
global. The settings can either be statically set or supplied by a DHCP
server. This class was added in vSphere API 7.0.0.0.</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>dns_suffix_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of name resolution suffixes for the virtual network adapter.
This list applies to both Windows and Linux guest customization.
For Linux, this setting is global, whereas in Windows, this setting
is listed on a per-adapter basis. This attribute was added in
vSphere API 7.0.0.0.
If None, no DNS suffixes are set.</p></li>
<li><p><strong>dns_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS servers, for a virtual network adapter with a static IP
address. If this list is empty, then the guest operating system is
expected to use a DHCP server to get its DNS server settings. These
settings configure the virtual machine to use the specified DNS
servers. These DNS server settings are listed in the order of
preference. This attribute was added in vSphere API 7.0.0.0.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">GuiUnattended</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">auto_logon</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">auto_logon_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">time_zone</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.guest_client.GuiUnattended"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">GuiUnattended</span></code> class maps to the GuiUnattended key in the
sysprep.xml answer file. These values are plugged directly into the
sysprep.xml file that VirtualCenter stores on the target virtual disk. For
more detailed information about performing unattended installations, check
<aclass="reference external"href="https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx">https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx</a>. This
class was added in vSphere API 7.0.0.0.</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>auto_logon</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to determine whether or not the machine automatically logs on
as Administrator. See the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GuiUnattended.password</span></code> property.
If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GuiUnattended.auto_logon</span></code> flag is set, then
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GuiUnattended.password</span></code> must not be None or the guest
customization will fail. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>auto_logon_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GuiUnattended.auto_logon</span></code> flag is <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, then
this property specifies the number of times the machine should
automatically log on as Administrator. Generally it should be 1,
but if the setup requires a number of reboots, you may want to
increase it. This number may be determined by the list of commands.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The new administrator password for the machine. To specify that the
password should be set to blank (that is, no password), leave it
unset. This attribute was added in vSphere API 7.0.0.0.
If None, blank password will be used.</p></li>
<li><p><strong>time_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The time zone index for the virtual machine. Numbers correspond to
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostnameGenerator</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fixed_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</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.guest_client.HostnameGenerator"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HostnameGenerator</span></code> class specifies various mechanisms of generating
the hostname for the guest inside the virtual machine while customization.
This class was added in vSphere API 7.0.0.0.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type"title="com.vmware.vcenter.guest_client.HostnameGenerator.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostnameGenerator.Type</span></code></a>) – The type of the Name Generator. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>fixed_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The virtual machine name specified by the client. This attribute
was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.FIXED"title="com.vmware.vcenter.guest_client.HostnameGenerator.Type.FIXED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">HostnameGenerator.Type.FIXED</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Base prefix, to which a unique number is appended. This attribute
was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.PREFIX"title="com.vmware.vcenter.guest_client.HostnameGenerator.Type.PREFIX"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">HostnameGenerator.Type.PREFIX</span></code></a>.</p></li>
<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.guest_client.HostnameGenerator.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HostnameGenerator.Type</span></code> class specifies different types of Name
Generators. This enumeration was added in vSphere API 7.0.0.0.</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">FIXED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='FIXED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.FIXED"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that a fixed name should be used for the hostname for the virtual
machine during the customization. This class attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">PREFIX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='PREFIX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.PREFIX"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that a unique name should be generated by concatenating the base
string with a number including the network name of the guest.</p>
<p>Virtual machine names are unique across the set of hosts and virtual
machines known to the VirtualCenter instance. VirtualCenter tracks the
network names of virtual machines as well as hosts. VMware Tools runs in a
guest operating system and reports information to VirtualCenter.. This
class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">USER_INPUT_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USER_INPUT_REQUIRED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.USER_INPUT_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the host name is not specified in advance. The user must
provide a valid value when the actual customization spec is applied to a
virtual machine. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VIRTUAL_MACHINE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='VIRTUAL_MACHINE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.HostnameGenerator.Type.VIRTUAL_MACHINE"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that the VirtualCenter should generate a virtual machine name.</p>
<p>The name is generated from a base prefix comprising the virtual machine
entity name. A number is appended, if necessary, to make it unique.</p>
<p>Virtual machine names are unique across the set of hosts and virtual
machines known to the VirtualCenter instance. VirtualCenter tracks the
network names of the virtual machines as well as hosts. VMware Tools runs
in a guest operating system and reports information to VirtualCenter,
including the network name of the guest.. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">IPSettings</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ipv4</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ipv6</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">windows</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.guest_client.IPSettings"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IPSettings</span></code> class specifies the IP settings for a virtual network
adapter. This class was added in vSphere API 7.0.0.0.</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>ipv4</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv4"title="com.vmware.vcenter.guest_client.Ipv4"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification to configure IPv4 address, subnet mask and gateway
info for this virtual network adapter. This attribute was added in
vSphere API 7.0.0.0.
If None, no IPv4 addresses are set.</p></li>
<li><p><strong>ipv6</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv6"title="com.vmware.vcenter.guest_client.Ipv6"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv6</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification to configure IPv6 address, subnet mask and gateway
info for this virtual network adapter. This attribute was added in
vSphere API 7.0.0.0.
If None, no IPv6 addresses are set.</p></li>
<li><p><strong>windows</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings"title="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WindowsNetworkAdapterSettings</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Windows settings to be configured for this specific virtual Network
adapter. This is valid only for Windows guest operating systems.
This attribute was added in vSphere API 7.0.0.0.
If None, no specific Windows settings are set.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.guest_client.Ipv4">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Ipv4</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ip_address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">gateways</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.guest_client.Ipv4"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv4</span></code> class specifies the IPv4 settings that need to be applied to a
virtual network adapter. This class was added in vSphere API 7.0.0.0.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv4.Type"title="com.vmware.vcenter.guest_client.Ipv4.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4.Type</span></code></a>) – The type of the IPv4 configuration. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The static IPv4 address. This attribute was added in vSphere API
7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv4.Type.STATIC"title="com.vmware.vcenter.guest_client.Ipv4.Type.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv4.Type.STATIC</span></code></a>.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The IPv4 CIDR prefix, for example, 24. See
<aclass="reference external"href="http://www.oav.net/mirrors/cidr.html">http://www.oav.net/mirrors/cidr.html</a> for netmask-to-prefix
conversion. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv4.Type.STATIC"title="com.vmware.vcenter.guest_client.Ipv4.Type.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv4.Type.STATIC</span></code></a>.</p></li>
<li><p><strong>gateways</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Gateways for the IPv4 address. This attribute was added in vSphere
<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.guest_client.Ipv4.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv4.Type</span></code> class specifies different types of the IPv4
configuration. This enumeration was added in vSphere API 7.0.0.0.</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">DHCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='DHCP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Ipv4.Type.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>DHCP configuration. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">STATIC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='STATIC')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Ipv4.Type.STATIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Static configuration. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">USER_INPUT_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USER_INPUT_REQUIRED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Ipv4.Type.USER_INPUT_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the IPv4 settings are not specified in advance. The user
must provide a valid value when the actual customization spec is applied to
a virtual machine. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.guest_client.Ipv6">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Ipv6</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ipv6</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">gateways</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.guest_client.Ipv6"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv6</span></code> class specifies the IPv6 settings that need to be applied to a
virtual network adapter. This class was added in vSphere API 7.0.0.0.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv6.Type"title="com.vmware.vcenter.guest_client.Ipv6.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv6.Type</span></code></a>) – The IPv6 configuration type. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>ipv6</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv6Address"title="com.vmware.vcenter.guest_client.Ipv6Address"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv6Address</span></code></a>) – IPv6 address. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.guest_client.Ipv6.Type.STATIC"title="com.vmware.vcenter.guest_client.Ipv6.Type.STATIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Ipv6.Type.STATIC</span></code></a>.</p></li>
<li><p><strong>gateways</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – gateways for the IPv6 address. This attribute was added in vSphere
<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.guest_client.Ipv6.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv6.Type</span></code> class specifies different types of the IPv6
configuration. This enumeration was added in vSphere API 7.0.0.0.</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">DHCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='DHCP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Ipv6.Type.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>DHCP IPv6 configuration. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">STATIC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='STATIC')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Ipv6.Type.STATIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Static IPv6 configuration. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">USER_INPUT_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USER_INPUT_REQUIRED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.Ipv6.Type.USER_INPUT_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the IPv6 settings are not specified in advance. The user
must provide a valid value when the actual customization spec is applied to
a virtual machine. This class attribute was added in vSphere API 7.0.0.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Ipv6Address</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ip_address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</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.guest_client.Ipv6Address"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv6Address</span></code> class specifies the the settings for a Static IPv6
configuration. This class was added in vSphere API 7.0.0.0.</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>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Static IPv6 Address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The CIDR prefix for the interface. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LinuxConfiguration</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">hostname</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">time_zone</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">script_text</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.guest_client.LinuxConfiguration"title="Permalink to this definition">¶</a></dt>
<p>Guest customization Settings to customize a Linux guest operating system.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LinuxConfiguration</span></code> class contains settings that identify a Linux
machine in the same way that the <aclass="reference internal"href="#com.vmware.vcenter.guest_client.WindowsConfiguration"title="com.vmware.vcenter.guest_client.WindowsConfiguration"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WindowsConfiguration</span></code></a> class
identifies a Windows machine.. This class was added in vSphere API 7.0.0.0.</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>hostname</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.HostnameGenerator"title="com.vmware.vcenter.guest_client.HostnameGenerator"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostnameGenerator</span></code></a>) – The network host name of the Linux virtual machine. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The fully qualified domain name. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>time_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>The case-sensitive time zone, such as Europe/Sofia. Valid time zone
values are based on the tz (time zone) database used by Linux. The
values are strings (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) in the form “Area/Location,” in
which Area is a continent or ocean name, and Location is the city,
island, or other regional designation.</p>
<p>See the <aclass="reference external"href="https://kb.vmware.com/kb/2145518">https://kb.vmware.com/kb/2145518</a> for a list of supported
time zones for different versions in Linux.. This attribute was
added in vSphere API 7.0.0.0.
If None, time zone is not modified inside guest operating system.</p>
</p></li>
<li><p><strong>script_text</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>The script to run before and after Linux guest customization.
The max size of the script is 1500 bytes. As long as the script
(shell, perl, python…) has the right “#!” in the header, it is
supported. The caller should not assume any environment variables
when the script is run.</p>
<p>The script is invoked by the customization engine using the command
line: 1) with argument “precustomization” before customization, 2)
with argument “postcustomization” after customization. The script
should parse this argument and implement pre-customization or
post-customization task code details in the corresponding block.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_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.guest_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.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">UserData</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">computer_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">full_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">organization</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">product_key</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.guest_client.UserData"title="Permalink to this definition">¶</a></dt>
<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>computer_name</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.HostnameGenerator"title="com.vmware.vcenter.guest_client.HostnameGenerator"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostnameGenerator</span></code></a>) – The computer name of the (Windows) virtual machine. A computer name
may contain letters (A-Z), numbers(0-9) and hyphens (-) but no
spaces or periods (.). The name may not consist entirely of digits.
A computer name is restricted to 15 characters in length. If the
computer name is longer than 15 characters, it will be truncated to
15 characters. Check <aclass="reference internal"href="#com.vmware.vcenter.guest_client.HostnameGenerator"title="com.vmware.vcenter.guest_client.HostnameGenerator"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostnameGenerator</span></code></a> for various
options. This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>full_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Full name of the end user. Note that this is not the username but
full name specified in “Firstname Lastname” format. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>organization</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the organization that owns the computer. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>product_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The product Key to use for activating Windows guest operating
system. This attribute was added in vSphere API 7.0.0.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">WindowsConfiguration</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">reboot</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sysprep</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sysprep_xml</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.guest_client.WindowsConfiguration"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WindowsConfiguration</span></code> class specifies the settings for customizing a
windows guest operating system. This class was added in vSphere API
7.0.0.0.</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>reboot</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption"title="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WindowsConfiguration.RebootOption</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A value specifying the action that should be taken after
customization. This attribute was added in vSphere API 7.0.0.0.
If None, the <aclass="reference internal"href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.REBOOT"title="com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.REBOOT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">WindowsConfiguration.RebootOption.REBOOT</span></code></a>
option will be chosen.</p></li>
<li><p><strong>sysprep</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.WindowsSysprep"title="com.vmware.vcenter.guest_client.WindowsSysprep"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WindowsSysprep</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Customization settings like user details, administrator details,
etc for the windows guest operating system. Exactly one of
<codeclass="docutils literal notranslate"><spanclass="pre">sysprep</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">sysprepXml</span></code> must be specified. This attribute was
added in vSphere API 7.0.0.0.
If None, sysprep settings will not be applied to the windows guest
operating system.</p></li>
<li><p><strong>sysprep_xml</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – All settings specified in a XML format. This is the content of a
typical answer.xml file that is used by System administrators
Exactly one of <codeclass="docutils literal notranslate"><spanclass="pre">sysprep</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">sysprepXml</span></code> must be specified.
This attribute was added in vSphere API 7.0.0.0.
If None, sysprep settings will not be applied to the windows guest
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RebootOption</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.guest_client.WindowsConfiguration.RebootOption"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WindowsConfiguration.RebootOption</span></code> class specifies what should be
done to the guest after the customization. This enumeration was added in
vSphere API 7.0.0.0.</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">RebootOption</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">NO_REBOOT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RebootOption(string='NO_REBOOT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.NO_REBOOT"title="Permalink to this definition">¶</a></dt>
<dd><p>Take no action. Leave the guest OS running after customization. This option
can be used to look at values for debugging purposes. This class attribute
<codeclass="sig-name descname"><spanclass="pre">REBOOT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RebootOption(string='REBOOT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.REBOOT"title="Permalink to this definition">¶</a></dt>
<dd><p>Reboot the guest after customization. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">SHUTDOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RebootOption(string='SHUTDOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.WindowsConfiguration.RebootOption.SHUTDOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Shutdown the guest after customization. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">WindowsNetworkAdapterSettings</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dns_servers</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">dns_domain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">wins_servers</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">net_bios_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.guest_client.WindowsNetworkAdapterSettings"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WindowsNetworkAdapterSettings</span></code> class specifies Windows specific
Network settings for a virtual network adapter. This class was added in
vSphere API 7.0.0.0.</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>dns_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>A list of server IP addresses to use for DNS lookup in a Windows
guest operating system.</p>
<p>These servers should be specified in the order of preference. If
this list is not empty, and if a DHCP IP address is used, then
these settings override the DHCP settings.. This attribute was
added in vSphere API 7.0.0.0.
If None, no DNS servers are set.</p>
</p></li>
<li><p><strong>dns_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A DNS domain suffix such as vmware.com. This attribute was added in
vSphere API 7.0.0.0.
If None, no DNS domain is set.</p></li>
<li><p><strong>wins_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of WINS Servers to set for the Windows guest operating system.
A Maximum of two IP addresses can be specified in this list. The
first IP address will be set as the primary WINS server. The second
IP address will be set as the secondary WINS server. This attribute
was added in vSphere API 7.0.0.0.
If None, no WINS Servers are set.</p></li>
<li><p><strong>net_bios_mode</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode"title="com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WindowsNetworkAdapterSettings.NetBIOSMode</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – NetBIOS setting for Windows. This attribute was added in vSphere
API 7.0.0.0.
If None, existing NetBIOS mode will be retained.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NetBIOSMode</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.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WindowsNetworkAdapterSettings.NetBIOSMode</span></code> class specifies different
NetBIOS settings for Windows guest operating systems. This enumeration was
added in vSphere API 7.0.0.0.</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">NetBIOSMode</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DISABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetBIOSMode(string='DISABLE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.DISABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>Never use NetBIOS. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">ENABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetBIOSMode(string='ENABLE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.ENABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>Always use NetBIOS. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">USE_DHCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetBIOSMode(string='USE_DHCP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.guest_client.WindowsNetworkAdapterSettings.NetBIOSMode.USE_DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>DHCP server decides whether or not to use NetBIOS. This class attribute was
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.guest_client.</span></code><codeclass="sig-name descname"><spanclass="pre">WindowsSysprep</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">gui_run_once_commands</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">user_data</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">gui_unattended</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.guest_client.WindowsSysprep"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WindowsSysprep</span></code> class provides all the settings like user details,
administrator details, etc that need to applied for a windows guest
operating system during customization. This class was added in vSphere API
7.0.0.0.</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>gui_run_once_commands</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of commands to run at first user logon, after customizing
the guest. These commands are directly mapped to the GuiRunOnce key
in the sysprep.xml answer file. These commands are transferred into
the sysprep.xml file that VirtualCenter stores on the target
virtual disk. For more information about performing unattended
The commands listed here ar executed when a user logs on the first
time after customization completes. The logon may be driven by
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GuiUnattended.auto_logon</span></code> setting. These commands are
directly mapped to the GuiRunOnce key in the. This attribute was
added in vSphere API 7.0.0.0.
If None, no commands are run.</p></li>
<li><p><strong>user_data</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.UserData"title="com.vmware.vcenter.guest_client.UserData"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UserData</span></code></a>) – Personal data pertaining to the owner of the virtual machine. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.Domain"title="com.vmware.vcenter.guest_client.Domain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Domain</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information needed to join a workgroup or domain. This attribute
was added in vSphere API 7.0.0.0.
If None, the guest will not be joined to any workgroup or a domain.</p></li>
<li><p><strong>gui_unattended</strong> (<aclass="reference internal"href="#com.vmware.vcenter.guest_client.GuiUnattended"title="com.vmware.vcenter.guest_client.GuiUnattended"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GuiUnattended</span></code></a>) – Information related to unattended installation. This attribute was
<spanid="com-vmware-vcenter-hvc-client-module"></span><h2>com.vmware.vcenter.hvc_client module<aclass="headerlink"href="#module-com.vmware.vcenter.hvc_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.hvc_client</span></code> module provides classes to manage hybrid
links between a local and remote Platform Service Controller. Usage beyond
VMware Cloud on AWS is not supported.</p>
<dlclass="py class">
<dtid="com.vmware.vcenter.hvc_client.Links">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.hvc_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Links</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.hvc_client.Links"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Links</span></code> class provides methods to create, delete, get information,
and list hybrid links between the local and foreign Platform Service
Controller (PSC). Usage beyond VMware Cloud on AWS is not supported.
<strong>Warning:</strong> This class is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</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">CertificateInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumbprint</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.hvc_client.Links.CertificateInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Links.CertificateInfo</span></code> class contains information about the SSL
certificate for a destination PSC endpoint. <strong>Warning:</strong> This class is
available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</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>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SHA-256 thumbprint of the SSL certificate for the destination
PSC endpoint. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Links.CreateSpec</span></code> class is the specification used for the hybrid
link creation. <strong>Warning:</strong> This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</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>psc_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The PSC hostname for the domain to be linked. <strong>Warning:</strong> This
attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The HTTPS port of the PSC to be linked. <strong>Warning:</strong> This attribute
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.
If None 443 will be used as default.</p></li>
<li><p><strong>domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain to which the PSC belongs. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator username of the PSC. <strong>Warning:</strong> This attribute
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The administrator password of the PSC. <strong>Warning:</strong> This attribute
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ssl thumbprint of the server. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.
if None no thumbprint is passed.</p></li>
<li><p><strong>admin_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of groups to be added to enable administrator access to.
<strong>Warning:</strong> This attribute is available as Technology Preview.
These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback,
VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.
if None administrator access will not be set.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Credentials</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">user_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</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.hvc_client.Links.Credentials"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Links.Credentials</span></code> class specifies user credentials to make a
successful connection to remote endpoint. <strong>Warning:</strong> This class is
available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</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>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the user to authenticate. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password for the user. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">link</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Links.Summary</span></code> class contains information about the hybrid link.
<strong>Warning:</strong> This class is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</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>link</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier for the link. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.hvc.Links</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.hvc.Links</span></code>.</p></li>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name is set to the domain name which was set during
create. <strong>Warning:</strong> This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
<codeclass="sig-name descname"><spanclass="pre">create</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.hvc_client.Links.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new hybrid link between the local and foreign PSC. Usage
beyond VMware Cloud on AWS is not supported. <strong>Warning:</strong> This method
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since
this can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.hvc_client.Links.CreateSpec"title="com.vmware.vcenter.hvc_client.Links.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Links.CreateSpec</span></code></a>) – Specification for the new link to be created.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">link</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes an existing hybrid link. Usage beyond VMware Cloud on AWS is
not supported. <strong>Warning:</strong> This method is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>link</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the hybrid link.
The parameter must be an identifier for the resource type:
if the system reports an error while responding to the request.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtid="com.vmware.vcenter.hvc_client.Links.list">
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc_client.Links.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Enumerates the list of registered hybrid links. Usage beyond VMware
Cloud on AWS is not supported. <strong>Warning:</strong> This method is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility
and recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.hvc_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.hvc_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-identity-client-module"></span><h2>com.vmware.vcenter.identity_client module<aclass="headerlink"href="#module-com.vmware.vcenter.identity_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.identity_client</span></code> module provides classes to manage
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.identity_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Providers</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.identity_client.Providers"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers</span></code> interface provides methods to list, read and modify
vCenter Server identity providers. This class was added in vSphere API
7.0.0.0.</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">ActiveDirectoryOverLdap</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">user_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">users_base_dn</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">groups_base_dn</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">server_endpoints</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cert_chain</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.identity_client.Providers.ActiveDirectoryOverLdap"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.ActiveDirectoryOverLdap</span></code> class contains the information
about to how to use an Active Directory over LDAP connection to allow
searching for users and groups if the identity provider is an On-Prem
service. This class was added in vSphere API 7.0.0.0.</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>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name to connect to the active directory server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Password to connect to the active directory server. This attribute
was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>users_base_dn</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Base distinguished name for users. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>groups_base_dn</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Base distinguished name for groups. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>server_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Active directory server endpoints. At least one active directory
server endpoint must be set. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>cert_chain</strong> (<aclass="reference internal"href="#com.vmware.vcenter.certificate_management_client.X509CertChain"title="com.vmware.vcenter.certificate_management_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SSL certificate chain in base64 encoding. This attribute was added
in vSphere API 7.0.0.0.
This attribute can be None only, if all the active directory server
endpoints use the LDAP (not LDAPS) protocol.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ConfigType</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.identity_client.Providers.ConfigType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code> class contains the possible types of vCenter
Server identity providers. This enumeration was added in vSphere API
7.0.0.0.</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">ConfigType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">Oauth2</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigType(string='Oauth2')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="Permalink to this definition">¶</a></dt>
<dd><p>Config for OAuth2. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">Oidc</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigType(string='Oidc')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="Permalink to this definition">¶</a></dt>
<dd><p>Config for OIDC. This class attribute was added in vSphere API 7.0.0.0.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.CreateSpec</span></code> class contains the information used to create
an identity provider. This class was added in vSphere API 7.0.0.0.</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>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec"title="com.vmware.vcenter.identity_client.Providers.Oauth2CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2CreateSpec</span></code></a>) – OAuth2 CreateSpec. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcCreateSpec"title="com.vmware.vcenter.identity_client.Providers.OidcCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcCreateSpec</span></code></a>) – OIDC CreateSpec. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>org_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The set of orgIds as part of SDDC creation which provides the basis
for tenancy. This attribute was added in vSphere API 7.0.0.0.
If None, the set will be empty.</p></li>
<li><p><strong>is_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies whether the provider is the default provider. Setting
<codeclass="docutils literal notranslate"><spanclass="pre">isDefault</span></code> of current provider to True makes all other providers
non-default. If no other providers created in this vCenter Server
before, this parameter will be disregarded, and the provider will
always be set to the default. This attribute was added in vSphere
API 7.0.0.0.
If None the provider will be the default provider if it is the
first provider that is created, and will not be the default
provider otherwise.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The user friendly name for the provider. This name can be used for
human-readable identification purposes, but it does not have to be
unique, as the system will use internal UUIDs to differentiate
providers. This attribute was added in vSphere API 7.0.0.0.
If None, the name will be the empty string</p></li>
<li><p><strong>domain_names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Set of fully qualified domain names to trust when federating with
this identity provider. Tokens from this identity provider will
only be validated if the user belongs to one of these domains, and
any domain-qualified groups in the tokens will be filtered to
include only those groups that belong to one of these domains. This
attribute was added in vSphere API 7.0.0.0.
If None, domainNames will be the empty set and the domain
validation behavior at login with this identity provider will be as
follows: the user’s domain will be parsed from the User Principal
Name (UPN) value that is found in the tokens returned by the
identity provider. This domain will then be implicitly trusted and
used to filter any groups that are also provided in the tokens.</p></li>
<li><p><strong>auth_query_params</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, the map will be empty.</p>
</p></li>
<li><p><strong>idm_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Communication protocol to the identity management endpoints. This
attribute was added in vSphere API 7.0.0.0.
If None, no communication protocol will be configured for the
identity provider.</p></li>
<li><p><strong>idm_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identity management endpoints. When specified, at least one
endpoint must be provided. This attribute was added in vSphere API
7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">idmProtocol</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.REST</span></code></a>,
<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.SCIM</span></code></a>, or
<li><p><strong>active_directory_over_ldap</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"title="com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ActiveDirectoryOverLdap</span></code></a>) – Identity management configuration. If the protocol is LDAP, the
configuration must be set, else InvalidArgument is thrown. This
attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">idmProtocol</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.LDAP</span></code></a>.</p></li>
<li><p><strong>upn_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies which claim provides the user principal name (UPN) for
the user. This attribute was added in vSphere API 7.0.0.0.
If None, the claim named ‘acct’ will be used to provide backwards
compatibility with CSP.</p></li>
<li><p><strong>groups_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies which claim provides the group membership for the token
subject. These groups will be used for mapping to local groups per
the claim map. This attribute was added in vSphere API 7.0.0.0.
If None, the default behavior will be CSP backwards compatiblility.
The groups for the subject will be comprised of the groups in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">IdmProtocol</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.identity_client.Providers.IdmProtocol"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol</span></code> class contains the possible types of
communication protocols to the identity management endpoints. This
enumeration was added in vSphere API 7.0.0.0.</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">IdmProtocol</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">LDAP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IdmProtocol(string='LDAP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"title="Permalink to this definition">¶</a></dt>
<dd><p>LDAP protocol based identity management endpoints. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">REST</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IdmProtocol(string='REST')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"title="Permalink to this definition">¶</a></dt>
<dd><p>REST protocol based identity management endpoints. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">SCIM</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IdmProtocol(string='SCIM')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"title="Permalink to this definition">¶</a></dt>
<dd><p>SCIM V1.1 protocol based identity management endpoints. This class
<codeclass="sig-name descname"><spanclass="pre">SCIM2_0</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IdmProtocol(string='SCIM2_0')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM2_0"title="Permalink to this definition">¶</a></dt>
<dd><p>SCIM V2.0 protocol based identity management endpoints. This class
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Info</span></code> class contains the information about an identity
provider. This class was added in vSphere API 7.0.0.0.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The user friendly name for the provider. This attribute was added
in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>org_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The set of orgIds as part of SDDC creation which provides the basis
for tenancy. This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2Info"title="com.vmware.vcenter.identity_client.Providers.Oauth2Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2Info</span></code></a>) – OAuth2 Info. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcInfo"title="com.vmware.vcenter.identity_client.Providers.OidcInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcInfo</span></code></a>) – OIDC Info. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>is_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Specifies whether the provider is the default provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain_names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Set of fully qualified domain names to trust when federating with
this identity provider. Tokens from this identity provider will
only be validated if the user belongs to one of these domains, and
any domain-qualified groups in the tokens will be filtered to
include only those groups that belong to one of these domains. If
domainNames is an empty set, domain validation behavior at login
with this identity provider will be as follows: the user’s domain
will be parsed from the User Principal Name (UPN) value that is
found in the tokens returned by the identity provider. This domain
will then be implicitly trusted and used to filter any groups that
are also provided in the tokens. This attribute was added in
vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p>
</p></li>
<li><p><strong>idm_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Communication protocol to the identity management endpoints. This
attribute was added in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>idm_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identity management endpoints. This attribute was added in vSphere
API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">idmProtocol</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.REST</span></code></a>,
<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.SCIM</span></code></a>, or
<li><p><strong>active_directory_over_ldap</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"title="com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ActiveDirectoryOverLdap</span></code></a>) – Identity management configuration. This attribute was added in
vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">idmProtocol</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.LDAP</span></code></a>.</p></li>
<li><p><strong>upn_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Specifies which claim provides the user principal name (UPN) for
the user. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>groups_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Specifies which claim provides the group membership for the token
subject. If empty, the default behavior for CSP is used. In this
case, the groups for the subject will be comprised of the groups in
‘group_names’ and ‘group_ids’ claims. This attribute was added in
vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Oauth2AuthenticationMethod</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.identity_client.Providers.Oauth2AuthenticationMethod"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code> class contains the possible
types of OAuth2 authentication methods. This enumeration was added in
vSphere API 7.0.0.0.</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">Oauth2AuthenticationMethod</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLIENT_SECRET_BASIC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Oauth2AuthenticationMethod(string='CLIENT_SECRET_BASIC')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_BASIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have received a client_secret value from the Authorization
Server, authenticate with the Authorization Server in accordance with
Section 3.2.1 of OAuth 2.0 [RFC6749] using the HTTP Basic authentication
scheme. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">CLIENT_SECRET_JWT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Oauth2AuthenticationMethod(string='CLIENT_SECRET_JWT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_JWT"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have received a client_secret value from the Authorization
Server, create a JWT using an HMAC SHA algorithm, such as HMAC SHA-256. The
HMAC (Hash-based Message Authentication Code) is calculated using the
octets of the UTF-8 representation of the client_secret as the shared key.
This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">CLIENT_SECRET_POST</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Oauth2AuthenticationMethod(string='CLIENT_SECRET_POST')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.CLIENT_SECRET_POST"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have received a client_secret value from the Authorization
Server, authenticate with the Authorization Server in accordance with
Section 3.2.1 of OAuth 2.0 [RFC6749] by including the Client Credentials in
the request body. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">PRIVATE_KEY_JWT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Oauth2AuthenticationMethod(string='PRIVATE_KEY_JWT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod.PRIVATE_KEY_JWT"title="Permalink to this definition">¶</a></dt>
<dd><p>Clients that have registered a public key sign a JWT using that key. The
client authenticates in accordance with JSON Web Token (JWT) Profile for
OAuth 2.0 Client Authentication and Authorization Grants [OAuth.JWT] and
Assertion Framework for OAuth 2.0 Client Authentication and Authorization
Grants [OAuth.Assertions]. This class attribute was added in vSphere API
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2CreateSpec</span></code> class contains the information used to
create an OAuth2 identity provider. This class was added in vSphere API
7.0.0.0.</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>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider public key for validation. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) – Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2Info</span></code> class contains the information about an OAuth2
identity provider. This class was added in vSphere API 7.0.0.0.</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>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider public key for validation. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) – Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Oauth2Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">auth_endpoint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">token_endpoint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">authentication_header</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">auth_query_params</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.identity_client.Providers.Oauth2Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2Summary</span></code> class contains commonly used information
about an OAuth2 identity provider. This class was added in vSphere API
7.0.0.0.</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>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>authentication_header</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The authentication data used as part of request header to acquire
or refresh an OAuth2 token. The data format depends on the
authentication method used. Example of basic authentication format:
Authorization: Basic [base64Encode(clientId + “:” + secret)]. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Oauth2UpdateSpec</span></code> class contains the information used to
update the OAuth2 identity provider. This class was added in vSphere API
7.0.0.0.</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>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Endpoint to retrieve the provider public key for validation. This
attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Shared secret between identity provider and client. This attribute
was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>claim_map</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. This attribute was added in vSphere
API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>auth_query_params</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – key/value pairs that are to be appended to the authEndpoint
request. How to append to authEndpoint request: If the map is not
empty, a “?” is added to the endpoint URL, and combination of each
k and each string in the v is added with an “&” delimiter. Details:
If the value contains only one string, then the key is added with
“k=v”. If the value is an empty list, then the key is added without
a “=v”. If the value contains multiple strings, then the key is
repeated in the query-string for each string in the value. If the
map is empty, deletes all params. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">OidcCreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">discovery_endpoint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_secret</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">claim_map</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.identity_client.Providers.OidcCreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.OidcCreateSpec</span></code> class contains the information used to
create an OIDC identity provider. This class was added in vSphere API
7.0.0.0.</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>discovery_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider metadata. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. This attribute was
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.OidcInfo</span></code> class contains information about an OIDC
identity provider. OIDC is a discovery protocol for OAuth2 configuration
metadata, so <codeclass="docutils literal notranslate"><spanclass="pre">Providers.OidcInfo</span></code> contains additional discovered OAuth2
metadata. This class was added in vSphere API 7.0.0.0.</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>discovery_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider metadata. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>logout_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The endpoint to use for terminating the user’s session at the
identity provider. This value is automatically derived from the
metadata information provided by the OIDC discovery endpoint. This
attribute was added in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>public_key_uri</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider public key for validation. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>claim_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identity provider namespace. It is used to validate the issuer
in the acquired OAuth2 token. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>authentication_method</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"title="com.vmware.vcenter.identity_client.Providers.Oauth2AuthenticationMethod"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2AuthenticationMethod</span></code></a>) – Authentication method used by the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.OidcSummary</span></code> class contains commonly used information
about an OIDC identity provider. OIDC is a discovery protocol for OAuth2
configuration metadata, so <codeclass="docutils literal notranslate"><spanclass="pre">Providers.OidcSummary</span></code> contains discovered
OAuth2 metadata. This class was added in vSphere API 7.0.0.0.</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>discovery_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Endpoint to retrieve the provider metadata. This attribute was
added in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>logout_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The endpoint to use for terminating the user’s session at the
identity provider. This value is automatically derived from the
metadata information provided by the OIDC discovery endpoint. This
attribute was added in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>auth_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Authentication/authorization endpoint of the provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>token_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Token endpoint of the provider. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>authentication_header</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The authentication data used as part of request header to acquire
or refresh an OAuth2 token. The data format depends on the
authentication method used. Example of basic authentication format:
Authorization: Basic [base64Encode(clientId + “:” + secret)]. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">OidcUpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">discovery_endpoint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_secret</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">claim_map</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.identity_client.Providers.OidcUpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.OidcUpdateSpec</span></code> class contains the information used to
update the OIDC identity provider. This class was added in vSphere API
7.0.0.0.</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>discovery_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Endpoint to retrieve the provider metadata. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client identifier to connect to the provider. This attribute was
added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>client_secret</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The secret shared between the client and the provider. This
attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>claim_map</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>)) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The map used to transform an OAuth2 claim to a corresponding claim
that vCenter Server understands. Currently only the key “perms” is
supported. The key “perms” is used for mapping the “perms” claim of
incoming JWT. The value is another map with an external group as
the key and a vCenter Server group as value. This attribute was
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Summary</span></code> class contains commonly used information about an
identity provider. This class was added in vSphere API 7.0.0.0.</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>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the provider. This attribute was added in vSphere
API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.identity.Providers</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The user friendly name for the provider. This attribute was added
in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2Summary"title="com.vmware.vcenter.identity_client.Providers.Oauth2Summary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2Summary</span></code></a>) – OAuth2 Summary. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcSummary"title="com.vmware.vcenter.identity_client.Providers.OidcSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcSummary</span></code></a>) – OIDC Summary. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>is_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Specifies whether the provider is the default provider. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>domain_names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Set of fully qualified domain names to trust when federating with
this identity provider. Tokens from this identity provider will
only be validated if the user belongs to one of these domains, and
any domain-qualified groups in the tokens will be filtered to
include only those groups that belong to one of these domains. If
domainNames is an empty set, domain validation behavior at login
with this identity provider will be as follows: the user’s domain
will be parsed from the User Principal Name (UPN) value that is
found in the tokens returned by the identity provider. This domain
will then be implicitly trusted and used to filter any groups that
are also provided in the tokens. This attribute was added in
vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>auth_query_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>key/value pairs that are to be appended to the authEndpoint
request.</p>
<p>How to append to authEndpoint request: If the map is not empty, a
“?” is added to the endpoint URL, and combination of each k and
each string in the v is added with an “&” delimiter. Details:</p>
<ul>
<li><p>If the value contains only one string, then the key is added with
“k=v”.</p></li>
<li><p>If the value is an empty list, then the key is added without a
“=v”.</p></li>
<li><p>If the value contains multiple strings, then the key is repeated
in the query-string for each string in the value.</p></li>
</ul>
<p>. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional because it was added in a newer version
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec</span></code> class contains the information used to update
the identity provider. This class was added in vSphere API 7.0.0.0.</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>config_tag</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType"title="com.vmware.vcenter.identity_client.Providers.ConfigType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ConfigType</span></code></a>) – The config type of the identity provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>oauth2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec"title="com.vmware.vcenter.identity_client.Providers.Oauth2UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Oauth2UpdateSpec</span></code></a>) – OAuth2 UpdateSpec. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oauth2"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oauth2</span></code></a>.</p></li>
<li><p><strong>oidc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec"title="com.vmware.vcenter.identity_client.Providers.OidcUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.OidcUpdateSpec</span></code></a>) – OIDC UpdateSpec. This attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">configTag</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"title="com.vmware.vcenter.identity_client.Providers.ConfigType.Oidc"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.ConfigType.Oidc</span></code></a>.</p></li>
<li><p><strong>org_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The set orgIds as part of SDDC creation which provides the basis
for tenancy. This attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>make_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies whether to make this the default provider. If
<codeclass="docutils literal notranslate"><spanclass="pre">makeDefault</span></code> is set to true, this provider will be flagged as
the default provider and any other providers that had previously
been flagged as the default will be made non-default. If
<codeclass="docutils literal notranslate"><spanclass="pre">makeDefault</span></code> is set to false, this provider’s default flag will
not be modified. This attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The user friendly name for the provider. This name can be used for
human-readable identification purposes, but it does not have to be
unique, as the system will use internal UUIDs to differentiate
providers. This attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>domain_names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Set of fully qualified domain names to trust when federating with
this identity provider. Tokens from this identity provider will
only be validated if the user belongs to one of these domains, and
any domain-qualified groups in the tokens will be filtered to
include only those groups that belong to one of these domains. This
attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged. If domainNames is an empty set,
domain validation behavior at login with this identity provider
will be as follows: the user’s domain will be parsed from the User
Principal Name (UPN) value that is found in the tokens returned by
the identity provider. This domain will then be implicitly trusted
and used to filter any groups that are also provided in the tokens.</p></li>
<li><p><strong>auth_query_params</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – key/value pairs that are to be appended to the authEndpoint
request. How to append to authEndpoint request: If the map is not
empty, a “?” is added to the endpoint URL, and combination of each
k and each string in the v is added with an “&” delimiter. Details:
If the value contains only one string, then the key is added with
“k=v”. If the value is an empty list, then the key is added without
a “=v”. If the value contains multiple strings, then the key is
repeated in the query-string for each string in the value. If the
map is empty, deletes all params. This attribute was added in
vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>idm_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The protocol to communicate to the identity management endpoints.
This attribute was added in vSphere API 7.0.0.0.
If None, leave value unchanged.</p></li>
<li><p><strong>idm_endpoints</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identity management endpoints. When specified, at least one
endpoint must be provided. This attribute was added in vSphere API
7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">idmProtocol</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.REST"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.REST</span></code></a>,
<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.SCIM"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.SCIM</span></code></a>, or
<li><p><strong>active_directory_over_ldap</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"title="com.vmware.vcenter.identity_client.Providers.ActiveDirectoryOverLdap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ActiveDirectoryOverLdap</span></code></a>) – Identity management configuration. If the protocol is LDAP, the
configuration must be set, else InvalidArgument is thrown. This
attribute was added in vSphere API 7.0.0.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">idmProtocol</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"title="com.vmware.vcenter.identity_client.Providers.IdmProtocol.LDAP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.IdmProtocol.LDAP</span></code></a>.</p></li>
<li><p><strong>upn_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies which claim provides the user principal name (UPN) for
the subject of the token. This attribute was added in vSphere API
7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>reset_upn_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether the user principal name (UPN) claim should
be set back to its default value. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>,
the user principal name (UPN) claim will be set to ‘acct’, which is
used for backwards compatibility with CSP. If this field is set to
<codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing user principal name (UPN) claim will be
changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec.upn_claim</span></code>, if any. This attribute was
added in vSphere API 7.0.0.0.
If None, the existing user principal name (UPN) claim will be
changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec.upn_claim</span></code>, if any.</p></li>
<li><p><strong>groups_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies which claim provides the group membership for the token
subject. This attribute was added in vSphere API 7.0.0.0.
If None, leaves value unchanged.</p></li>
<li><p><strong>reset_groups_claim</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether any existing groups claim value should be
removed. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing groups
claim value is removed which defaults to backwards compatibility
with CSP. In this case, the groups for the subject will be
comprised of the groups in ‘group_names’ and ‘group_ids’ claims. If
this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing groups claim will be
changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec.groups_claim</span></code>, if any. This attribute
was added in vSphere API 7.0.0.0.
If None, the existing groups claim will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec.groups_claim</span></code>, if any.</p></li>
<codeclass="sig-name descname"><spanclass="pre">create</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.identity_client.Providers.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a vCenter Server identity provider. This method was added in
vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.CreateSpec"title="com.vmware.vcenter.identity_client.Providers.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.CreateSpec</span></code></a>) – the CreateSpec contains the information used to create the provider</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">provider</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a vCenter Server identity provider. This method was added in
vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the identifier of the provider to delete
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">provider</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve detailed information of the specified identity provider. This
method was added in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the identifier of the provider
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve all identity providers. This method was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">provider</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.identity_client.Providers.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Update a vCenter Server identity provider. This method was added in
vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the identifier of the provider to update
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.identity_client.Providers.UpdateSpec"title="com.vmware.vcenter.identity_client.Providers.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec</span></code></a>) – the UpdateSpec contains the information used to update the provider</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.identity_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.identity_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-inventory-client-module"></span><h2>com.vmware.vcenter.inventory_client module<aclass="headerlink"href="#module-com.vmware.vcenter.inventory_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.inventory_client</span></code> component provides methods and
classes for retrieving vCenter datastore and network information for a given
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of identifiers.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.inventory_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Datastore</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.inventory_client.Datastore"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code> class provides methods to retrieve information about
datastores.</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">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.inventory_client.Datastore.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Datastore.Info</span></code> class contains information about a datastore.</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>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the datastore.
When clients pass a value of this class as a parameter, the
attribute must be one of <codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">StoragePod</span></code>. When
methods return a value of this class as a return value, the
attribute will be one of <codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">StoragePod</span></code>.</p>
<codeclass="sig-name descname"><spanclass="pre">find</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastores</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Datastore.find"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns datastore information for the specified datastores. The key in
the return value <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the datastore identifier and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the datastore information.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>datastores</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the datastores for which information will be
returned.
The parameter must contain identifiers for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.inventory_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Network</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.inventory_client.Network"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code> class provides methods to retrieve information about
vCenter Server networks.</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">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.inventory_client.Network.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Network.Info</span></code> class contains information about a vCenter Server
network.</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>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the vCenter Server network.
When clients pass a value of this class as a parameter, the
attribute must be one of <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">DistributedVirtualPortgroup</span></code>, or <codeclass="docutils literal notranslate"><spanclass="pre">OpaqueNetwork</span></code>. When methods
return a value of this class as a return value, the attribute will
be one of <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">DistributedVirtualPortgroup</span></code>, or
<codeclass="sig-name descname"><spanclass="pre">find</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">networks</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.inventory_client.Network.find"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns network information for the specified vCenter Server networks.
The key in the return value <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the network identifier and
the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the network information.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the vCenter Server networks for which information
will be returned.
The parameter must contain identifiers for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.inventory_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.inventory_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-iso-client-module"></span><h2>com.vmware.vcenter.iso_client module<aclass="headerlink"href="#module-com.vmware.vcenter.iso_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.iso_client</span></code> module provides classes and classes that
will let its client mount or unmount an ISO image on a virtual machine as a
CD-ROM.</p>
<dlclass="py class">
<dtid="com.vmware.vcenter.iso_client.Image">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.iso_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Image</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.iso_client.Image"title="Permalink to this definition">¶</a></dt>
<p>Provides an interface to mount and unmount an ISO image on a virtual
machine.</p>
<p>This is an API that will let its client mount or unmount an ISO image on a
virtual machine as a CD-ROM.</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>
<codeclass="sig-name descname"><spanclass="pre">mount</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">library_item</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.iso_client.Image.mount"title="Permalink to this definition">¶</a></dt>
<dd><p>Mounts an ISO image from a content library on a virtual machine.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>library_item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the library item having the ISO image to mount on
the virtual machine.
The parameter must be an identifier for the resource type:
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual machine where the specified ISO image
will be mounted.
The parameter must be an identifier for the resource type:
If either <codeclass="docutils literal notranslate"><spanclass="pre">vm</span></code> or the <codeclass="docutils literal notranslate"><spanclass="pre">library_item</span></code> is not found.</p>
<codeclass="sig-name descname"><spanclass="pre">unmount</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cdrom</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.iso_client.Image.unmount"title="Permalink to this definition">¶</a></dt>
<dd><p>Unmounts a previously mounted CD-ROM using an ISO image as a backing.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual machine from which to unmount the
virtual CD-ROM.
The parameter must be an identifier for the resource type:
<li><p><strong>cdrom</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The device identifier of the CD-ROM.
The parameter must be an identifier for the resource type:
by the parameter <codeclass="docutils literal notranslate"><spanclass="pre">cdrom</span></code> requires <codeclass="docutils literal notranslate"><spanclass="pre">System.Read</span></code>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.iso_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.iso_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-lcm-client-module"></span><h2>com.vmware.vcenter.lcm_client module<aclass="headerlink"href="#module-com.vmware.vcenter.lcm_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.lcm_client</span></code> module provides classes for managing the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notification</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resolution</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.lcm_client.Notification"title="Permalink to this definition">¶</a></dt>
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The time the notification was raised/found.
Only if the time information is available.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notifications</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <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.lcm_client.Notifications"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Notifications</span></code> class contains info/warning/error messages that can
be reported be the appliance task.</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>info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Notification"title="com.vmware.vcenter.lcm_client.Notification"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Info notification messages reported.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an info was reported by the appliance task.</p></li>
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an warning was reported by the appliance task.</p></li>
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an error was reported by the appliance task.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.lcm_client.Reports">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Reports</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.lcm_client.Reports"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Report</span></code> class provides an method to download the report generated by
the interop and precheck operations. To download a report, you must use the
<codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> method. A <codeclass="docutils literal notranslate"><spanclass="pre">Report.Location</span></code> class represents the location of the
file which has <codeclass="docutils literal notranslate"><spanclass="pre">Report.Token</span></code> class which represents the token ID
(\@name String) and the expiration time of the token
<codeclass="docutils literal notranslate"><spanclass="pre">Report.Token.expiry</span></code> DateTime. <codeclass="docutils literal notranslate"><spanclass="pre">Report.Location</span></code> class also has the
URI for the file which needs to be downloaded.</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">Location</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">uri</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">download_file_token</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.lcm_client.Reports.Location"title="Permalink to this definition">¶</a></dt>
<li><p><strong>download_file_token</strong> (<aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Reports.Token"title="com.vmware.vcenter.lcm_client.Reports.Token"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Reports.Token</span></code></a>) – Information about the token required in the HTTP GET request to
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Token</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">expiry</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.lcm_client.Reports.Token"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Reports.Token</span></code> class contains information about the token required
in the HTTP GET request to generate the report.</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>token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A one-time, short-lived token required in the HTTP header of the
request to the url. This token needs to be passed in as a header
with the name “session-id”.</p></li>
<li><p><strong>expiry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Expiry time of the token</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">report</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.lcm_client.Reports.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the location <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Reports.Location"title="com.vmware.vcenter.lcm_client.Reports.Location"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Reports.Location</span></code></a> information for
downloading the report for the specified file name.</p>
<blockquote>
<div><p>Retrieving a report involves two steps:</p>
</div></blockquote>
<ulclass="simple">
<li><p>Step 1: Invoke the <aclass="reference internal"href="#com.vmware.vcenter.lcm_client.Reports.get"title="com.vmware.vcenter.lcm_client.Reports.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Reports.get()</span></code></a> method to provision a token
and a URI.</p></li>
<li><p>Step 2: Make an HTTP GET request by using the URI and the token
returned in step 1 to retrieve the report.</p></li>
</ul>
<blockquote>
<div><p>The HTTP GET request will:</p>
</div></blockquote>
<ulclass="simple">
<li><p>Return 401 (Not Authorized) if the download URI is recognized, but
the token is invalid, 404 if the URL is not recognized otherwise return
200 (OK)</p></li>
<li><p>Provide the CSV contents as the output of the request. The API
accepts the file name as input, reads the contents of that CSV file,
and returns this text as the result of the API.</p></li>
</ul>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>report</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.lcm_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.lcm_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-namespace-management-client-module"></span><h2>com.vmware.vcenter.namespace_management_client module<aclass="headerlink"href="#module-com.vmware.vcenter.namespace_management_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ClusterAvailableVersions</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions"title="Permalink to this definition">¶</a></dt>
<p>The {\@name cluster-available-versions} class provides methods to
retrieve available upgrade versions of WCP and detailed information about
each upgrade.</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">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">release_date</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">release_notes</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ClusterAvailableVersions.Summary</span></code> class contains the information
about each available upgrade version.</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>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the upgrade.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the upgrade.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the upgrade.</p></li>
<li><p><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Release date of the upgrade.</p></li>
<li><p><strong>release_notes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Release details of the upgrade.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterAvailableVersions.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about each available upgrade.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ClusterCompatibility</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ClusterCompatibility</span></code> class provides methods to get
Namespace-related compatibility information for clusters in this vCenter.</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">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">compatible</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_provider</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ClusterCompatibility.FilterSpec</span></code> class contains attributes used to
filter the results when listing clusters (see
<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list"title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ClusterCompatibility.list()</span></code></a>) and their compatibility information.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Compatibility criteria for matching the filter. If true, only
clusters which are compatible for Namespaces match the filter. If
false, all clusters match the filter.
If None, both compatible and incompatible clusters match the
filter.</p></li>
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The network provider whose networks will be considered. If unset,
this will default to NSXT_CONTAINER_PLUGIN. This attribute was
added in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">compatible</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">incompatibility_reasons</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.Summary"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns Namespaces compatibility information for all clusters in
vCenter matching the <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ClusterCompatibility.FilterSpec</span></code></a>. The
result contains only visible (subject to permission checks) clusters.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ClusterCompatibility.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching clusters for which information should be
returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.ClusterCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ClusterCompatibility.FilterSpec</span></code></a> with all attributes None
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ClusterSizeInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo"title="Permalink to this definition">¶</a></dt>
<p>The {\@name cluster-size-info} class provides methods to retrieve
various sizes available for enabling Namespaces and information about each
size.</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">num_supported_pods</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">num_supported_services</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_service_cidr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_pod_cidr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">master_vm_info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">worker_vm_info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ClusterSizeInfo.Info</span></code> class contains the information about limits
associated with a <codeclass="docutils literal notranslate"><spanclass="pre">SizingHint</span></code>.</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>num_supported_pods</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The maximum number of supported pods.</p></li>
<li><p><strong>num_supported_services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The maximum number of supported services.</p></li>
<li><p><strong>default_service_cidr</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – Default CIDR range from which Kubernetes allocates service cluster
IP addresses.</p></li>
<li><p><strong>default_pod_cidr</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – Default CIDR range from which Kubernetes allocates pod IP
addresses.</p></li>
<li><p><strong>master_vm_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo"title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ClusterSizeInfo.VmInfo</span></code></a>) – Information about Kubernetes API server virtual machine
configuration.</p></li>
<li><p><strong>worker_vm_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo"title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ClusterSizeInfo.VmInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about worker virtual machine configuration.
If None, the configuration of the worker VM is not fixed.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VmInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cores_per_socket</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.VmInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ClusterSizeInfo.VmInfo</span></code> class contains the information about the
configuration of the virtual machines which would be created for
Namespaces.</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>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores.</p></li>
<li><p><strong>cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores per socket.</p></li>
<li><p><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall capacity of the disks in the virtual machine, in mebibytes.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about the default values associated with various sizes.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Clusters</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters</span></code> class provides methods to enable and disable vSphere
Namespaces on a vSphere cluster.</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">ConfigStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.ConfigStatus</span></code> class describes the status of reaching the
desired state configuration for the cluster.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConfigStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CONFIGURING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='CONFIGURING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.CONFIGURING"title="Permalink to this definition">¶</a></dt>
<dd><p>The Namespace configuration is being applied to the cluster.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Failed to apply the Namespace configuration to the cluster, user
<codeclass="sig-name descname"><spanclass="pre">REMOVING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='REMOVING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.REMOVING"title="Permalink to this definition">¶</a></dt>
<dd><p>The Namespace configuration is being removed from the cluster.</p>
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The cluster is configured correctly with the Namespace configuration.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.EnableSpec</span></code> class contains the specification required to
enable vSphere Namespaces on a cluster.</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>size_hint</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.SizingHint"title="com.vmware.vcenter.namespace_management_client.SizingHint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SizingHint</span></code></a>) – This affects the size and resources allocated to the Kubernetes API
server and the worker nodes. It also affects the suggested default
serviceCidr and podCidrs.</p></li>
<li><p><strong>service_cidr</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR block from which Kubernetes allocates service cluster IP
addresses. This range should not overlap with those in
or other services running in the datacenter.</p></li>
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a>) – The provider of cluster networking for this vSphere Namespaces
cluster.</p></li>
<li><p><strong>ncp_cluster_network_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkEnableSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkEnableSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkEnableSpec</span></code></a>) – Specification for the NSX Container Plugin cluster network.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<li><p><strong>workload_networks_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksEnableSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksEnableSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.WorkloadNetworksEnableSpec</span></code></a>) – Specification for the workload networks to be associated with the
cluster. This attribute was added in vSphere API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<li><p><strong>workload_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of NTP server DNS names or IP addresses to use for workloads
such as Tanzu Kubernetes Grid VMs, specified in order of
preference. This attribute was added in vSphere API 7.0.1.0.
If None, NTP server for Kubernetes API servers will be used.</p></li>
<li><p><strong>load_balancer_config_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.ConfigSpec"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.ConfigSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.ConfigSpec</span></code></a>) – A LoadBalancer dictates configuration derived from a
user-provisioned load balancer that will be used to operate a load
balancer that fronts vSphere Namespaces cluster servers, Tanzu
Kubernetes Grid API servers, and other servers upon request. This
configuration is required for network providers that do not have a
default load balancer included. This attribute was added in vSphere
API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<li><p><strong>master_management_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkSpec</span></code></a>) – Specification for the management network on Kubernetes API server.
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NetworkSpec.mode</span></code> must be STATICRANGE as we require
Kubernetes API server to have a stable address.</p></li>
<li><p><strong>master_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use on Kubernetes API server,
specified in order of preference.
If None, no default DNS servers are set.</p></li>
<li><p><strong>worker_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use on the worker nodes,
specified in order of preference.
If None, no default DNS servers are set.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of domains (for example “vmware.com”) to be searched when
trying to lookup a host name on Kubernetes API server, specified in
order of preference.
If None, no default DNS search domains are set.</p></li>
<li><p><strong>master_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of NTP server DNS names or IP addresses to use on Kubernetes
API server, specified in order of preference.
If None, VMware Tools based time synchronization is enabled.</p></li>
<li><p><strong>master_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of storage policy associated with Kubernetes API server.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
<li><p><strong>ephemeral_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of storage policy associated with ephemeral disks of all
the Kubernetes Pods in the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
<li><p><strong>login_banner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Disclaimer to be displayed prior to login via the Kubectl plugin.
If None, just skip it.</p></li>
<li><p><strong>master_dns_names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of additional DNS names to associate with the Kubernetes API
server. These DNS names are embedded in the TLS certificate
presented by the API server.
If None, no additional DNS names are embedded in the TLS
certificate.</p></li>
<li><p><strong>image_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageStorageSpec</span></code></a>) – Specification for storage to be used for container images.</p></li>
<li><p><strong>default_image_registry</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageRegistry</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image registry to use when Kubernetes Pod container
specification does not specify it as part of the container image
name.
If None, defaults to Docker Hub.</p></li>
<li><p><strong>default_image_repository</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image repository to use when Kubernetes Pod container
specification does not specify it as part of the container image
name.
If None, defaults to Docker Hub official repository in case of
Docker Hub image registry, otherwise defaults to empty string.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMware’s hosted vSphere Kubernetes Service
Repository.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
If None, the Content Library identifier will not be set.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ImageRegistry</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">hostname</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.ImageRegistry</span></code> class contains the specification required to
configure container image registry endpoint.</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>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address or the hostname of container image registry.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Port number of the container image registry.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ImageStorageSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Info</span></code> class contains detailed information about the cluster
statistics and status related to vSphere Namespaces.</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>size_hint</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.SizingHint"title="com.vmware.vcenter.namespace_management_client.SizingHint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SizingHint</span></code></a>) – Current setting for <codeclass="docutils literal notranslate"><spanclass="pre">SizingHint</span></code>. This affects the size and
resources allocated to the Kubernetes API server. This attribute
was added in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>stat_summary</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.Stats"title="com.vmware.vcenter.namespace_management_client.Clusters.Stats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Stats</span></code></a>) – Basic runtime statistics for the cluster.</p></li>
<li><p><strong>config_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus"title="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ConfigStatus</span></code></a>) – Current setting for <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.ConfigStatus</span></code>.</p></li>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message"title="com.vmware.vcenter.namespace_management_client.Clusters.Message"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the object.</p></li>
<li><p><strong>kubernetes_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus"title="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.KubernetesStatus</span></code></a>) – Current setting for <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.KubernetesStatus</span></code>.</p></li>
<li><p><strong>kubernetes_status_messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message"title="com.vmware.vcenter.namespace_management_client.Clusters.Message"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the object.</p></li>
<li><p><strong>api_server_management_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Kubernetes API Server IP address on the management network. This is
a floating IP and assigned to one of the control plane VMs on the
management network. This endpoint is used by vSphere components.</p></li>
<li><p><strong>api_server_cluster_endpoint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Kubernetes API Server IP address via cluster network. This is the
IP address of the Kubernetes LoadBalancer type service fronting the
apiservers. This endpoint is the one configured in kubeconfig after
login, and used for most human and application interaction with
Kubernetes.</p></li>
<li><p><strong>api_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the Kubernetes API servers. These are the IP
addresses of the VM instances for the Kubernetes control plane on
the management network.</p></li>
<li><p><strong>tls_management_endpoint_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API
servers when accessed from the management network, e.g. from ESX
servers or VCSA. This certificate is only valid for use with the
apiServerManagementEndpoint.</p></li>
<li><p><strong>tls_endpoint_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API
servers when accessed via the load balancer, e.g. devops user on
corporate network. This certificate is only valid for use with the
apiServerClusterEndpoint.</p></li>
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a>) – The provider of cluster networking for this vSphere Namespaces
cluster.</p></li>
<li><p><strong>ncp_cluster_network_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkInfo"title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkInfo</span></code></a>) – Specification for the NSX Container Plugin cluster network.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<li><p><strong>workload_networks</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksInfo"title="com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.WorkloadNetworksInfo</span></code></a>) – Information about workload networks associated with the cluster.
This attribute was added in vSphere API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<li><p><strong>workload_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about NTP server DNS names or IP addresses to use for
workloads such as Tanzu Kubernetes Grid VMs, specified in order of
preference. This attribute was added in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>load_balancers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Info</span></code></a>) – Information related to the Load balancer used for provisioning
virtual servers in the namespace. This attribute was added in
vSphere API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<li><p><strong>service_cidr</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR block from which Kubernetes allocates service cluster IP
addresses.</p></li>
<li><p><strong>master_management_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkSpec</span></code></a>) – Specification for the management network on Kubernetes API server.
This attribute was added in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>master_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use on Kubernetes API server,
specified in order of preference.</p></li>
<li><p><strong>worker_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use for pods that execute on the
worker nodes (which are native pods on ESXi hosts in the vSphere
Namespaces Supervisor).</p></li>
<li><p><strong>master_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of storage policy associated with Kubernetes API server.
This attribute was added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>ephemeral_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of storage policy associated with ephemeral disks of all
the Kubernetes Pods in the cluster. This attribute was added in
vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>login_banner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Disclaimer to be displayed prior to login via the Kubectl plugin.
This attribute was added in vSphere API 7.0.1.0.
If None, just skip it.</p></li>
<li><p><strong>master_dns_names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of additional DNS names to associate with the Kubernetes API
server. These DNS names are embedded in the TLS certificate
presented by the API server. This attribute was added in vSphere
API 7.0.1.0.
If None, no additional DNS names are embedded in the TLS
certificate.</p></li>
<li><p><strong>image_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageStorageSpec</span></code></a>) – Specification for storage to be used for container images. This
attribute was added in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>default_image_registry</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageRegistry</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image registry to use when Kubernetes Pod container
specification does not specify it as part of the container image
name. This attribute was added in vSphere API 7.0.1.0.
If None, defaults to Docker Hub.</p></li>
<li><p><strong>default_image_repository</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image repository to use when Kubernetes Pod container
specification does not specify it as part of the container image
name. This attribute was added in vSphere API 7.0.1.0.
If None, defaults to Docker Hub official repository in case of
Docker Hub image registry, otherwise defaults to empty string.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of domains (for example “vmware.com”) to be searched when
trying to lookup a host name on Kubernetes API server, specified in
order of preference.</p></li>
<li><p><strong>master_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of NTP server DNS names or IP addresses to use on Kubernetes
API server, specified in order of preference. This attribute was
added in vSphere API 7.0.1.0.
If None, VMware Tools based time synchronization is enabled.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMware’s hosted vSphere Kubernetes Service
Repository.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Ipv4Range</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">starting_address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subnet_mask</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">gateway</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Ipv4Range"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Ipv4Range</span></code> contains specification to configure multiple
interfaces in IPv4. The range of IPv4 addresses is derived by incrementing
the startingAddress to the specified addressCount. To use the object for a
single IPv4 address specification, set addressCount to 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>starting_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IPv4 address denoting the start of the range.</p></li>
<li><p><strong>address_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The number of IP addresses in the range. Addresses are derived by
<li><p><strong>subnet_mask</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Subnet mask to be set.</p></li>
<li><p><strong>gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IPv4 address of the gateway associated with the range indicated
by <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.Ipv4Range.starting_address</span></code> and
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">KubernetesStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.KubernetesStatus</span></code> class describes the cluster’s ability to
deploy pods.</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">KubernetesStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">KubernetesStatus(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>The cluster may not be able to accept pods and has error messages.</p>
<codeclass="sig-name descname"><spanclass="pre">READY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">KubernetesStatus(string='READY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.READY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">KubernetesStatus(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The cluster may be able to accept pods, but has warning messages.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Message</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">severity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Message</span></code> class contains the information about the object
configuration.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity"title="com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Message.Severity</span></code></a>) – Type of the message.</p></li>
<li><p><strong>details</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details about the message.
If None, message details are not required for taking actions.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Severity</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Message.Severity</span></code> class represents the severity of the
message.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Severity</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Severity(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm.</p>
<codeclass="sig-name descname"><spanclass="pre">INFO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Severity(string='INFO')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.INFO"title="Permalink to this definition">¶</a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event.</p>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Severity(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Message.Severity.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NCPClusterNetworkEnableSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pod_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ingress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">egress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster_distributed_switch</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nsx_edge_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkEnableSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkEnableSpec</span></code> class encapsulates the NSX
Container Plugin-specific cluster networking configuration parameters for
the vSphere Namespaces Cluster Enable operation.</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>pod_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR blocks from which Kubernetes allocates pod IP addresses. This
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkEnableSpec.egress_cidrs</span></code>, or other
services running in the datacenter.</p></li>
<li><p><strong>egress_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR blocks from which NSX assigns IP addresses used for performing
SNAT from container IPs to external IPs. These ranges should not
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkEnableSpec.ingress_cidrs</span></code>, or
other services running in the datacenter.</p></li>
<li><p><strong>cluster_distributed_switch</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere Distributed Switch used to connect this cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">vSphereDistributedSwitch</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">vSphereDistributedSwitch</span></code>.
This field is required when configuring a cluster that uses NSX-T.
If None and using NSXe, the system will choose a suitable vSphere
Distributed Switch.</p></li>
<li><p><strong>nsx_edge_cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – NSX Edge Cluster to be used for Kubernetes Services of type
LoadBalancer, Kubernetes Ingresses, and NSX SNAT.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">NSXEdgeCluster</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NCPClusterNetworkInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pod_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ingress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">egress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster_distributed_switch</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">nsx_edge_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_ingress_tls_certificate</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkInfo"title="Permalink to this definition">¶</a></dt>
<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>pod_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR blocks from which Kubernetes allocates pod IP addresses.</p></li>
<li><p><strong>ingress_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR blocks from which NSX assigns IP addresses for Kubernetes
Ingresses and Kubernetes Services of type LoadBalancer.</p></li>
<li><p><strong>egress_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR blocks from which NSX assigns IP addresses used for performing
SNAT from container IPs to external IPs.</p></li>
<li><p><strong>cluster_distributed_switch</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – vSphere Distributed Switch used to connect this cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">vSphereDistributedSwitch</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">vSphereDistributedSwitch</span></code>.</p></li>
<li><p><strong>nsx_edge_cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – NSX Edge Cluster to be used for Kubernetes Services of type
LoadBalancer, Kubernetes Ingresses, and NSX SNAT.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">NSXEdgeCluster</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>default_ingress_tls_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – PEM-encoded x509 certificate used by NSX as a default fallback
certificate for Kubernetes Ingress services.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NCPClusterNetworkSetSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pod_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ingress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">egress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_ingress_tls_certificate</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkSetSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkSetSpec</span></code> class encapsulates the NSX
Container Plugin-specific cluster networking configuration parameters for
the vSphere Namespaces Cluster Set operation.</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>pod_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR blocks from which Kubernetes allocates pod IP addresses. This
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkSetSpec.egress_cidrs</span></code>, or other
services running in the datacenter. A set operation only allows for
addition of new CIDR blocks to the existing list.</p></li>
<li><p><strong>egress_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a>) – CIDR blocks from which NSX assigns IP addresses used for performing
SNAT from container IPs to external IPs. These ranges should not
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkSetSpec.ingress_cidrs</span></code>, or other
services running in the datacenter. A set operation only allows for
addition of new CIDR blocks to the existing list.</p></li>
<li><p><strong>default_ingress_tls_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – PEM-encoded x509 certificate used by NSX as a default fallback
certificate for Kubernetes Ingress services.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NCPClusterNetworkUpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pod_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ingress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">egress_cidrs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_ingress_tls_certificate</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkUpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkUpdateSpec</span></code> class encapsulates the NSX
Container Plugin-specific cluster networking configuration parameters for
the vSphere Namespaces Cluster Update operation.</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>pod_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – CIDR blocks from which Kubernetes allocates pod IP addresses. This
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkUpdateSpec.egress_cidrs</span></code>, or other
services running in the datacenter. An update operation only allows
for addition of new CIDR blocks to the existing list. All Pod CIDR
blocks must be of at least subnet size /23.
If None, CIDRs from which Kubernetes allocates pod IP addresses
will not be modified.</p></li>
<li><p><strong>ingress_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – CIDR blocks from which NSX assigns IP addresses for Kubernetes
Ingresses and Kubernetes Services of type LoadBalancer. These
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkUpdateSpec.egress_cidrs</span></code>, or other
services running in the datacenter. An update operation only allows
for addition of new CIDR blocks to the existing list.
If None, CIDRs from which Kubernetes allocates ingress IP addresses
will not be modified.</p></li>
<li><p><strong>egress_cidrs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="com.vmware.vcenter.namespace_management_client.Ipv4Cidr"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Cidr</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – CIDR blocks from which NSX assigns IP addresses used for performing
SNAT from container IPs to external IPs. These ranges should not
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkUpdateSpec.ingress_cidrs</span></code>, or
other services running in the datacenter. An update operation only
allows for addition of new CIDR blocks to the existing list.
If None, CIDR from which Kubernetes allocates egress IP addresses
will not be modified.</p></li>
<li><p><strong>default_ingress_tls_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – PEM-encoded x509 certificate used by NSX as a default fallback
certificate for Kubernetes Ingress services.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NetworkProvider</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="Permalink to this definition">¶</a></dt>
<p>Identifies the network plugin that cluster networking functionalities for
this vSphere Namespaces Cluster.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkProvider</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">NSXT_CONTAINER_PLUGIN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkProvider(string='NSXT_CONTAINER_PLUGIN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.NSXT_CONTAINER_PLUGIN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VSPHERE_NETWORK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkProvider(string='VSPHERE_NETWORK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider.VSPHERE_NETWORK"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere Networking. This class attribute was added in vSphere API 7.0.1.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NetworkSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">floating_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">network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address_range</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.NetworkSpec</span></code> contains information related to network
configuration for one or more interfaces.</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>floating_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Optionally specify the Floating IP used by the HA master cluster in
the DHCP case.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.DHCP"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.DHCP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NetworkSpec.Ipv4Mode.DHCP</span></code></a>.</p></li>
<li><p><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the network.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.</p></li>
<li><p><strong>address_range</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.Ipv4Range"title="com.vmware.vcenter.namespace_management_client.Clusters.Ipv4Range"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Ipv4Range</span></code></a>) – Settings for the interfaces on the network.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">mode</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.STATICRANGE"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.STATICRANGE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.NetworkSpec.Ipv4Mode.STATICRANGE</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Ipv4Mode</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.NetworkSpec.Ipv4Mode</span></code> class defines various IPv4 address
assignment modes.</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">Ipv4Mode</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DHCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Ipv4Mode(string='DHCP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>The address is automatically assigned by a DHCP server.</p>
<codeclass="sig-name descname"><spanclass="pre">STATICRANGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Ipv4Mode(string='STATICRANGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkSpec.Ipv4Mode.STATICRANGE"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.SetSpec</span></code> class contains the specification required to set a
new configuration on the Cluster. This class is applied in entirety,
replacing the current specification fully.</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>size_hint</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.SizingHint"title="com.vmware.vcenter.namespace_management_client.SizingHint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SizingHint</span></code></a>) – This affects the size and resources allocated to the Kubernetes API
server.</p></li>
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a>) – The provider of cluster networking for this vSphere Namespaces
cluster.</p></li>
<li><p><strong>ncp_cluster_network_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkSetSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkSetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkSetSpec</span></code></a>) – Specification for the NSX Container Plugin cluster network.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<li><p><strong>master_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use on Kubernetes API server,
specified in order of preference.
If None, DNS servers set on Kubernetes API server will be cleared.</p></li>
<li><p><strong>worker_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use on the worker nodes,
specified in order of preference.
If None, DNS servers set on worker nodes will be cleared.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of domains (for example “vmware.com”) to be searched when
trying to lookup a host name on Kubernetes API server, specified in
order of preference.
If None, DNS search domains set on Kubernetes API server will be
cleared.</p></li>
<li><p><strong>master_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of NTP server DNS names or IP addresses to use on Kubernetes
API server, specified in order of preference.
If None, VMware Tools based time synchronization is enabled and any
set NTP servers are cleared.</p></li>
<li><p><strong>master_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of storage policy associated with Kubernetes API server.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
<li><p><strong>ephemeral_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of storage policy associated with ephemeral disks of all
the Kubernetes Pods in the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
<li><p><strong>login_banner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Disclaimer to be displayed prior to login via the Kubectl plugin.
If None, disclaimer to be displayed prior to login via the Kubectl
plugin will be cleared.</p></li>
<li><p><strong>image_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageStorageSpec</span></code></a>) – Specification for storage to be used for container images.</p></li>
<li><p><strong>default_image_registry</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageRegistry</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image registry to use when Kubernetes Pod container
specification does not specify it as part of the container image
name.
If None, default image registry will be set to Docker Hub.</p></li>
<li><p><strong>default_image_repository</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image repository to use when Kubernetes Pod container
specification does not specify it as part of the container image
name.
If None, default image repository will be set to Docker Hub
official repository in case of Docker Hub image registry, otherwise
will be set to empty string.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMware’s hosted vSphere Kubernetes Service
Repository. Modifying or clearing the Content Library identifier
will not affect existing vSphere Kubernetes Service clusters.
However, upgrades or scale-out of existing clusters may be affected
if the new Content Library doesn’t have the necessary VM Images.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
If None, the Content Library identifier will be cleared.</p></li>
<li><p><strong>workload_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of NTP server DNS names or IP addresses to use for workloads
such as Tanzu Kubernetes Grid VMs, specified in order of
preference. This attribute was added in vSphere API 7.0.1.0.
If None, NTP for Kubernetes API servers will be used.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Stats</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_used</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_used</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_used</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Stats"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Stats</span></code> class contains the basic runtime statistics about a
vSphere Namespaces-enabled cluster.</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>cpu_used</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall CPU usage of the cluster, in MHz. This is the sum of CPU
usage across all worker nodes in the cluster.</p></li>
<li><p><strong>cpu_capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Total CPU capacity in the cluster available for vSphere Namespaces,
in MHz. This is the sum of CPU capacities from all worker nodes in
the cluster.</p></li>
<li><p><strong>memory_used</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall memory usage of the cluster, in mebibytes. This is the sum
of memory usage across all worker nodes in the cluster.</p></li>
<li><p><strong>memory_capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Total memory capacity of the cluster available for vSphere
Namespaces, in mebibytes. This is the sum of memory capacities from
all worker nodesin the cluster.</p></li>
<li><p><strong>storage_used</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall storage used by the cluster, in mebibytes. This is the sum
of storage used across all worker nodes in the cluster.</p></li>
<li><p><strong>storage_capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall storage capacity of the cluster available for vSphere
Namespaces, in mebibytes. This is the sum of total storage
available from all worker nodes in the cluster.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">stats</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">config_status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">kubernetes_status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Summary</span></code> class contains the basic information about the
cluster statistics and status related to vSphere Namespaces.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>cluster_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource.name</span></code>.</p></li>
<li><p><strong>stats</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.Stats"title="com.vmware.vcenter.namespace_management_client.Clusters.Stats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Stats</span></code></a>) – Basic runtime statistics for the cluster.</p></li>
<li><p><strong>config_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus"title="com.vmware.vcenter.namespace_management_client.Clusters.ConfigStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ConfigStatus</span></code></a>) – Current setting for <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.ConfigStatus</span></code>.</p></li>
<li><p><strong>kubernetes_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus"title="com.vmware.vcenter.namespace_management_client.Clusters.KubernetesStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.KubernetesStatus</span></code></a>) – Current setting for <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.KubernetesStatus</span></code>.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.UpdateSpec</span></code> class contains the specification required to
update the configuration on the Cluster. This class is applied partially,
and only the specified fields will replace or modify their existing
counterparts.</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>size_hint</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.SizingHint"title="com.vmware.vcenter.namespace_management_client.SizingHint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SizingHint</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This affects the size and resources allocated to the Kubernetes API
server.
If None, size and resources allocated to Kubernetes API server will
not be modified.</p></li>
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The provider of cluster networking for this vSphere Namespaces
cluster.
If None, the existing effective cluster network specification will
not be modified.</p></li>
<li><p><strong>ncp_cluster_network_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkUpdateSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.NCPClusterNetworkUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NCPClusterNetworkUpdateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Updated specification for the cluster network configuration.
If unset, existing effective value will not be modified If None,
the existing effective cluster network specification will not be
modified.</p></li>
<li><p><strong>master_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use on Kubernetes API server,
specified in order of preference.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, DNS servers set on Kubernetes API server will be
replaced. Otherwise, they will not be modified.</p></li>
<li><p><strong>worker_dns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS server IP addresses to use on the worker nodes,
specified in order of preference.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, DNS servers set on worker nodes will be replaced.
Otherwise, they will not be modified.</p></li>
<li><p><strong>master_dns_search_domains</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of domains (for example “vmware.com”) to be searched when
trying to lookup a host name on Kubernetes API server, specified in
order of preference.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, DNS search domains on Kubernetes API server will
be replaced. Otherwise, they will not be modified.</p></li>
<li><p><strong>master_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of NTP server DNS names or IP addresses to use on Kubernetes
API server, specified in order of preference.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, NTP servers on Kubernetes API server will be
replaced. Otherwise, they will not be modified.</p></li>
<li><p><strong>master_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of storage policy associated with Kubernetes API server.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
If None, storage policy associated with Kubernetes API server will
not be modified.</p></li>
<li><p><strong>ephemeral_storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of storage policy associated with ephemeral disks of all
the Kubernetes Pods in the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
If None, storage policy associated with ephemeral disks of all the
Kubernetes Pods will not be modified.</p></li>
<li><p><strong>login_banner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Disclaimer to be displayed prior to login via the Kubectl plugin.
If None, disclaimer to be displayed prior to login via the Kubectl
plugin will not be modified.</p></li>
<li><p><strong>image_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageStorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageStorageSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification for storage to be used for container images.
If None, configuration of storage used for container images is not
modified.</p></li>
<li><p><strong>default_image_registry</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"title="com.vmware.vcenter.namespace_management_client.Clusters.ImageRegistry"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.ImageRegistry</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image registry to use when Kubernetes Pod container
specification does not specify it as part of the container image
name.
If None, default image registry will not be modified.</p></li>
<li><p><strong>default_image_repository</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default image repository to use when Kubernetes Pod container
specification does not specify it as part of the container image
name.
If None, default image repository will not be modified.</p></li>
<li><p><strong>tls_endpoint_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Certificate issued for Kubernetes API Server. Certificate used must
be created by signing the Certificate Signing Request obtained from
Because a <codeclass="docutils literal notranslate"><spanclass="pre">CertificateSigningRequest</span></code> is created on an existing
Namespaces-enabled <codeclass="docutils literal notranslate"><spanclass="pre">Cluster</span></code>, you must use the
<codeclass="docutils literal notranslate"><spanclass="pre">Clusters.UpdateSpec</span></code> to specify this <codeclass="docutils literal notranslate"><spanclass="pre">tlsEndpointCertificate</span></code>
on an existing <codeclass="docutils literal notranslate"><spanclass="pre">Cluster</span></code> rather than during initially enabling
Namespaces on a <codeclass="docutils literal notranslate"><spanclass="pre">Cluster</span></code>.
If None, Kubernetes API Server certificate will not be modified.</p></li>
<li><p><strong>default_kubernetes_service_content_library</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the Content Library which holds the VM Images for
vSphere Kubernetes Service. This Content Library should be
subscribed to VMware’s hosted vSphere Kubernetes Service
Repository. Modifying or clearing the Content Library identifier
will not affect existing vSphere Kubernetes Service clusters.
However, upgrades or scale-out of existing clusters may be affected
if the new Content Library doesn’t have the necessary VM Images.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
If None, the Content Library identifier will not be modified.</p></li>
<li><p><strong>workload_ntp_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of NTP server DNS names or IP addresses to use for workloads
such as Tanzu Kubernetes Grid VMs, specified in order of
preference. This attribute was added in vSphere API 7.0.1.0.
If None, NTP servers for workloads will be unmodified.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">WorkloadNetworksEnableSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">supervisor_primary_workload_network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_list</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksEnableSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.WorkloadNetworksEnableSpec</span></code> contains the specification
required to configure workload networks for a vSphere Namespaces Cluster
during Enable operation. These workload networks will be used as backing
network for Tanzu Kubernetes Cluster VMs and Kubernetes control plane VMs.
This class was added in vSphere API 7.0.1.0.</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>supervisor_primary_workload_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"title="com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networks.CreateSpec</span></code></a>) – The <codeclass="docutils literal notranslate"><spanclass="pre">CreateSpec</span></code> of the vSphere Namespaces network that will be
used by Kubernetes control plane VMs to expose Kubernetes API
server to devops users and other workloads. It can also used as
backing network for Tanzu Kubernetes Cluster VMs. This attribute
was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>network_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"title="com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networks.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<codeclass="docutils literal notranslate"><spanclass="pre">CreateSpecs</span></code> classes for additional list of vSphere Namespaces
networks to be associated with this cluster. This attribute was
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">WorkloadNetworksInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">supervisor_primary_workload_network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_list</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.WorkloadNetworksInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.WorkloadNetworksInfo</span></code> contains information related to
configuration of vSphere Namespaces Network objects. This class was added
in vSphere API 7.0.1.0.</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>supervisor_primary_workload_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Networks.Info"title="com.vmware.vcenter.namespace_management_client.Networks.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networks.Info</span></code></a>) – vSphere Namespaces network used by Kubernetes control plane VMs to
access load-balanced services on the various workload networks.
This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>network_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Networks.Info"title="com.vmware.vcenter.namespace_management_client.Networks.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networks.Info</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of vSphere Namespaces networks associated with this cluster.
This attribute was added in vSphere API 7.0.1.0.</p></li>
<codeclass="sig-name descname"><spanclass="pre">disable</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.disable"title="Permalink to this definition">¶</a></dt>
<dd><p>Disable vSphere Namespaces on the cluster. This operation tears down
the Kubernetes instance and the worker nodes associated with vSphere
Namespaces enabled cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster for which vSphere Namespaces will be
disabled.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">enable</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.enable"title="Permalink to this definition">¶</a></dt>
<dd><p>Enable vSphere Namespaces on the cluster. This operation sets up
Kubernetes instance for the cluster along with worker nodes.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces will be
enabled.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.EnableSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.EnableSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.EnableSpec</span></code></a>) – Specification for setting up the Kubernetes API server and the
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a specific cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about all clusters on which vSphere Namespaces are
<codeclass="sig-name descname"><spanclass="pre">rotate_password</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.rotate_password"title="Permalink to this definition">¶</a></dt>
<dd><p>Request a new root password for all control plane nodes in the cluster.
This operation generates a new root password and configures every
control plane node in the cluster to accept it for authentication.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster for which the password is being
generated.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">set</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set a new configuration on the cluster object. The specified
configuration is applied in entirety and will replace the current
configuration fully.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces is enabled.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.SetSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.SetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.SetSpec</span></code></a>) – New specification for the cluster.</p></li>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Clusters.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Update configuration on the cluster object. The specified configuration
is applied partially and None fields in <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> will leave those parts
of configuration as-is.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces is enabled.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.UpdateSpec"title="com.vmware.vcenter.namespace_management_client.Clusters.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.UpdateSpec</span></code></a>) – New specification for the cluster.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DistributedSwitchCompatibility</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DistributedSwitchCompatibility</span></code> class provides methods to get
Namespaces compatibility information of Distributed Switches in this
vCenter.</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">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">compatible</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_provider</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DistributedSwitchCompatibility.FilterSpec</span></code> class contains attributes
used to filter the results when listing Distributed Switches (see
<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list"title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">DistributedSwitchCompatibility.list()</span></code></a>) and their compatibility
information.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Compatibility criteria for matching the filter. If true, only
Distributed Switches which are compatible with vSphere Namespaces
match the filter. If false, only Distributed Switches which are
incompatible with vSphere Namespaces match the filter.
If None, both compatible and incompatible Distributed Switches
match the filter.</p></li>
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The network provider whose networks will be considered. If unset,
this will default to NSXT_CONTAINER_PLUGIN. This attribute was
added in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">distributed_switch</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">compatible</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">incompatibility_reasons</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_provider</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">compatible_networks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DistributedSwitchCompatibility.Summary</span></code> class contains information
about the compatibility of a vSphere Distributed Switch with the Namespaces
feature.</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>distributed_switch</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the switch. If <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is either None or
is set to NSXT_CONTAINER_PLUGIN, the value of this field will refer
to the UUID of a vim.DistributedVirtualSwitch. Otherwise, the value
of the field will refer to the ID of a
vim.DistributedVirtualSwitch.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">vSphereDistributedSwitch</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">vSphereDistributedSwitch</span></code>.</p></li>
<li><p><strong>compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Compatibility of this switch with vSphere Namespaces.</p></li>
<li><p><strong>incompatibility_reasons</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of reasons for incompatibility.
If None, this Distributed Switch is compatible.</p></li>
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The network provider whose networks were considered. This attribute
was added in vSphere API 7.0.1.0.
If None, clients clients should assume the value to be
NSXT_CONTAINER_PLUGIN.</p></li>
<li><p><strong>compatible_networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of compatible (PortGroup) Networks under the distributed
switch. This attribute was added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>. When methods return a value of this class as a return
value, the attribute will contain identifiers for the resource
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">filter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns Namespaces compatibility information of Distributed Switches in
vCenter associated with the vCenter cluster, matching the
<li><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DistributedSwitchCompatibility.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching Distributed Switches for which
information should be returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.DistributedSwitchCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DistributedSwitchCompatibility.FilterSpec</span></code></a> with all
attributes None which means all Distributed Switches match the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">EdgeClusterCompatibility</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">EdgeClusterCompatibility</span></code> class provides methods to get Namespaces
compatibility information of NSX Edge Clusters.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">compatible</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">EdgeClusterCompatibility.FilterSpec</span></code> class contains attributes used
to filter the results when listing Edge Clusters (see
<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list"title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">EdgeClusterCompatibility.list()</span></code></a>) and their compatibility information.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Compatibility criteria for matching the filter. If true, only Edge
Clusters which are compatible with vSphere Namespaces match the
filter. If false, only Edge Clusters which are incompatible with
vSphere Namespaces match the filter.
If None, both compatible and incompatible Edge Clusters match the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">edge_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">compatible</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">incompatibility_reasons</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the Edge Cluster.</p></li>
<li><p><strong>compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Compatibility of this Edge Cluster with Namespaces feature.</p></li>
<li><p><strong>incompatibility_reasons</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of reasons for incompatibility.
If None, this Edge Cluster is compatible.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">distributed_switch</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">filter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns Namespaces compatibility information of NSX-T Edge Clusters
matching the <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeClusterCompatibility.FilterSpec</span></code></a>.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of a vCenter Cluster. Only Edge Clusters that are
associated with the particular vCenter Cluster will be considered
by the filter.
The parameter must be an identifier for the resource type:
<li><p><strong>distributed_switch</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of a Distributed Switch. Only Edge Clusters that are
associated with the particular Distributed Switch will be
considered by the filter.
The parameter must be an identifier for the resource type:
<li><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeClusterCompatibility.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching Edge Clusters for which information
should be returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"title="com.vmware.vcenter.namespace_management_client.EdgeClusterCompatibility.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeClusterCompatibility.FilterSpec</span></code></a> with all attributes
None which means all Edge Clusters match the filter.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostsConfig</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.HostsConfig"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Compatibility</span></code> class provides methods to retrieve information about
vSphere Namespaces support and licensing.</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">namespaces_supported</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">namespaces_licensed</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.HostsConfig.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Compatibility</span></code> class contains information about vSphere Namespaces
support and licensing.</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>namespaces_supported</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – True if vSphere Namespace feature is supported in this VC.</p></li>
<li><p><strong>namespaces_licensed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – True if vSphere Namespace feature is licensed on any hosts in this
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.HostsConfig.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns support and licensing information about hosts under a VC.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">IPRange</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.IPRange"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IPRange</span></code> class is used to express a range of IP addresses. The
formats supported by this structure will depend on the IP addressing scheme
that is being used by vSphere Namespaces. Currently, vSphere Namespaces
only supports IPv4. This class was added in vSphere API 7.0.1.0.</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>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The starting address of the range. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The number of IP addresses in the range. This attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Ipv4Cidr</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Ipv4Cidr"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LoadBalancers</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers</span></code> represent the user provisioned load balancers. The load
balancers provided may be used to front the API servers in both, vSphere
Namespaces Cluster and Tanzu Kubernetes Grid clusters. Note: The lifecycle
of these load balancers is not managed by vSphere. This class was added in
vSphere API 7.0.1.0.</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">AviConfigCreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">server</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">username</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">certificate_authority_chain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigCreateSpec"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.AviConfigCreateSpec</span></code> captures the configuration data
required for integration with the Avi Software Load Balancer. This class
was added in vSphere API 7.0.2.0.</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>server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Server</span></code></a>) – Server is the address for the Avi Controller, used to configure
Virtual Servers. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An administrator user name for accessing the Avi Controller. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password for the administrator user. This attribute was added
in vSphere API 7.0.2.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – CertificateAuthorityChain contains PEM-encoded CA chain which is
used to verify x509 certificates received from the server. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">AviInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">server</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">username</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">certificate_authority_chain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.AviInfo</span></code> contains information related to the Avi
software load balancer in the namespace. This class was added in vSphere
API 7.0.2.0.</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>server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Server</span></code></a>) – Server is the address for the Avi Controller, used to configure
Virtual Servers. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An administrator user name for accessing the Avi Controller. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – PEM-encoded CA certificate chain which is used to verify x509
certificates received from the server. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ConfigSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address_ranges</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">provider</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_proxy_config_create_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">avi_config_create_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.ConfigSpec"title="Permalink to this definition">¶</a></dt>
on vSphere Namespaces. This class was added in vSphere API 7.0.1.0.</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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An identifier that identifies a load balancer and can be used to
query or configure load balancer properties via these resources.
The identifier has DNS_LABEL restrictions as specified in `
<<aclass="reference external"href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>>`_. This must be an
alphanumeric (a-z and 0-9) string, with a maximum length of 63
characters and with the ‘-‘ character allowed anywhere except the
first or last character. This name is unique across all Namespaces
in this vCenter server. This attribute was added in vSphere API
7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>address_ranges</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.IPRange"title="com.vmware.vcenter.namespace_management_client.IPRange"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IPRange</span></code></a>) – List of address ranges that will be used to derive frontend IP
addresses for L4 virtual servers. At least one range must be
provided. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider</span></code></a>) – The {#member provider} selects a provider from the list of
available providers to be used with vSphere Namespaces. This
attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>ha_proxy_config_create_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigCreateSpec"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.HAProxyConfigCreateSpec</span></code></a>) – The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.HAProxyConfigCreateSpec</span></code> is a conditional
configuration made available upon selecting the HA_PROXY load
balancer provider. It is used to configure the load balancer at run
time. This attribute was added in vSphere API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">provider</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider.HA_PROXY</span></code></a>.</p></li>
<li><p><strong>avi_config_create_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigCreateSpec"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviConfigCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.AviConfigCreateSpec</span></code></a>) – The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.AviConfigCreateSpec</span></code> is a conditional
configuration made available upon selecting the AVI load balancer
provider. It is used to configure the load balancer at run time.
This attribute was added in vSphere API 7.0.2.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">provider</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider.AVI</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HAProxyConfigCreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">servers</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">username</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">certificate_authority_chain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyConfigCreateSpec"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.HAProxyConfigCreateSpec</span></code> captures the configuration data
required for Supervisor Service Type:LoadBalancer to have an external load
balancer be created via HAProxy. This class was added in vSphere API
7.0.1.0.</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>servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Server</span></code></a>) – Servers is a list of the addresses for the data plane API servers
used to configure Virtual Servers. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An administrator user name for accessing the HAProxy Data Plane API
server. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The password for the administrator user. This attribute was added
in vSphere API 7.0.1.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – CertificateAuthorityChain contains PEM-encoded CA chain which is
used to verify x509 certificates received from the server. This
attribute was added in vSphere API 7.0.1.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HAProxyInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">servers</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">username</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">certificate_authority_chain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.HAProxyInfo</span></code> contains information related to the
HAProxy load balancer in the namespace. This class was added in vSphere API
7.0.1.0.</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>servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Server</span></code></a>) – A list of the addresses for the DataPlane API servers used to
configure HAProxy. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An administrator user name for accessing the HAProxy Data Plane API
server. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>certificate_authority_chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – PEM-encoded CA certificate chain which is used to verify x509
certificates received from the server. This attribute was added in
<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">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address_ranges</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">provider</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_proxy_info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">avi_info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.Info</span></code> contains information related to the load
balancer for provisioning virtual servers in the namespace. This class was
added in vSphere API 7.0.1.0.</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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An DNS compliant identifier for a load balancer, which can be used
to query or configure the load balancer properties. This attribute
was added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>address_ranges</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.IPRange"title="com.vmware.vcenter.namespace_management_client.IPRange"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IPRange</span></code></a>) – IP address range from which virtual servers are assigned their IPs.
This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider</span></code></a>) – Load balancer provider for the namespace. This attribute was added
in vSphere API 7.0.1.0.</p></li>
<li><p><strong>ha_proxy_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyInfo"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.HAProxyInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.HAProxyInfo</span></code></a>) – The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.HAProxyInfo</span></code> is a conditional configuration
made available upon selecting the HA_PROXY load balancer provider.
It is used to configure the load balancer at run time. This
attribute was added in vSphere API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">provider</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider.HA_PROXY</span></code></a>.</p></li>
<li><p><strong>avi_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.AviInfo"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.AviInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.AviInfo</span></code></a>) – The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.AviInfo</span></code> is a conditional configuration made
available upon selecting the AVI load balancer provider. It is used
to configure the load balancer at run time. This attribute was
added in vSphere API 7.0.2.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">provider</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider.AVI</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Provider</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider</span></code> enumerates the kinds of load balancers
supported by vSphere Namespaces. This enumeration was added in vSphere API
7.0.1.0.</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">Provider</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">AVI</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Provider(string='AVI')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.AVI"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">HA_PROXY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Provider(string='HA_PROXY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider.HA_PROXY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Server</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Server"title="Permalink to this definition">¶</a></dt>
<p>A <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.Server</span></code> represents an endpoint used to configure load
balancers. This class was added in vSphere API 7.0.1.0.</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>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Load balancer hostname or IPv4 address. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Load balancer port. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">provider</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LoadBalancers.Summary</span></code> contains contains basic information related
to the load balancer for provisioning virtual servers in the namespace.
This class was added in vSphere API 7.0.1.0.</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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An DNS compliant identifier for a load balancer, which can be used
to query or configure the load balancer properties. This attribute
was added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Provider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Provider</span></code></a>) – Load balancer provider for the namespace. This attribute was added
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"title="com.vmware.vcenter.namespace_management_client.LoadBalancers.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LoadBalancers.Info</span></code></a> about the load balancer
associated with the given cluster. This method was added in vSphere API
7.0.1.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster the load balancer is associated with.
The parameter must be an identifier for the resource type:
if <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">id</span></code> cannot be located.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.LoadBalancers.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about all load balancers associated with the given
cluster. This method was added in vSphere API 7.0.1.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster the load balancers are associated with.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">NamespaceResourceOptions</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceResourceOptions</span></code> class provides methods to get the objects
used to create and modify resource quotas on a namespace.</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">create_resource_quota_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">update_resource_quota_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.namespace_management_client.NamespaceResourceOptions.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceResourceOptions.Info</span></code> class contains the information about
the objects used to set and update resource quota keys on a namespace.</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>create_resource_quota_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the class used to set resource quotas on the
namespace. See com.vmware.vcenter.namespaces.Instances#create and
com.vmware.vcenter.namespaces.Instances#set.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</p></li>
<li><p><strong>update_resource_quota_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the class used to update resource quotas on the
namespace. See com.vmware.vcenter.namespaces.Instances#update.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.NamespaceResourceOptions.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the information about the objects used to set and update resource
quota keys for version of Kubernetes running on {#link cluster}.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster hosting the namespace on which the
resource quota needs to be set.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Networks</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Networks</span></code> class provides lifecycle methods on vSphere Namespaces
networks associated with a vSphere cluster. This class was added in vSphere
API 7.0.1.0.</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">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_provider</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vsphere_network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Networks.CreateSpec</span></code> class contains the specification required to
create a vSphere Namespaces network object. This class was added in vSphere
API 7.0.1.0.</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>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the network. This has DNS_LABEL restrictions as
specified in ` <<aclass="reference external"href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>>`_. This must
be an alphanumeric (a-z and 0-9) string and with maximum length of
63 characters and with the ‘-‘ character allowed anywhere except
the first or last character. This name must be unique within a
cluster. This attribute was added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a>) – The network provider that will manage the vSphere Namespaces
network object. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>vsphere_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkCreateSpec"title="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networks.VsphereDVPGNetworkCreateSpec</span></code></a>) – The create spec for a DVPG-backed Namespaces network object,
supported by <codeclass="docutils literal notranslate"><spanclass="pre">VSPHERE_NETWORK</span></code> network provider. This attribute
was added in vSphere API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<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">network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network_provider</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vsphere_network</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks.Info"title="Permalink to this definition">¶</a></dt>
<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>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the network. This attribute was added in vSphere API
7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespace_management.Network</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>network_provider</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"title="com.vmware.vcenter.namespace_management_client.Clusters.NetworkProvider"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.NetworkProvider</span></code></a>) – The network provider that will manage the vSphere Namespaces
network object. This attribute was added in vSphere API 7.0.1.0.</p></li>
<li><p><strong>vsphere_network</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkInfo"title="com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Networks.VsphereDVPGNetworkInfo</span></code></a>) – Updated configuration specification for a DVPG-backed Namespaces
network object, supported by <codeclass="docutils literal notranslate"><spanclass="pre">VSPHERE_NETWORK</span></code> network provider.
This attribute was added in vSphere API 7.0.1.0.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">networkProvider</span></code> is
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.namespace_management.Network'</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for network. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VsphereDVPGNetworkCreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">portgroup</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address_ranges</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">gateway</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subnet_mask</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkCreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Networks.VsphereDVPGNetworkCreateSpec</span></code> class describes the
configuration specification of a vSphere DVPG-backed Namespaces Network
object. This class was added in vSphere API 7.0.1.0.</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>portgroup</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the vSphere Distributed Portgroup backing the vSphere
network object. This attribute was added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.</p></li>
<li><p><strong>address_ranges</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.IPRange"title="com.vmware.vcenter.namespace_management_client.IPRange"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IPRange</span></code></a>) – Usable IP pools on this network. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Gateway for the network. This attribute was added in vSphere API
7.0.1.0.</p></li>
<li><p><strong>subnet_mask</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Subnet mask of the network. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VsphereDVPGNetworkInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">portgroup</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address_ranges</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">gateway</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subnet_mask</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks.VsphereDVPGNetworkInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Networks.VsphereDVPGNetworkInfo</span></code> class describes the configuration
specification of a vSphere DVPG-backed Namespaces Network object. This
class was added in vSphere API 7.0.1.0.</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>portgroup</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the vSphere Distributed Portgroup backing the vSphere
network object. This attribute was added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.</p></li>
<li><p><strong>address_ranges</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.IPRange"title="com.vmware.vcenter.namespace_management_client.IPRange"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IPRange</span></code></a>) – Usable IP pools on this network. This attribute was added in
vSphere API 7.0.1.0.</p></li>
<li><p><strong>gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Gateway for the network. This attribute was added in vSphere API
7.0.1.0.</p></li>
<li><p><strong>subnet_mask</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Subnet mask of the network. This attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about a specific vSphere Namespaces network. This
method was added in vSphere API 7.0.1.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.Networks.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about all vSphere Namespaces networks in the
cluster. This method was added in vSphere API 7.0.1.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SizingHint</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SizingHint"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SizingHint</span></code> class determines the configuration of Kubernetes API
server and the worker nodes. It also determines the default values
associated with the maximum number of pods and services. Use
<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get"title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ClusterSizeInfo.get()</span></code></a> to get information associated with a
<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 <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.SizingHint"title="com.vmware.vcenter.namespace_management_client.SizingHint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SizingHint</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">LARGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SizingHint(string='LARGE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SizingHint.LARGE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MEDIUM</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SizingHint(string='MEDIUM')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SizingHint.MEDIUM"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SMALL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SizingHint(string='SMALL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SizingHint.SMALL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TINY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SizingHint(string='TINY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SizingHint.TINY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SupportBundle</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SupportBundle"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SupportBundle</span></code> class provides methods to retrieve the cluster’s
Namespaces-related support bundle download location.</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">Location</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">url</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">wcp_support_bundle_token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Location"title="Permalink to this definition">¶</a></dt>
<li><p><strong>wcp_support_bundle_token</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Token"title="com.vmware.vcenter.namespace_management_client.SupportBundle.Token"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SupportBundle.Token</span></code></a>) – Information about the token required in the HTTP GET request to
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Token</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">expiry</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Token"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SupportBundle.Token</span></code> class contains information about the token
required in the HTTP GET request to generate the support bundle.</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>token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A one-time, short-lived token required in the HTTP header of the
request to the url. This token needs to be passed in as a header
with the name “wcp-support-bundle-token”.</p></li>
<li><p><strong>expiry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Expiry time of the token</p></li>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.SupportBundle.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the location <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.SupportBundle.Location"title="com.vmware.vcenter.namespace_management_client.SupportBundle.Location"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SupportBundle.Location</span></code></a> information for
downloading the Namespaces-related support bundle for the specified
cluster.</p>
<blockquote>
<div><p>Retrieving a support bundle involves two steps:</p>
</div></blockquote>
<ulclass="simple">
<li><p>Step 1: Invoke method to provision a token and a URI.</p></li>
<li><p>Step 2: Make an HTTP GET request using URI and one time used token
returned in step 1 to generate the support bundle and return it.</p></li>
</ul>
<p>There can only be one valid token per cluster at any given time. If
this method is invoked again for the same cluster identifier while a
<li><p>return 401 (Not Authorized) if the download URL is recognized, but
the token is invalid.</p></li>
<li><p>otherwise return 200 (OK), mark the token used (invalidating it for
any future use), open a application/tar download stream for the client,
and start the bundle process. As part of its work, the API will
orchestrate support bundling on the worker nodes of a cluster. If a
failure occurs during the collection of support bundle from worker
node, the API will not abort the request, but will log a warning and
move on to processing other worker nodes’ bundles. The API will only
abort its operation if the content of the stream has been corrupted.
When the API has to abort its operation (and the response stream), it
will not provide any indication of failures to the client. The client
will need to verify validity of the resultant file based on the format
specified in the response’s Content-Disposition header.</p></li>
</ul>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of cluster for which the Namespaces-related support
bundle should be generated.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management_client.</span></code><codeclass="sig-name descname"><spanclass="pre">VirtualMachineClasses</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineClasses</span></code> class provides management methods for
customizable virtual machine classes. A virtual machine class represents a
policy and configuration resource which defines a set of attributes to be
used in the configuration of a virtual machine instance. This class was
added in vSphere API 7.0.2.00100.</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">ConfigStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus"title="Permalink to this definition">¶</a></dt>
<p>ConfigStatus represents the config status of the VM class. This enumeration
was added in vSphere API 7.0.2.00100.</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">ConfigStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">READY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='READY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus.READY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">REMOVING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='REMOVING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus.REMOVING"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_reservation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_mb</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_reservation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.CreateSpec</span></code> class contains the specification
required to create a VirtualMachineClass object. This class was added in
vSphere API 7.0.2.00100.</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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine class. This has DNS_LABEL
restrictions as specified in `
<<aclass="reference external"href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>>`_. This must be an
alphanumeric (a-z and 0-9) string and with maximum length of 63
characters and with the ‘-‘ character allowed anywhere except the
first or last character. This name is unique in this vCenter
server. This attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>cpu_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The number of CPUs configured for virtual machine of this class.
This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>cpu_reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The percentage of total available CPUs reserved for a virtual
machine. We multiply this percentage by the minimum frequency
amongst all the cluster nodes to get the CPU reservation that is
specified to vSphere in MHz. This attribute was added in vSphere
API 7.0.2.00100.
If None, no CPU reservation is requested for the virtual machine.</p></li>
<li><p><strong>memory_mb</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The amount of memory in MB configured for virtual machine of this
class. This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>memory_reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The percentage of available memory reserved for a virtual machine
of this class. This attribute was added in vSphere API 7.0.2.00100.
If None, no memory reservation is requested for virtual machine.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description for the VirtualMachineClass. This attribute was added
in vSphere API 7.0.2.00100.
If None, no description is added to the VirtualMachineClass</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.Info</span></code> class contains detailed information
about the virtual machine class. This class was added in vSphere API
7.0.2.00100.</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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the VirtualMachineClass. This attribute was added in
vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<li><p><strong>cpu_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The number of CPUs configured for virtual machine of this class.
This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>cpu_reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The percentage of total available CPUs reserved for a virtual
machine. We multiply this percentage by the minimum frequency
amongst all the cluster nodes to get the CPU reservation that is
specified to vSphere in MHz. This attribute was added in vSphere
API 7.0.2.00100.
If None, no CPU reservation is requested for the virtual machine.</p></li>
<li><p><strong>memory_mb</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The amount of memory in MB configured for virtual machine of this
class. This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>memory_reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The percentage of available memory reserved for a virtual machine
of this class. This attribute was added in vSphere API 7.0.2.00100.
If None, no memory reservation is requested for virtual machine.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the VirtualMachineClass. This attribute was added in
vSphere API 7.0.2.00100.</p></li>
<li><p><strong>namespaces</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Set of Namespaces associated with this VirtualMachineClass. This
attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will contain
<li><p><strong>vms</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Set of virtual machines deployed for VirtualMachineClass. This
attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
<li><p><strong>config_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus"title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.ConfigStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.ConfigStatus</span></code></a>) – Configstatus of VM class. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message"title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.Message</span></code></a>) – Current set of messages associated with the object. This attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Message</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">severity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.Message</span></code> class contains the information about
the object configuration. This class was added in vSphere API 7.0.2.00100.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity"title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.Message.MessageSeverity</span></code></a>) – Type of the message. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>details</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details about the message. This attribute was added in vSphere API
7.0.2.00100.
If None, message details are not required for taking actions.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">MessageSeverity</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.Message.MessageSeverity</span></code> class represents the
severity of the message. This enumeration was added in vSphere API
7.0.2.00100.</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">MessageSeverity</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MessageSeverity(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm. This
class attribute was added in vSphere API 7.0.2.00100.</p>
<codeclass="sig-name descname"><spanclass="pre">INFO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MessageSeverity(string='INFO')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.INFO"title="Permalink to this definition">¶</a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event. This class
attribute was added in vSphere API 7.0.2.00100.</p>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MessageSeverity(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.Message.MessageSeverity.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event. This class
attribute was added in vSphere API 7.0.2.00100.</p>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.namespace_management.VirtualMachineClass'</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for VirtualMachineClass. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_reservation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_mb</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_reservation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.UpdateSpec</span></code> class contains the specification
required to update a VirtualMachineClass object. This class was added in
vSphere API 7.0.2.00100.</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>cpu_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The number of CPUs configured for virtual machine of this class.
This attribute was added in vSphere API 7.0.2.00100.
If None the current value the will not be modified.</p></li>
<li><p><strong>cpu_reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The percentage of total available CPUs reserved for a virtual
machine. We multiply this percentage by the minimum frequency
amongst all the cluster nodes to get the CPU reservation that is
specified to vSphere in MHz. This attribute was added in vSphere
API 7.0.2.00100.
If None, no CPU reservation is requested for the virtual machine.</p></li>
<li><p><strong>memory_mb</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The amount of memory in MB configured for virtual machine of this
class. This attribute was added in vSphere API 7.0.2.00100.
If None the current value the will not be modified.</p></li>
<li><p><strong>memory_reservation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The percentage of available memory reserved for a virtual machine
of this class. This attribute was added in vSphere API 7.0.2.00100.
If None, no memory reservation is requested for virtual machine.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description for the VirtualMachineClass. This attribute was added
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a VirtualMachineClass object. This method was added in vSphere
API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.CreateSpec"title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.CreateSpec</span></code></a>) – Information about the VirtualMachineClass object to be created.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_class</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete the VirtualMachineClass object. This method was added in vSphere
API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>vm_class</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the VirtualMachineClass.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_class</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about a VirtualMachineClass. This method was added
in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>vm_class</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the VirtualMachineClass.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about all VirtualMachine classes. This method was
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_class</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Update the configuration of the VirtualMachineClass object. This method
was added in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm_class</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the VirtualMachineClass.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.UpdateSpec"title="com.vmware.vcenter.namespace_management_client.VirtualMachineClasses.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VirtualMachineClasses.UpdateSpec</span></code></a>) – Information about the VirtualMachineClass object to be updated.</p></li>
<spanid="com-vmware-vcenter-namespaces-client-module"></span><h2>com.vmware.vcenter.namespaces_client module<aclass="headerlink"href="#module-com.vmware.vcenter.namespaces_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces_client</span></code> module provides classes for
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespaces_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Access</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.namespaces_client.Access"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Access</span></code> class provides methods to manage access control of subjects
on namespaces.</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">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">role</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.namespaces_client.Access.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Access.CreateSpec</span></code> class contains the specification required to
create access control on the namespace.</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>role</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.Role"title="com.vmware.vcenter.namespaces_client.Access.Role"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.Role</span></code></a>) – Role to be assigned.</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">role</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">inherited</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.namespaces_client.Access.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Access.Info</span></code> class contains the information about the access control
of the subject on given domain on the namespace.</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>role</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.Role"title="com.vmware.vcenter.namespaces_client.Access.Role"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.Role</span></code></a>) – Role of the subject on the namespace.</p></li>
<li><p><strong>inherited</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate if the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Access.Info.role</span></code> is direct or
inherited. The value is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code> if the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Access.Info.role</span></code> is inherited from group membership. This
attribute was added in vSphere API 7.0.2.00100.
This attribute is optional because it was added in a newer version
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Role</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.namespaces_client.Access.Role"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Access.Role</span></code> class lists the default roles which can be associated
with a subject on a domain on the namespace.</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">Role</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">EDIT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Role(string='EDIT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.Role.EDIT"title="Permalink to this definition">¶</a></dt>
<dd><p>This role allows modification of the namespace.</p>
<codeclass="sig-name descname"><spanclass="pre">OWNER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Role(string='OWNER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.Role.OWNER"title="Permalink to this definition">¶</a></dt>
<dd><p>This role allows modification and deletion of the namespace. This class
attribute was added in vSphere API 7.0.2.00100.</p>
<codeclass="sig-name descname"><spanclass="pre">VIEW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Role(string='VIEW')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.Role.VIEW"title="Permalink to this definition">¶</a></dt>
<dd><p>This is a read-only role on the namespace.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SetSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">role</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.namespaces_client.Access.SetSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Access.SetSpec</span></code> class contains the specification required to set new
access control on the namespace.</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>role</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.Role"title="com.vmware.vcenter.namespaces_client.Access.Role"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.Role</span></code></a>) – Role to be assigned.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SubjectType</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.namespaces_client.Access.SubjectType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Access.SubjectType</span></code> class lists the types of subjects who can be
associated with a <codeclass="docutils literal notranslate"><spanclass="pre">Access.Role</span></code> on the namespace.</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">SubjectType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">GROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SubjectType(string='GROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType.GROUP"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">USER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SubjectType(string='USER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType.USER"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Set up access control for the subject on given domain on the namespace.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The principal for this operation.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType"title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.SubjectType</span></code></a>) – The type of subject (user or group).</p></li>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.CreateSpec"title="com.vmware.vcenter.namespaces_client.Access.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.CreateSpec</span></code></a>) – Information about the access control to be created.</p></li>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove access control of the subject on given domain from the
namespace.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The principal for this operation.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType"title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.SubjectType</span></code></a>) – The type of subject (user or group).</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the information about the access control of the subject on given
domain on the namespace.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The principal for this operation.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType"title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.SubjectType</span></code></a>) – The type of subject (user or group).</p></li>
<codeclass="sig-name descname"><spanclass="pre">set</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Access.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set new access control on the namespace for the subject on given
domain.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The domain of the subject.</p></li>
<li><p><strong>subject</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The principal for this operation.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType"title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.SubjectType</span></code></a>) – The type of subject (user or group).</p></li>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.SetSpec"title="com.vmware.vcenter.namespaces_client.Access.SetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.SetSpec</span></code></a>) – Information about the new access control to be assigned.</p></li>
<p>A <codeclass="docutils literal notranslate"><spanclass="pre">Container</span></code> holds the data that describes a container within a pod.
<strong>Note:</strong> This class is restricted for <strong>VMware internal use only</strong>.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the container.</p></li>
<li><p><strong>image</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The image the container is running.</p></li>
<li><p><strong>status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The container’s current condition.</p></li>
<li><p><strong>started_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Time at which the container was last (re-)started.</p></li>
<li><p><strong>finished_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Time at which the container last terminated.</p></li>
<li><p><strong>reason</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Details about the container’s current condition, if any.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespaces_client.</span></code><codeclass="sig-name descname"><spanclass="pre">EndpointAddress</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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">port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">protocol</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.namespaces_client.EndpointAddress"title="Permalink to this definition">¶</a></dt>
<p>An <codeclass="docutils literal notranslate"><spanclass="pre">EndpointAddress</span></code> contains the data that describes an Endpoint’s
address in Kubernetes.
<strong>Note:</strong> This class is restricted for <strong>VMware internal use only</strong>.</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>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The Kubernetes Service the Endpoint belongs to.</p></li>
<li><p><strong>ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address of the Endpoint.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The port of the Endpoint.</p></li>
<li><p><strong>protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The protocol used by this Endpoint.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespaces_client.</span></code><codeclass="sig-name descname"><spanclass="pre">IngressRuleValue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</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.namespaces_client.IngressRuleValue"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespaces_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Instances</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.namespaces_client.Instances"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances</span></code> class provides methods to create and delete a namespace
object. In this version, an Instance is an abstraction around a Kubernetes
namespace.</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">Access</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">subject_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">role</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.namespaces_client.Instances.Access"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.Access</span></code> class contains the access control information for
a subject on a namespace.</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>subject_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType"title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.SubjectType</span></code></a>) – Type of the subject.</p></li>
<li><p><strong>subject</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the subject.</p></li>
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain of the subject.</p></li>
<li><p><strong>role</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.Role"title="com.vmware.vcenter.namespaces_client.Access.Role"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.Role</span></code></a>) – Role of the subject on the namespace instance.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ConfigStatus</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.namespaces_client.Instances.ConfigStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.ConfigStatus</span></code> class describes the status of reaching the
desired state configuration for the namespace.</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">ConfigStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CONFIGURING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='CONFIGURING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.CONFIGURING"title="Permalink to this definition">¶</a></dt>
<dd><p>The configuration is being applied to the namespace.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Failed to apply the configuration to the namespace, user intervention
<codeclass="sig-name descname"><spanclass="pre">REMOVING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='REMOVING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.REMOVING"title="Permalink to this definition">¶</a></dt>
<dd><p>The configuration is being removed and namespace is being deleted.</p>
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus.RUNNING"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.CreateSpec</span></code> class contains the specification required to
set up a namespace.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the namespace. This has DNS_LABEL restrictions as
specified in ` <<aclass="reference external"href="https://tools.ietf.org/html/rfc1123">https://tools.ietf.org/html/rfc1123</a>>`_. This must
be an alphanumeric (a-z and 0-9) string and with maximum length of
63 characters and with the ‘-‘ character allowed anywhere except
the first or last character. This name is unique across all
Namespaces in this vCenter server. In this version, this maps to
the name of a Kubernetes namespace.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will be an
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster on which the namespace is being created.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description for the namespace.
If None, no description is added to the namespace.</p></li>
<li><p><strong>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource quota on the namespace. Refer to
for retrieving the type for the value for this field. For an
example of this, see <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1</span></code></a>.
If None, no resource limits will be set on the namespace.</p></li>
<li><p><strong>access_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Access"title="com.vmware.vcenter.namespaces_client.Instances.Access"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Access</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Access controls associated with the namespace.
If None, only users with Administrator role can access the
namespace.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage associated with the namespace.
If None, storage policies will not be associated with the namespace
which will prevent users from being able to provision pods with
persistent storage on the namespace. Users will be able to
provision pods which use local storage.</p></li>
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere Namespaces network objects to be associated with the
namespace. The values of this list need to reference names of
pre-existing <codeclass="docutils literal notranslate"><spanclass="pre">Networks.Info</span></code> classs. This attribute was added in
vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will contain
<li><p><strong>vm_service_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.VMServiceSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VM Service specification associated with the namespace. This
attribute was added in vSphere API 7.0.2.00100.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>creator</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Principal"title="com.vmware.vcenter.namespaces_client.Instances.Principal"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Principal</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Creator of the namespace. Namespace self-service uses this field to
populate the user who created this namespace. This attribute was
added in vSphere API 7.0.2.00100.
This attribute is optional because it was added in a newer version
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.Info</span></code> class contains detailed information about the
namespace.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster hosting the namespace.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>config_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus"title="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.ConfigStatus</span></code></a>) – Current setting for <codeclass="docutils literal notranslate"><spanclass="pre">Instances.ConfigStatus</span></code>.</p></li>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Message"title="com.vmware.vcenter.namespaces_client.Instances.Message"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Message</span></code></a>) – Current set of messages associated with the object.</p></li>
<li><p><strong>stats</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Stats"title="com.vmware.vcenter.namespaces_client.Instances.Stats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Stats</span></code></a>) – Basic runtime statistics for the namespace.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the namespace.</p></li>
<li><p><strong>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Quotas on the namespace resources. Refer to
If None, no resource constraints are associated with the namespace.</p></li>
<li><p><strong>access_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Access"title="com.vmware.vcenter.namespaces_client.Instances.Access"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Access</span></code></a>) – Access controls associated with the namespace.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a>) – Storage associated with the namespace.</p></li>
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere Networks associated with the namespace. This attribute was
added in vSphere API 7.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
value of this class as a return value, the attribute will contain
This field is None if the cluster hosting this namespace uses
NSXT_CONTAINER_PLUGIN as its network provider.</p></li>
<li><p><strong>vm_service_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.VMServiceSpec</span></code></a>) – VM Service specification associated with the namespace. This
attribute was added in vSphere API 7.0.2.00100.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>creator</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Principal"title="com.vmware.vcenter.namespaces_client.Instances.Principal"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Principal</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Creator of the namespace. Namespace self-service uses this field to
populate the user who created this namespace. This attribute was
added in vSphere API 7.0.2.00100.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>self_service_namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate the self service namespace. This attribute was
added in vSphere API 7.0.2.00100.
If None, the namespace is not marked as self service namespace.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Message</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">severity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.Message"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.Message</span></code> class contains the information about the object
configuration.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity"title="com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Message.MessageSeverity</span></code></a>) – Type of the message.</p></li>
<li><p><strong>details</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details about the message.
If None, message details are not required for taking actions.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">MessageSeverity</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.namespaces_client.Instances.Message.MessageSeverity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.Message.MessageSeverity</span></code> class represents the severity of
the message.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MessageSeverity</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MessageSeverity(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm.</p>
<codeclass="sig-name descname"><spanclass="pre">INFO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MessageSeverity(string='INFO')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.INFO"title="Permalink to this definition">¶</a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event.</p>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MessageSeverity(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.Message.MessageSeverity.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Principal</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</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.namespaces_client.Instances.Principal"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.Principal</span></code> class contains the information about the
creator of namespace. This class was added in vSphere API 7.0.2.00100.</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>subject</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain of the subject. This attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.namespaces.Instance'</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SetSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_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">access_list</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_specs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vm_service_spec</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.namespaces_client.Instances.SetSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.SetSpec</span></code> class contains the specification required to set
a new configuration on the namespace. This class is applied in entirety,
replacing the current specification fully.</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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description for the namespace.
If None, the description of the namespace will be cleared.</p></li>
<li><p><strong>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource quota for the namespace. This will replace the existing
resource constraints on the namespace in entirety. Refer to
for retrieving the type for the value for this field. For an
example of this, see <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1</span></code></a>.
If None, the resource constraints on the namespace will be cleared.</p></li>
<li><p><strong>access_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Access"title="com.vmware.vcenter.namespaces_client.Instances.Access"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Access</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Access control associated with the namespace.
If None, the existing access controls on the namespace will be
removed and users will not be able to access this namespace to
create new pods. Existing pods from users will continue to run.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage associated with the namespace.
If None, the existing storage policies will be disassociated with
the namespace and existing limits will be cleared. Pods which are
already using persistent storage from the earlier version of
storage policies will be able to access them till the datastores
are attached to the worker nodes.</p></li>
<li><p><strong>vm_service_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.VMServiceSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VM Service specification associated with the namespace. This
attribute was added in vSphere API 7.0.2.00100.
This attribute is optional because it was added in a newer version
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Stats</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_used</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_used</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_used</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.namespaces_client.Instances.Stats"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.Stats</span></code> class contains the basic runtime statistics about
the namespace.</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>cpu_used</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall CPU usage of the namespace, in MHz. This is the sum of CPU
usage across all pods in the Kubernetes namespace.</p></li>
<li><p><strong>memory_used</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall memory usage of the namespace (in mebibytes). This is the
sum of memory usage across all pods.</p></li>
<li><p><strong>storage_used</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall storage used by the namespace (in mebibytes). This is the
sum of storage used by pods across all datastores in the cluster
associated with storage policies configured for the namespace.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StorageSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">limit</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.namespaces_client.Instances.StorageSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code> class contains the specification required to
configure storage associated with a namespace. Information in this class
will result in storage quotas on the Kubernetes namespace.</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>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID of the storage policy. A Kubernetes storage class is created for
this storage policy if it does not exist already.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">SpsStorageProfile</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
<li><p><strong>limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The maximum amount of storage (in mebibytes) which can be utilized
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">config_status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">stats</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">self_service_namespace</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.namespaces_client.Instances.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the namespace.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster hosting the namespace.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>config_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.ConfigStatus"title="com.vmware.vcenter.namespaces_client.Instances.ConfigStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.ConfigStatus</span></code></a>) – Current setting for <codeclass="docutils literal notranslate"><spanclass="pre">Instances.ConfigStatus</span></code>.</p></li>
<li><p><strong>stats</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Stats"title="com.vmware.vcenter.namespaces_client.Instances.Stats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Stats</span></code></a>) – Basic runtime statistics for the namespace.</p></li>
<li><p><strong>self_service_namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate the self service namespace. This attribute was
added in vSphere API 7.0.2.00100.
If None, the namespace is not marked as self service namespace.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_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">access_list</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_specs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vm_service_spec</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.namespaces_client.Instances.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.UpdateSpec</span></code> class contains the specification required to
update the configuration on the namespace. This class is applied partially,
and only the specified fields will replace or modify their existing
counterparts.</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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description for the namespace.
If None, the description of the namespace will not be modified.</p></li>
<li><p><strong>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource quota updates on the namespace. Refer to
for retrieving the type for the value for this field. For an
example of this, see <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1Update"title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1Update"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update</span></code></a>.
If None, the resource constraints on the namespace will not be
modified.</p></li>
<li><p><strong>access_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Access"title="com.vmware.vcenter.namespaces_client.Instances.Access"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Access</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Access control associated with the namespace.
If None, access controls on the namespace will not be modified.
Existing pods from users will continue to run.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage associated with the namespace.
If None, storage policies and their limit will not be modified.
Pods which are already using persistent storage from the earlier
version of storage policies will be able to access them till the
datastores are attached to the worker nodes.</p></li>
<li><p><strong>vm_service_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"title="com.vmware.vcenter.namespaces_client.Instances.VMServiceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.VMServiceSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VM Service specification associated with the namespace. This
attribute was added in vSphere API 7.0.2.00100.
This attribute is optional because it was added in a newer version
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VMServiceSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">content_libraries</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vm_classes</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.namespaces_client.Instances.VMServiceSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Instances.VMServiceSpec</span></code> class contains the specification required
to configure the VM Service specification associated with a namespace.</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>content_libraries</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Set of content libraries for use by the VM Service. The content
libraries specified should exist in vSphere inventory. This
attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>vm_classes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Set of VirtualMachineClasses for use by the VM Service. The class
names specified here should exist in vSphere inventory. If this
field is empty in an updated specification, all
VirtualMachineClasses that are currently associated with the
namespace will be disassociated from it.</p>
<p><strong>NOTE:</strong> Any change in virtual machine classes associated with the
namespace will not impact existing VMs.. This attribute was added
in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="sig-name descname"><spanclass="pre">create</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.namespaces_client.Instances.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Create namespace object in the cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.CreateSpec"title="com.vmware.vcenter.namespaces_client.Instances.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.CreateSpec</span></code></a>) – Specification for setting up the namespace.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete the namespace object in the cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a specific namespace.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the information about all namespaces on this vCenter.</p>
<codeclass="sig-name descname"><spanclass="pre">set</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Set a new configuration on the namespace object. The specified
configuration is applied in entirety and will replace the current
configuration fully.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.SetSpec"title="com.vmware.vcenter.namespaces_client.Instances.SetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.SetSpec</span></code></a>) – New specification for the namespace.</p></li>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.Instances.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Update the namespace object. The specified configuration is applied
partially and None fields in <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> will leave those parts of
configuration as-is.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the namespace.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespaces_client.</span></code><codeclass="sig-name descname"><spanclass="pre">NamespaceSelfService</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.namespaces_client.NamespaceSelfService"title="Permalink to this definition">¶</a></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">ActivateTemplateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">template</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_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">storage_specs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">networks</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.namespaces_client.NamespaceSelfService.ActivateTemplateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceSelfService.ActivateTemplateSpec</span></code> class contains the
specification required to create or update namespace template. The create
or update template operations are combined with service activation in a
single operation. This class was added in vSphere API 7.0.2.00100.</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>template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – This attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NamespaceTemplates.Subject</span></code></a>) – Namespace Self Service permission to subjects. This attribute was
added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code>) – Resource quotas that the template defines. Resource quota on the
for retrieving the type for the value for this field. For an
example of this, see <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1</span></code></a>. This
attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a>) – Storage associated with the self service namespace. This attribute
was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere Namespaces network objects to be associated with the
namespace. The values of this list need to reference names of
pre-existing <codeclass="docutils literal notranslate"><spanclass="pre">Networks.Info</span></code> classs. This attribute was added in
vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
The field must be left None if the cluster hosting the namespace
uses NSXT_CONTAINER_PLUGIN as the network provider, since the
network(s) for this namespace will be managed by NSX-T Container
Plugin. If field is None when the cluster hosting the namespace
uses VSPHERE_NETWORK as its network provider, the namespace will
automatically be associated with the cluster’s Supervisor Primary
Workload Network. The field currently accepts at most only 1
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Capability</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.namespaces_client.NamespaceSelfService.Capability"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceSelfService.Capability</span></code> class describes the self-service
namespace capability of the cluster on which vSphere Namespaces enabled.
This enumeration was added in vSphere API 7.0.2.00100.</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">Capability</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">NOTSUPPORTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Capability(string='NOTSUPPORTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.NOTSUPPORTED"title="Permalink to this definition">¶</a></dt>
<dd><p>The value that indicates the cluster doesn’t support the self-service
namespace capability. The expected transition UNKNOWN –> NOTSUPPORTED.
This class attribute was added in vSphere API 7.0.2.00100.</p>
<codeclass="sig-name descname"><spanclass="pre">SUPPORTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Capability(string='SUPPORTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.SUPPORTED"title="Permalink to this definition">¶</a></dt>
<dd><p>The value that indicates the cluster supports self-service namespace
capability. The expected transition UNKNOWN –> SUPPORTED. This class
attribute was added in vSphere API 7.0.2.00100.</p>
<codeclass="sig-name descname"><spanclass="pre">UNKNOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Capability(string='UNKNOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>The initial value that represents the in-progress activity of determining
the cluster’s self-service namespace capability. This class attribute was
<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">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceSelfService.Info</span></code> class contains detailed information about
the namespace self service. This class was added in vSphere API
7.0.2.00100.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster to which namespace service is
associated. This attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>capability</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability"title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NamespaceSelfService.Capability</span></code></a>) – The self-service namespace capability of the cluster with vSphere
Namespaces enabled. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status"title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NamespaceSelfService.Status</span></code></a>) – The current status of the namespace-self-service. This attribute
was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>messages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.Message"title="com.vmware.vcenter.namespaces_client.Instances.Message"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.Message</span></code></a>) – Current set of messages associated with the object. This attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Status</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.namespaces_client.NamespaceSelfService.Status"title="Permalink to this definition">¶</a></dt>
<p>The page describes the status of the namespace self-service on the cluster
on which vSphere Namespaces enabled. This enumeration was added in vSphere
API 7.0.2.00100.</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">Status</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CONFIGURING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='CONFIGURING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.CONFIGURING"title="Permalink to this definition">¶</a></dt>
<dd><p>The configuration is being applied to the service. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">DEACTIVATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='DEACTIVATED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.DEACTIVATED"title="Permalink to this definition">¶</a></dt>
<dd><p>The namespace self service is deactivated. This status also represents the
initial status of the service before activation. The expected transitions
after the service is activated: 1. CONFIGURING –> RUNNING –> REMOVING –>
DEACTIVATED 2. CONFIGURING –> REMOVING –> DEACTIVATED. This class
attribute was added in vSphere API 7.0.2.00100.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Failed to apply the configuration to the namespace self-service or unable
to deactivate the namespace self-service, user intervention needed. The
<codeclass="sig-name descname"><spanclass="pre">REMOVING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='REMOVING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.REMOVING"title="Permalink to this definition">¶</a></dt>
<dd><p>The configuration is being removed and service is being deleted. The
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The namespace self service is configured correctly. The expected
transitions: 1. CONFIGURING –> RUNNING 2. RUNNING –> CONFIGURING. This
transition occurs in the below scenarios: a. When different Dev
Users/Groups are empowered with self-service namespace access. b. To
reconcile the state of the cluster after the cluster upgrade. This class
attribute was added in vSphere API 7.0.2.00100.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capability</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceSelfService.Summary</span></code> class contains basic information about
the namespace service. This class was added in vSphere API 7.0.2.00100.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster to which namespace service is
associated. This attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>capability</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability"title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Capability"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NamespaceSelfService.Capability</span></code></a>) – The self-service namespace capability of the cluster with vSphere
Namespaces enabled. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status"title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NamespaceSelfService.Status</span></code></a>) – The current status of the namespace-self-service. This attribute
<codeclass="sig-name descname"><spanclass="pre">activate</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.activate"title="Permalink to this definition">¶</a></dt>
<dd><p>Activate Namespace Self Service on the cluster on which vSphere
Namespaces enabled. This operation empowers Dev Users/Groups as
self-service namespace users to create Supervisor Namespaces through
kubectl create namespace command. activate requires the availability of
one or more templates in the system. This method was added in vSphere
API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces will be
enabled.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">activate_with_template</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.activate_with_template"title="Permalink to this definition">¶</a></dt>
<dd><p>Activate Namespace Self Service on the cluster after configuring
namespace template. This is another variant of activate except
configures template before activation. The template configuration
includes either creating a new template or updating the existing
template, depending on the template’s existence. Here is supported the
flow of actions using the activateWithTemplate call: 1. Activate with
the new template using activateWithTemplate call. 2. Deactivate using
deactivate call. 3. Active with updating the existing template using
activateWithTemplate. This method was added in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces will be
enabled.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.ActivateTemplateSpec"title="com.vmware.vcenter.namespaces_client.NamespaceSelfService.ActivateTemplateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NamespaceSelfService.ActivateTemplateSpec</span></code></a>) – Specification for activating namespace self service on the cluster
by granting users/groups to create Supervisor Namespaces.</p></li>
<codeclass="sig-name descname"><spanclass="pre">deactivate</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.deactivate"title="Permalink to this definition">¶</a></dt>
<dd><p>Deactivate Namespace Self Service on the cluster on which vSphere
Namespaces enabled. This operation reverses Dev Users/Group’s
self-service namespace capability on the cluster. This method was added
in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster for which vSphere Namespaces will be
disabled.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about Namespace Self Service of a specific cluster.
This method was added in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceSelfService.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns basic information about Namespace Self Service on all clusters
on which vSphere Namespaces are enabled on this vCenter. This method
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespaces_client.</span></code><codeclass="sig-name descname"><spanclass="pre">NamespaceTemplates</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.namespaces_client.NamespaceTemplates"title="Permalink to this definition">¶</a></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">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">template</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_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">storage_specs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">networks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.namespaces_client.NamespaceTemplates.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceTemplates.CreateSpec</span></code> class contains the specification
required to create namespace template. This class was added in vSphere API
7.0.2.00100.</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>template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the namespace template. The name is unique within the
cluster. This attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code>) – Resource quotas that this template defines. Resource quota on the
for retrieving the type for the value for this field. For an
example of this, see <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1</span></code></a>. This
attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a>) – Storage that this template defines and will be associated with a
namespace after namespace realization. This field should not be
empty and at least one policy should be supplied. The {link create}
throws {term InvalidArgument} exception if this field is set empty.
This attribute was added in vSphere API 7.0.2.00100.</p></li>
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere Networks that this template captures and are associated
with the namespace after namespace realization. vSphere Namespaces
network objects to be associated with the namespace. The values of
this list need to reference names of pre-existing <codeclass="docutils literal notranslate"><spanclass="pre">Networks.Info</span></code>
classs. This attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
The field must be left None if the cluster hosting the namespace
uses NSXT_CONTAINER_PLUGIN as the network provider, since the
network(s) for this namespace will be managed by NSX-T Container
Plugin. If field is None when the cluster hosting the namespace
uses VSPHERE_NETWORK as its network provider, the namespace will
automatically be associated with the cluster’s Supervisor Primary
Workload Network. The field currently accepts at most only 1
<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">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">template</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_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">storage_specs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">networks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.namespaces_client.NamespaceTemplates.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceTemplates.Info</span></code> class contains detailed information about
the namespace template. This class was added in vSphere API 7.0.2.00100.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster associated with namespace template. This
attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the namespace template. This attribute was added in vSphere
API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource quotas that this template defines. Quotas on the namespace
for the type of the value for this field. This attribute was added
in vSphere API 7.0.2.00100.
If None, no resource constraints are defined in the namespace
template.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a>) – Storage that this template defines and will be associated with a
namespace after namespace realization. This attribute was added in
vSphere API 7.0.2.00100.</p></li>
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere Networks that this template captures and are associated
with the namespace after namespace realization. This attribute was
added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
This field is None if the cluster hosting this namespace uses
NSXT_CONTAINER_PLUGIN as its network provider.</p></li>
<li><p><strong>permissions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"title="com.vmware.vcenter.namespaces_client.NamespaceTemplates.Subject"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NamespaceTemplates.Subject</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Permissions associated with namespace template. This attribute was
added in vSphere API 7.0.2.00100.
If None, only users with the Administrator role can use this
template; for example, this template is applied to the namespace
created by self-service-users with the Administrator role.</p></li>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.namespaces.NamespaceTemplate'</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>The resource type for namespace template. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Subject</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">subject_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</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.namespaces_client.NamespaceTemplates.Subject"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TemplateSubject</span></code> class contains the user or group information
granted for namespace self service. This class was added in vSphere API
7.0.2.00100.</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>subject_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Access.SubjectType"title="com.vmware.vcenter.namespaces_client.Access.SubjectType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Access.SubjectType</span></code></a>) – Type of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>subject</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the subject. This attribute was added in vSphere API
7.0.2.00100.</p></li>
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain of the subject. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">template</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.namespaces_client.NamespaceTemplates.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceTemplates.Summary</span></code> class contains basic information about
the namespace template. This class was added in vSphere API 7.0.2.00100.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster associated with namespace template. This
attribute was added in vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the namespace template. This attribute was added in vSphere
API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.namespaces.NamespaceTemplate</span></code>. When methods
return a value of this class as a return value, the attribute will
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">resource_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">storage_specs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">networks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">permissions</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.namespaces_client.NamespaceTemplates.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NamespaceTemplates.UpdateSpec</span></code> class contains the specification
required to update a namespace namespace template. This class was added in
vSphere API 7.0.2.00100.</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>resource_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource quota on the namespace. Refer to
for retrieving the type for the value for this field. For an
example of this, see <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"title="com.vmware.vcenter.namespaces_client.ResourceQuotaOptionsV1"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1</span></code></a>. This
attribute was added in vSphere API 7.0.2.00100.
If None, no resource limits will be set on the namespace.</p></li>
<li><p><strong>storage_specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespaces_client.Instances.StorageSpec"title="com.vmware.vcenter.namespaces_client.Instances.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Instances.StorageSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage that this template defines and will be associated with a
namespace after namespace realization. This attribute was added in
vSphere API 7.0.2.00100.</p></li>
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere Namespaces network objects to be associated with the
namespace. The values of this list need to reference names of
pre-existing <codeclass="docutils literal notranslate"><spanclass="pre">Networks.Info</span></code> classs. This attribute was added in
vSphere API 7.0.2.00100.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
The field must be left None if the cluster hosting the namespace
uses NSXT_CONTAINER_PLUGIN as the network provider, since the
network(s) for this namespace will be managed by NSX-T Container
Plugin. If field is None when the cluster hosting the namespace
uses VSPHERE_NETWORK as its network provider, the namespace will
automatically be associated with the cluster’s Supervisor Primary
Workload Network. The field currently accepts at most only 1
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a namespace template on a cluster on which vSphere Namespaces
are enabled on this vCenter. This release supports creating a single
namespace template, and the call fails if there is a request to make
another one. This method was added in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">template</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the information about a namespace template on given cluster. This
method was added in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<li><p><strong>template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the namespace template.
The parameter must be an identifier for the resource type:
if <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> doesn’t exist or if <codeclass="docutils literal notranslate"><spanclass="pre">template</span></code> doesn’t exist.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about all the namespace templates associated with a
cluster on which vSphere Namespaces are enabled on this vCenter. This
method was added in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">template</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespaces_client.NamespaceTemplates.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates a namespace template associated with a cluster on which vSphere
Namespaces are enabled on this vCenter. The specified configuration is
applied partially and None fields in <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> will leave those parts of
configuration as-is. This method was added in vSphere API 7.0.2.00100.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster on which vSphere Namespaces are enabled.
The parameter must be an identifier for the resource type:
<li><p><strong>template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the namespace template.
The parameter must be an identifier for the resource type:
if <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> doesn’t exist or if <codeclass="docutils literal notranslate"><spanclass="pre">template</span></code> doesn’t exist.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1</span></code> class represents the resource quota limits
which can be applied on the namespace. Refer to `
<<aclass="reference external"href="https://kubernetes.io/docs/concepts/policy/resource-quotas">https://kubernetes.io/docs/concepts/policy/resource-quotas</a>>`_ for
information related to the properties of this object and what they map to.</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>memory_limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This is equivalent to ‘limits.memory’ option which is the maximum
memory limit (in mebibytes) across all pods which exist in a
non-terminal state in the namespace. This value translates to the
memory limit on the ResourcePool in vCenter Server created for the
namespace.
If None, no memory limits are set on the ResourcePool for the
namespace.</p></li>
<li><p><strong>memory_limit_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the default memory limit (in mebibytes) for
containers in the pod. This translates to default memory limit in a
LimitRange object. Refer ` for information about LimitRange.
If None, no default memory limits are set on containers in the pod.</p></li>
<li><p><strong>memory_request_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the default memory request (in mebibytes) for
containers in the pod. This translates to default memory request in
a LimitRange object. Refer ` for information about LimitRange.
If None, no default memory requests are set on containers in the
pod.</p></li>
<li><p><strong>cpu_limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This is equivalent to ‘limits.cpu’ option which is the maximum CPU
limit (in MHz) across all pods which exist in a non-terminal state
in the namespace. If specified, this limit should be at least 10
MHz. This value translates to the CPU limit on the ResourcePool in
vCenter Server created for the namespace.
If None, no CPU limits are set on the ResourcePool for the
namespace.</p></li>
<li><p><strong>cpu_limit_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the default cpu limit (in MHz) for containers in
the pod.
If None, no default CPU limits are set on containers in the pod.
Refer ` for information about LimitRange. If specified, this limit
<li><p><strong>cpu_request_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the default CPU request (in MHz) for containers in
the pod.
If None, no default CPU requests are set on containers in the pod.
Refer ` for information about LimitRange. If specified, this field
<li><p><strong>storage_request_limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘requests.storage’ option which is the maximum
storage request (in mebibytes) across all persistent volume claims
from pods which exist in a non-terminal state in the namespace.
If None, no storage request limits are set on the namespace.</p></li>
<li><p><strong>pod_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘pods’ option which is the maximum number of pods
which exist in a non-terminal state in the namespace.
If None, no pod limits are set on the namespace.</p></li>
<li><p><strong>service_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/services’ option which is the maximum number
of services in the namespace.
If None, no service limits are set on the namespace.</p></li>
<li><p><strong>deployment_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/deployments.apps’ option which is the
maximum number of deployments in the namespace.
If None, no deployment limits are set on the namespace.</p></li>
<li><p><strong>daemon_set_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/daemonsets.apps’ option which is the maximum
number of DaemonSets in the namespace.
If None, no daemonset limits are set on the namespace.</p></li>
<li><p><strong>replica_set_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/replicasets.apps’ option which is the
maximum number of ReplicaSets in the namespace.
If None, no replicaset limits are set on the namespace.</p></li>
<li><p><strong>replication_controller_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/replicationcontrollers’ option which is the
maximum number of ReplicationControllers in the namespace.
If None, no replicationcontroller limits are set on the namespace.</p></li>
<li><p><strong>stateful_set_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/statefulsets.apps’ option which is the
maximum number of StatefulSets in the namespace.
If None, no statefulset limits are set on the namespace.</p></li>
<li><p><strong>config_map_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/configmaps’ option which is the maximum
number of ConfigMaps in the namespace.
If None, no configmap limits are set on the namespace.</p></li>
<li><p><strong>secret_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/secrets’ option which is the maximum number
of secrets in the namespace.
If None, no secret limits are set on the namespace.</p></li>
<li><p><strong>persistent_volume_claim_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/persistentvolumeclaims’ option which is the
maximum number of PersistentVolumeClaims in the namespace.
If None, no persistentvolumeclaim limits are set on the namespace.</p></li>
<li><p><strong>job_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents ‘count/jobs.batch’ option which is the maximum
number jobs in the namespace.
If None, no job limits are set on the namespace.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update</span></code> class represents the changes to
resource quota limits which are set on the namespace. Refer to ` <>
Kubernetes Resource Quota
<<aclass="reference external"href="https://kubernetes.io/docs/concepts/policy/resource-quotas">https://kubernetes.io/docs/concepts/policy/resource-quotas</a>>`_ for
information related to the properties of this object and what they map to.</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>memory_limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘limits.memory’ option which is
equivalent to the maximum memory limit (in mebibytes) across all
pods in the namespace. This field is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit_unset</span></code> is set to
If None, the existing memory limit on the ResourcePool will be
unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit_unset</span></code> is None or
set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>memory_limit_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>. If this field is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing memory limit on the ResourcePool is
removed. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing memory
limit will be changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>, if any.
If None, the existing memory limit will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>, if
any.</p></li>
<li><p><strong>memory_limit_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for the default memory limit (in
mebibytes) for containers in the pod. This field is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit_default_unset</span></code> is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing memory limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit_default_unset</span></code> is
None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>memory_limit_default_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit_default</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing default memory limit on
containers in the pod is removed. If this field is set to
<codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing default memory limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit_default</span></code>, if any.
If None, the existing default memory limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit_default</span></code>, if any.</p></li>
<li><p><strong>memory_request_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for the default memory request (in
mebibytes) for containers in the pod. This field is ignored if
is None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>memory_request_default_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_request_default</span></code>. If
this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing default memory request
on containers in the pod will be removed. If this field is set to
<codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing default memory request will be changed to
the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_request_default</span></code>, if
any.
If None, the existing default memory request will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_request_default</span></code>, if
any.</p></li>
<li><p><strong>cpu_limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘limits.cpu’ option which is
equivalent to the maximum CPU limit (in MHz) across all pods in the
namespace. This field is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit_unset</span></code> is set to
<codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. If specified, this limit should be at least 10 MHz.
If None, the existing CPU limit on the ResourcePool will be
unchanged if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit_unset</span></code>
is None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>cpu_limit_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit</span></code>. If this field is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing CPU limit on the ResourcePool is
removed. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing CPU limit
will be changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit</span></code>, if any.
If None, the existing CPU limit will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.memory_limit</span></code>, if
any.</p></li>
<li><p><strong>cpu_limit_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for the default CPU limit (in Mhz)
for containers in the pod. This field is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit_default_unset</span></code> is set
to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. If specified, this limit should be at least 10 MHz.
If None, the existing default CPU limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit_default_unset</span></code> is
None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>cpu_limit_default_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit_default</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing default CPU limit on
containers in the pod is removed. If this field is set to
<codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing default CPU limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit_default</span></code>, if any.
If None, the existing default CPU limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_limit_default</span></code>, if any.</p></li>
<li><p><strong>cpu_request_default</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for the default CPU request (in Mhz)
for containers in the pod. This field is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_request_default_unset</span></code> is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>. If specified, this field should be at least 10
MHz.
If None, the existing default CPU request will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_request_default_unset</span></code> is
None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>cpu_request_default_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_request_default</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing default CPU request on
containers in the pod is removed. If this field is set to
<codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing default CPU request will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_request_default</span></code>, if any.
If None, the existing default CPU request will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.cpu_request_default</span></code>, if any.</p></li>
<li><p><strong>storage_request_limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘requests.storage’ which is the
limit on storage requests (in mebibytes) across all persistent
volume claims from pods in the namespace. This field is ignored if
if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.storage_request_limit_unset</span></code>
is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing storage request limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.storage_request_limit_unset</span></code> is
None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>. the namespace.</p></li>
<li><p><strong>storage_request_limit_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.storage_request_limit</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing storage request limit will
be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing storage
request limit will be changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.storage_request_limit</span></code>, if any.
If None, the existing storage request limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.storage_request_limit</span></code>, if any.</p></li>
<li><p><strong>pod_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘podCount’ option which is the
maximum number of pods in the namespace. This field is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.pod_count_unset</span></code> is set to
If None, the existing ‘podCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.pod_count_unset</span></code> is None or set
to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>pod_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.pod_count</span></code>. If this field is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘podCount’ limit on the namespace
will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing CPU
limit will be changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.pod_count</span></code>, if any.
If None, the existing ‘podCount’ limit will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.pod_count</span></code>, if
any.</p></li>
<li><p><strong>service_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘serviceCount’ option which is
the maximum number of services in the namespace. This field is
ignored if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.service_count_unset</span></code>
is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing ‘serviceCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.service_count_unset</span></code> is None or
set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>service_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.service_count</span></code>. If this field
is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘serviceCount’ limit on the
namespace will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the
existing service count limit will be changed to the value specified
in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.service_count</span></code>, if any.
If None, the existing ‘serviceCount’ limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.service_count</span></code>, if any.</p></li>
<li><p><strong>deployment_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘deploymentCount’ option which is
the maximum number of deployments in the namespace. This field is
ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.deployment_count_unset</span></code> is set
to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing ‘deploymentCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.deployment_count_unset</span></code> is None
or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>deployment_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.deployment_count</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘deploymentCount’ limit on
the namespace will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the
existing deployment count limit will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.deployment_count</span></code>,
if any.
If None, the existing ‘deploymentCount’ limit will be changed to
the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.deployment_count</span></code>, if any.</p></li>
<li><p><strong>daemon_set_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘daemonSetCount’ option which is
the maximum number of DaemonSets in the namespace. This field is
ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.daemon_set_count_unset</span></code> is set
to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing ‘daemonSetCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.daemon_set_count_unset</span></code> is None
or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>daemon_set_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.daemon_set_count</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘daemonSetCount’ limit on
the namespace will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the
existing daemonset count limit will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.daemon_set_count</span></code>,
if any.
If None, the existing ‘daemonSetCount’ limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.daemon_set_count</span></code>, if any.</p></li>
<li><p><strong>replica_set_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘replicaSetCount’ option which is
the maximum number of ReplicaSets in the namespace. This field is
ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.replica_set_count_unset</span></code> is set
to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing ‘replicaSetCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.replica_set_count_unset</span></code> is
None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>replica_set_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.replica_set_count</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘replicaSetCount’ limit on
the namespace will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the
existing replicaset count limit will be changed to the value
specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.replica_set_count</span></code>, if any.
If None, the existing ‘replicaSetCount’ limit will be changed to
the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.replica_set_count</span></code>, if any.</p></li>
<li><p><strong>replication_controller_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘replicationControllerCount’
option which is the maximum number of ReplicationControllers in the
is None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>replication_controller_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<li><p><strong>stateful_set_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘statefulSetCount’ option which
is the maximum number of StatefulSets in the namespace. This field
is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.stateful_set_count_unset</span></code> is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing ‘statefulSetCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.stateful_set_count_unset</span></code> is
None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>stateful_set_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.stateful_set_count</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘statefulSetCount’ limit on
the namespace will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the
existing statefulset count limit will be changed to the value
specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.stateful_set_count</span></code>, if any.
If None, the existing ‘statefulSetCount’ limit will be changed to
the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.stateful_set_count</span></code>, if any.</p></li>
<li><p><strong>config_map_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘configMapCount’ option which is
the maximum number of ConfigMaps in the namespace. This field is
ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.config_map_count_unset</span></code> is set
to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing ‘configMapCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.config_map_count_unset</span></code> is None
or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>config_map_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.config_map_count</span></code>. If this
field is set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘configMapCount’ limit on
the namespace will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the
existing configmap count limit will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.config_map_count</span></code>,
if any.
If None, the existing ‘configMapCount’ limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.config_map_count</span></code>, if any.</p></li>
<li><p><strong>secret_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘secretCount’ option which is the
maximum number of secrets in the namespace. This field is ignored
if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.secret_count_unset</span></code> is set
to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>.
If None, the existing ‘secretCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.secret_count_unset</span></code> is None or
set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>secret_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.secret_count</span></code>. If this field is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘secretCount’ limit on the namespace
will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing
secret count limit will be changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.secret_count</span></code>, if any.
If None, the existing ‘secretCount’ limit will be changed to the
value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.secret_count</span></code>, if any.</p></li>
<li><p><strong>persistent_volume_claim_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘persistentVolumeClaimCount’
option which is the maximum number of PersistentVolumeClaims in the
is None or set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>persistent_volume_claim_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<li><p><strong>job_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the new value for ‘jobCount’ option which is the
maximum number of jobs in the namespace. This field is ignored if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.job_count_unset</span></code> is set to
If None, the existing ‘jobCount’ limit will be unchanged if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.job_count_unset</span></code> is None or set
to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>.</p></li>
<li><p><strong>job_count_unset</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This represents the intent of the change to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.job_count</span></code>. If this field is
set to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>, the existing ‘jobCount’ limit on the namespace
will be reset. If this field is set to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>, the existing
secret count limit will be changed to the value specified in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.job_count</span></code>, if any.
If None, the existing ‘jobCount’ limit will be changed to the value
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ResourceQuotaOptionsV1Update.job_count</span></code>, if
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespaces_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.namespaces_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-ovf-client-module"></span><h2>com.vmware.vcenter.ovf_client module<aclass="headerlink"href="#module-com.vmware.vcenter.ovf_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.ovf_client</span></code> module provides services to capture and
deploy Open Virtualization Format (OVF) packages to and from the content
library.</p>
<p>It provides the ability to deploy OVF packages from the content library with
support for advanced network topologies, network services, creating virtual
appliances and virtual machines in hosts, resource pools or clusters. It also
provides the ability to export virtual appliances and virtual machines from
hosts, resource pools or clusters as OVF packages to the content library.</p>
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>is_valid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is the certificate chain validated.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>is_self_signed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Is the certificate self-signed.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>x509</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The X509 representation of the certificate.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<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.vcenter.ovf_client.WarningInfo"title="com.vmware.vcenter.ovf_client.WarningInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WarningInfo</span></code></a>) – The list of warnings raised for the OVF certificate used in this
OVF package deployment. Any warning that is not ignored by the
client will cause the OVF package deployment to fail. This
attribute was added in vSphere API 7.0.2.0.
This attribute is set only if the certificate has warnings when
retrieving information about an OVF package by
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.filter()</span></code></a>. When the attribute is set, the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">WarningInfo.ignored</span></code> attribute can be updated before the OVF
parameter is passed to <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a> to deploy the OVF
package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DeploymentOption</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_choice</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.ovf_client.DeploymentOption"title="Permalink to this definition">¶</a></dt>
<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>key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The key of the deployment option, corresponding to the ovf:id
attribute in the OVF descriptor.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A localizable label for the deployment option.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A localizable description for the deployment option.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>default_choice</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – A <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> flag indicates whether this deployment option is
the default choice.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. If None or false, it
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DeploymentOptionParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">deployment_options</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">selected_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.DeploymentOptionParams"title="Permalink to this definition">¶</a></dt>
<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>deployment_options</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DeploymentOption"title="com.vmware.vcenter.ovf_client.DeploymentOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption</span></code></a>) –<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of deployment options. This attribute corresponds to
the ovf:Configuration elements of the ovf:DeploymentOptionSection
in the specification. It is a discrete set of intended resource
allocation configurations from which one can be selected.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>selected_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The selected deployment option. Identifies the
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DeploymentOption"title="com.vmware.vcenter.ovf_client.DeploymentOption"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentOption</span></code></a> in the list in the <codeclass="docutils literal notranslate"><spanclass="pre">deploymentOptions</span></code>
attribute with a matching value in the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">DeploymentOption.key</span></code>
attribute.
This attribute is optional in the input parameters when deploying
an OVF package. If None the server will use the default deployment
This attribute is optional in the result when retrieving
information about an OVF package. The value will be set only if it
is specified with the optional ovf:default attribute.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DiskProvisioningType</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.ovf_client.DiskProvisioningType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code> class defines the virtual disk provisioning
types that can be set for a disk on the target platform.</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 <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType"title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">eagerZeroedThick</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DiskProvisioningType(string='eagerZeroedThick')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.eagerZeroedThick"title="Permalink to this definition">¶</a></dt>
<dd><p>An eager zeroed thick provisioned virtual disk has all space allocated and
wiped clean of any previous contents on the physical media at creation
time.</p>
<p>Disks specified as eager zeroed thick may take longer time to create than
disks specified with the other disk provisioning types.</p>
<codeclass="sig-name descname"><spanclass="pre">thick</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DiskProvisioningType(string='thick')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thick"title="Permalink to this definition">¶</a></dt>
<dd><p>A thick provisioned virtual disk has all space allocated at creation time
and the space is zeroed on demand as the space is used.</p>
<codeclass="sig-name descname"><spanclass="pre">thin</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DiskProvisioningType(string='thin')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType.thin"title="Permalink to this definition">¶</a></dt>
<dd><p>A thin provisioned virtual disk has space allocated and zeroed on demand as
the space is used.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.ExportFlag">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ExportFlag</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.ovf_client.ExportFlag"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ExportFlag</span></code> class provides methods for retrieving information about
the export flags supported by the server. Export flags can be specified in
a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code></a> to customize an OVF export.</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">option</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</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.ovf_client.ExportFlag.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ExportFlag.Info</span></code> class describes an export flag supported by the
server.</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>option</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the export flag that is supported by the server.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable description of the export flag.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ExportFlag.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the supported export flags by the server.</p>
<blockquote>
<div><p>The supported flags are:</p>
</div></blockquote>
<dl>
<dt>PRESERVE_MAC</dt><dd><p>Include MAC addresses for network adapters.</p>
</dd>
<dt>EXTRA_CONFIG</dt><dd><blockquote>
<div><p>Include extra configuration in OVF export.</p>
</div></blockquote>
<p>Future server versions might support additional flags.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ExtraConfig</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">virtual_system_id</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.ovf_client.ExtraConfig"title="Permalink to this definition">¶</a></dt>
<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>key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The key of the ExtraConfig element.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of the ExtraConfig element.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>virtual_system_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual system containing the vmw:ExtraConfig
element.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ExtraConfigParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">extra_configs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">exclude_keys</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">include_keys</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.ExtraConfigParams"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ExtraConfigParams</span></code> class contains the parameters with information
about the vmw:ExtraConfig elements in an OVF package.</p>
<p>vmw:ExtraConfig elements can be used to specify configuration settings that
are transferred directly to the <codeclass="docutils literal notranslate"><spanclass="pre">.vmx</span></code> file.</p>
<p>The behavior of the vmw:ExtraConfig element is similar to the
<codeclass="docutils literal notranslate"><spanclass="pre">extraConfig</span></code> property of the <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineConfigSpec</span></code> object in the
VMware vSphere API. Thus, the same restrictions apply, such as you cannot
set values that could otherwise be set with other properties in the
<codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachineConfigSpec</span></code> object. See the VMware vSphere API reference
<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>extra_configs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ExtraConfig"title="com.vmware.vcenter.ovf_client.ExtraConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExtraConfig</span></code></a>) –<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of vmw:ExtraConfig elements in the OVF package.
This attribute is optional in the input parameters when deploying
an OVF package. If None there are no extra configuration elements
to use for this OVF package deployment. This attribute will always
be present in the result when retrieving information about an OVF
package. It will be an empty <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> if there are no extra
configuration elements in the OVF package.</p></li>
<li><p><strong>exclude_keys</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Specifies which extra configuration items in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> in
the <codeclass="docutils literal notranslate"><spanclass="pre">extraConfigs</span></code><codeclass="docutils literal notranslate"><spanclass="pre">field</span></code> should be ignored during deployment.</p>
<p>If set, the given keys for extra configurations will be ignored
<li><p><strong>include_keys</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Specifies which extra configuration items in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> in
the <codeclass="docutils literal notranslate"><spanclass="pre">extraConfigs</span></code><codeclass="docutils literal notranslate"><spanclass="pre">field</span></code> should be included during
deployment.</p>
<p>If set, all but the given keys for extra configurations will be
ignored during deployment. The key is defined in the
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.ImportFlag">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ImportFlag</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.ovf_client.ImportFlag"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImportFlag</span></code> class provides methods for retrieving information about
the import flags supported by the deployment platform. Import flags can be
specified in a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to customize
an OVF deployment.</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">option</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</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.ovf_client.ImportFlag.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImportFlag.Info</span></code> class describes an import flag supported by the
deployment platform.</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>option</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the import flag that is supported by the deployment
platform.</p></li>
<li><p><strong>description</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable description of the import flag.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">rp</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ImportFlag.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the import flags supported by the deployment
platform.</p>
<blockquote>
<div><p>The supported flags are:</p>
</div></blockquote>
<dl>
<dt>LAX</dt><dd><blockquote>
<div><p>Lax mode parsing of the OVF descriptor.</p>
</div></blockquote>
<p>Future server versions might support additional flags.</p>
</dd>
</dl>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>rp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of resource pool target for retrieving the import
flag(s).
The parameter must be an identifier for the resource type:
<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>supported_allocation_scheme</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationScheme</span></code></a>) – Specifies the IP allocation schemes supported by the guest
software. This attribute defines the valid values for the IP
allocation policy. This setting is often configured by the virtual
appliance template author or OVF package author to reflect what the
guest software supports, and the IP allocation policy is configured
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>supported_ip_allocation_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationPolicy</span></code></a>) – Specifies the IP allocation policies supported. The set of valid
options for the policy is based on the capabilities of the virtual
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>ip_allocation_policy</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationPolicy</span></code></a>) – Specifies how IP allocation is done through an IP Pool. This is
typically specified by the deployer.
This attribute is optional in the input parameters when deploying
an OVF package. If None there is no IP allocation policy. This
attribute will always be present in the result when retrieving
information about an OVF package.</p></li>
<li><p><strong>supported_ip_protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpProtocol</span></code></a>) – Specifies the IP protocols supported by the guest.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>ip_protocol</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"title="com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpProtocol</span></code></a>) – Specifies the chosen IP protocol for this deployment. This must be
one of the IP protocols supported by the guest software. See
This attribute is optional in the input parameters when deploying
an OVF package. If None there is no IP protocol chosen. This
attribute will always be present in the result when retrieving
information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">IpAllocationPolicy</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.ovf_client.IpAllocationParams.IpAllocationPolicy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationPolicy</span></code> class defines the possible IP
allocation policy for a deployment.</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">IpAllocationPolicy</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DHCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpAllocationPolicy(string='DHCP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that DHCP will be used to allocate IP addresses.</p>
<codeclass="sig-name descname"><spanclass="pre">STATIC_IPPOOL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpAllocationPolicy(string='STATIC_IPPOOL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_IPPOOL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that IP addresses are allocated from the range managed by an IP
pool. The IP addresses are allocated at first power-on, and remain
allocated at power-off. This ensures that a virtual appliance gets a
<codeclass="sig-name descname"><spanclass="pre">STATIC_MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpAllocationPolicy(string='STATIC_MANUAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.STATIC_MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that IP addresses are configured manually upon deployment, and
will be kept until reconfigured or the virtual appliance destroyed. This
ensures that a property gets a consistent IP for its lifetime.</p>
<codeclass="sig-name descname"><spanclass="pre">TRANSIENT_IPPOOL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpAllocationPolicy(string='TRANSIENT_IPPOOL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationPolicy.TRANSIENT_IPPOOL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that IP addresses are allocated from an IP pool. The IP addresses
are allocated when needed, typically at power-on, and deallocated during
power-off. There is no guarantee that a property will receive same IP
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">IpAllocationScheme</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.ovf_client.IpAllocationParams.IpAllocationScheme"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpAllocationScheme</span></code> class defines the possible IP
allocation schemes that can be supported by the guest software.</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">IpAllocationScheme</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DHCP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpAllocationScheme(string='DHCP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.DHCP"title="Permalink to this definition">¶</a></dt>
<dd><p>It supports DHCP to acquire IP configuration.</p>
<codeclass="sig-name descname"><spanclass="pre">OVF_ENVIRONMENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpAllocationScheme(string='OVF_ENVIRONMENT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpAllocationScheme.OVF_ENVIRONMENT"title="Permalink to this definition">¶</a></dt>
<dd><p>It supports setting the IP configuration through the properties provided in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">IpProtocol</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.ovf_client.IpAllocationParams.IpProtocol"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpAllocationParams.IpProtocol</span></code> class defines the IP protocols
supported by the guest software.</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">IpProtocol</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">IPV4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpProtocol(string='IPV4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV4"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">IPV6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpProtocol(string='IPV6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.IpAllocationParams.IpProtocol.IPV6"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LibraryItem</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.ovf_client.LibraryItem"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem</span></code> class provides methods to deploy virtual machines and
virtual appliances from library items containing Open Virtualization Format
(OVF) packages in content library, as well as methods to create library
items in content library from virtual machines and virtual appliances.</p>
<blockquote>
<div><p>To deploy a virtual machine or a virtual appliance from a library item:</p>
</div></blockquote>
<olclass="arabic simple">
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget</span></code></a> to specify the target
deployment type and target deployment designation.</p></li>
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a> to specify the
parameters for the target deployment.</p></li>
<li><p>Use the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method with the created target and parameter
specifications, along with the identifier of the specified source content
library item. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a>.</p></li>
</ol>
<p>To create a library item in content library from a virtual machine or
virtual appliance:</p>
<olclass="arabic simple">
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code></a> to specify the source
virtual machine or virtual appliance to be used as the OVF template source.</p></li>
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateTarget</span></code></a> to specify the target library
and library item.</p></li>
<li><p>Create a <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code></a> to specify the settings for the
OVF package to be created.</p></li>
<li><p>Use the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method with the created target and parameter
specifications, along with the specified source entity. See
<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">CreateResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">succeeded</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ovf_library_item_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">error</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.ovf_client.LibraryItem.CreateResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.CreateResult</span></code> class defines the result of the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code>
method. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.create"title="com.vmware.vcenter.ovf_client.LibraryItem.create"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.create()</span></code></a>.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
<li><p><strong>ovf_library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the created or updated library item.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
If None, the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method failed and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.CreateResult.error</span></code> will describe the error(s)
that caused the failure.</p></li>
<li><p><strong>error</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResultInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Errors, warnings, and informational messages produced by the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">flags</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.ovf_client.LibraryItem.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code> class defines the information used to create
or update a library item containing an OVF package.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name to use in the OVF descriptor stored in the library item.
If None, the server will use source’s current name.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description to use in the OVF descriptor stored in the library
item.
If None, the server will use source’s current annotation.</p></li>
<li><p><strong>flags</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flags to use for OVF package creation. The supported flags can be
obtained using <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ExportFlag.list"title="com.vmware.vcenter.ovf_client.ExportFlag.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ExportFlag.list()</span></code></a>.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateTarget</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">library_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">library_item_id</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.ovf_client.LibraryItem.CreateTarget"title="Permalink to this definition">¶</a></dt>
<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>library_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier of the library in which a new library item should be
created. This attribute is not used if the <codeclass="docutils literal notranslate"><spanclass="pre">libraryItemId</span></code>
attribute is specified.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.
This attribute is currently required.</p>
<p>In the future, if None, the <codeclass="docutils literal notranslate"><spanclass="pre">libraryItemId</span></code> attribute must be
specified.</p>
</p></li>
<li><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the library item that should be should be updated.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
If None, a new library item will be created. The <codeclass="docutils literal notranslate"><spanclass="pre">libraryId</span></code>
attribute must be specified if this attribute is <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>.</p></li>
<codeclass="sig-name descname"><spanclass="pre">DEPLOYABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">['VirtualMachine',</span><spanclass="pre">'VirtualApp']</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.DEPLOYABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>The types of resources that can be created by deploying an OVF package and can
be captured to create a library item using the <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem</span></code> class.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeployableIdentity</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">id</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.ovf_client.LibraryItem.DeployableIdentity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code> class describes the resource created
by a deployment, or the source resource from which library item can be
created, by specifying its resource type and resource identifier.</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>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the deployable resource.
When clients pass a value of this class as a parameter, the
attribute must be one of <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">VirtualApp</span></code>. When
methods return a value of this class as a return value, the
attribute will be one of <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">VirtualApp</span></code>.</p></li>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the deployable resource.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for one of these resource types:
<codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for one of
these resource types: <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeploymentResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">succeeded</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">error</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.ovf_client.LibraryItem.DeploymentResult"title="Permalink to this definition">¶</a></dt>
<li><p><strong>resource_id</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the deployed resource entity.
If None, the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method failed and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentResult.error</span></code> will describe the
error(s) that caused the failure.</p></li>
<li><p><strong>error</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"title="com.vmware.vcenter.ovf_client.LibraryItem.ResultInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResultInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Errors, warnings, and informational messages produced by the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeploymentTarget</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">resource_pool_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">folder_id</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.ovf_client.LibraryItem.DeploymentTarget"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget</span></code> class describes the location (target)
where a virtual machine or virtual appliance should be deployed. It is used
in the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">filter</span></code> methods. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a>
and <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.filter()</span></code></a>.</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>resource_pool_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the resource pool to which the virtual machine or
virtual appliance should be attached.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>host_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the target host on which the virtual machine or
virtual appliance will run. The target host must be a member of the
cluster that contains the resource pool identified by
If None, the server will automatically select a target host from
the resource pool if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget.resource_pool_id</span></code> is a
stand-alone host or a cluster with Distributed Resource Scheduling
(DRS) enabled.</p></li>
<li><p><strong>folder_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the vCenter folder that should contain the virtual
machine or virtual appliance. The folder must be virtual machine
folder.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
If None, the server will choose the deployment folder.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">OvfSummary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">annotation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">eulas</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">networks</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_groups</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">additional_params</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.ovf_client.LibraryItem.OvfSummary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.OvfSummary</span></code> class defines the result of the <codeclass="docutils literal notranslate"><spanclass="pre">filter</span></code>
method. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.filter()</span></code></a>. The attributes in the class
describe parameterizable information in the OVF descriptor, with respect to
a deployment target, for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. See
<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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default name for the virtual machine or virtual appliance.
If None, the OVF descriptor did not specify a name.</p></li>
<li><p><strong>annotation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default annotation for the virtual machine or virtual appliance.
If None, the OVF descriptor did not specify an annotation.</p></li>
<li><p><strong>eulas</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – End User License Agreements specified in the OVF descriptor. All
end user license agreements must be accepted in order for the
<codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method to succeed. See
<li><p><strong>networks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Section identifiers for sections of type ovf:NetworkSection in the
OVF descriptor. These identifiers can be used as keys in
If None, the OVF descriptor did not specify any networks.</p></li>
<li><p><strong>storage_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Section identifiers for sections of type vmw:StorageGroupSection in
the OVF descriptor. These identifiers can be used as keys in
If None, the OVF descriptor did not specify any storage groups.</p></li>
<li><p><strong>additional_params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Additional OVF parameters which can be specified for the deployment
target. These OVF parameters can be inspected, optionally modified,
for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>.
If None, the OVF descriptor does not require addtional parameters
or does not have additional parameters suitable for the deployment
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code> class defines the deployment
parameters that can be specified for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method where the
deployment target is a resource pool. See <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a>.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name assigned to the deployed target virtual machine or virtual
appliance.
If None, the server will use the name from the OVF package.</p></li>
<li><p><strong>annotation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Annotation assigned to the deployed target virtual machine or
virtual appliance.
If None, the server will use the annotation from the OVF package.</p></li>
<li><p><strong>accept_all_eula</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether to accept all End User License Agreements. See
<li><p><strong>network_mappings</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of the target network to use for sections of type
ovf:NetworkSection in the OVF descriptor. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the section identifier of the ovf:NetworkSection
section in the OVF descriptor and the value is the target network
to be used for deployment.
When clients pass a value of this class as a parameter, the value
in the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the
resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>. When methods return a value of this
class as a return value, the value in the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>
will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
If None, the server will choose a network mapping.</p></li>
<li><p><strong>storage_mappings</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of the target storage to use for sections of type
vmw:StorageGroupSection in the OVF descriptor. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the section identifier of the
ovf:StorageGroupSection section in the OVF descriptor and the value
is the target storage specification to be used for deployment. See
If None, the server will choose a storage mapping.</p></li>
<li><p><strong>storage_provisioning</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType"title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default storage provisioning type to use for all sections of type
vmw:StorageSection in the OVF descriptor.
If None, the server will choose the provisioning type.</p></li>
<li><p><strong>storage_profile_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default storage profile to use for all sections of type
vmw:StorageSection in the OVF descriptor.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">StorageProfile</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None, the server will choose the default profile.</p></li>
<li><p><strong>locale</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The locale to use for parsing the OVF descriptor.
If None, the server locale will be used.</p></li>
<li><p><strong>flags</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flags to be use for deployment. The supported flag values can be
obtained using <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ImportFlag.list"title="com.vmware.vcenter.ovf_client.ImportFlag.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ImportFlag.list()</span></code></a>.
If None, no flags will be used.</p></li>
<li><p><strong>additional_parameters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Additional OVF parameters that may be needed for the deployment.
Additional OVF parameters may be required by the OVF descriptor of
the OVF package in the library item. Examples of OVF parameters
that can be specified through this attribute include, but are not
<p>When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfParams"title="com.vmware.vcenter.ovf_client.OvfParams"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfParams</span></code></a>.
If None, the server will choose default settings for all parameters
necessary for the <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. See
<li><p><strong>default_datastore_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default datastore to use for all sections of type
vmw:StorageSection in the OVF descriptor.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ResultInfo</span></code><spanclass="sig-paren">(</span><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>, <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">information</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.ovf_client.LibraryItem.ResultInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.ResultInfo</span></code> class defines the information returned along
with the result of a <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method to describe errors,
warnings, and informational messages produced by the server.</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>errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfError"title="com.vmware.vcenter.ovf_client.OvfError"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfError</span></code></a>) – Errors reported by the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. These
errors would have prevented the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method
from completing successfully.</p></li>
<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.vcenter.ovf_client.OvfWarning"title="com.vmware.vcenter.ovf_client.OvfWarning"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfWarning</span></code></a>) – Warnings reported by the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code> method. These
warnings would not have prevented the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code>
method from completing successfully, but there might be issues that
warrant attention.</p></li>
<li><p><strong>information</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfInfo"title="com.vmware.vcenter.ovf_client.OvfInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OvfInfo</span></code></a>) – Information messages reported by the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">deploy</span></code>
method. For example, a non-required parameter was ignored.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StorageGroupMapping</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">datastore_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_profile_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">provisioning</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.ovf_client.LibraryItem.StorageGroupMapping"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping</span></code> class defines the storage
deployment target and storage provisioning type for a section of type
vmw:StorageGroupSection in the OVF descriptor.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping.Type</span></code></a>) – Type of storage deployment target to use for the
vmw:StorageGroupSection section. The specified value must be
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"title="com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping.Type.DATASTORE</span></code></a> or
<li><p><strong>datastore_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Target datastore to be used for the storage group.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>storage_profile_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Target storage profile to be used for the storage group.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">StorageProfile</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>provisioning</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.DiskProvisioningType"title="com.vmware.vcenter.ovf_client.DiskProvisioningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskProvisioningType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Target provisioning type to use for the storage group.
<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.ovf_client.LibraryItem.StorageGroupMapping.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.StorageGroupMapping.Type</span></code> class defines the supported
types of storage targets for sections of type vmw:StorageGroupSection in
the OVF descriptor.</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">DATASTORE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='DATASTORE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.DATASTORE"title="Permalink to this definition">¶</a></dt>
<dd><p>Storage deployment target is a datastore.</p>
<codeclass="sig-name descname"><spanclass="pre">STORAGE_PROFILE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='STORAGE_PROFILE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Storage deployment target is a storage profile.</p>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">source</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">create_spec</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_token</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.ovf_client.LibraryItem.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a library item in content library from a virtual machine or
virtual appliance.</p>
<p>This method creates a library item in content library whose content is
an OVF package derived from a source virtual machine or virtual
appliance, using the supplied create specification. The OVF package may
be stored as in a newly created library item or in an in an existing
library item. For an existing library item whose content is updated by
this method, the original content is overwritten. Meta data such as
name and description is not updated for the exisitng library item.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client-generated token used to retry a request if the client fails
to get a response from the server. If the original request
succeeded, the result of that request will be returned, otherwise
the operation will be retried.
If None, the server will create a token.</p></li>
<li><p><strong>source</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"title="com.vmware.vcenter.ovf_client.LibraryItem.DeployableIdentity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeployableIdentity</span></code></a>) – Identifier of the virtual machine or virtual appliance to use as
the source.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateTarget</span></code></a>) – Specification of the target content library and library item.</p></li>
<li><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CreateSpec</span></code></a>) – Information used to create the OVF package from the source virtual
<li><p>The resource <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">null</span></code> referenced by the attribute
<codeclass="sig-name descname"><spanclass="pre">deploy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ovf_library_item_id</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">deployment_spec</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_token</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.ovf_client.LibraryItem.deploy"title="Permalink to this definition">¶</a></dt>
<dd><p>Deploys an OVF package stored in content library to a newly created
virtual machine or virtual appliance.</p>
<p>This method deploys an OVF package which is stored in the library item
specified by <codeclass="docutils literal notranslate"><spanclass="pre">ovf_library_item_id</span></code>. It uses the deployment
specification in <codeclass="docutils literal notranslate"><spanclass="pre">deployment_spec</span></code> to deploy the OVF package to the
location specified by <codeclass="docutils literal notranslate"><spanclass="pre">target</span></code>.</p>
<dlclass="field-list">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client-generated token used to retry a request if the client fails
to get a response from the server. If the original request
succeeded, the result of that request will be returned, otherwise
the operation will be retried.
If None, the server will create a token.</p></li>
<li><p><strong>ovf_library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the content library item containing the OVF package
to be deployed.
The parameter must be an identifier for the resource type:
<li><p><strong>target</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"title="com.vmware.vcenter.ovf_client.LibraryItem.DeploymentTarget"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.DeploymentTarget</span></code></a>) – Specification of the deployment target.</p></li>
<li><p><strong>deployment_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"title="com.vmware.vcenter.ovf_client.LibraryItem.ResourcePoolDeploymentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.ResourcePoolDeploymentSpec</span></code></a>) – Specification of how the OVF package should be deployed to the
if there was an error accessing the OVF package stored in the
library item specified by <codeclass="docutils literal notranslate"><spanclass="pre">ovf_library_item_id</span></code>.</p>
</dd>
<dtclass="field-odd">Raise</dt>
<ddclass="field-odd"><dlclass="simple">
<dt><aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized"title="com.vmware.vapi.std.errors_client.Unauthorized"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a></dt><dd><p>if you do not have all of the privileges described as follows :</p>
</dd>
</dl>
<ulclass="simple">
<li><p>Method execution requires VirtualMachine.Config.AddNewDisk if the
OVF descriptor has a disk drive (type 17) section.</p></li>
<li><p>Method execution requires VirtualMachine.Config.AdvancedConfig if
the OVF descriptor has an ExtraConfig section.</p></li>
<li><p>Method execution requires Extension.Register for specified
resource group if the OVF descriptor has a vServiceDependency
section.</p></li>
<li><p>Method execution requires Network.Assign for target network if
specified.</p></li>
<li><p>Method execution requires Datastore.AllocateSpace for target
<li><p>The resource <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code> referenced by the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> value of
<codeclass="sig-name descname"><spanclass="pre">filter</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ovf_library_item_id</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="Permalink to this definition">¶</a></dt>
<dd><p>Queries an OVF package stored in content library to retrieve
information to use when deploying the package. See
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.OvfInfo">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">OvfInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfInfo"title="Permalink to this definition">¶</a></dt>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Category</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.ovf_client.OvfMessage.Category"title="Permalink to this definition">¶</a></dt>
<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">Category</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">INPUT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='INPUT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="Permalink to this definition">¶</a></dt>
<dd><p>The user provided input parameters are invalid.</p>
<codeclass="sig-name descname"><spanclass="pre">SERVER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='SERVER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VALIDATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='VALIDATION')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="Permalink to this definition">¶</a></dt>
<dd><p>The OVF descriptor is invalid, for example, syntax errors or schema errors.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.OvfParams">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">OvfParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.OvfParams"title="Permalink to this definition">¶</a></dt>
<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>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.OvfWarning">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">OvfWarning</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">category</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issues</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">error</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.ovf_client.OvfWarning"title="Permalink to this definition">¶</a></dt>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.VALIDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.VALIDATION</span></code></a>.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of input parameter.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.INPUT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.INPUT</span></code></a>.</p></li>
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"title="com.vmware.vcenter.ovf_client.OvfMessage.Category.SERVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OvfMessage.Category.SERVER</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.ParseIssue">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ParseIssue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">category</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">line_number</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">column_number</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ParseIssue</span></code> class contains the information about the issue found
when parsing an OVF package during deployment or exporting an OVF package
including:</p>
<ulclass="simple">
<li><p>Parsing and validation error on OVF descriptor (which is an XML
document), manifest and certificate files.</p></li>
<li><p>OVF descriptor generating and device error.</p></li>
<li><p>Unexpected server error.</p></li>
</ul>
<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>category</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category"title="com.vmware.vcenter.ovf_client.ParseIssue.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ParseIssue.Category</span></code></a>) – The category of the parse issue.</p></li>
<li><p><strong>file</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file in which the parse issue was found.</p></li>
<li><p><strong>line_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The line number of the line in the file (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ParseIssue.file</span></code>) where the parse issue was found (or -1 if
not applicable).</p></li>
<li><p><strong>column_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The position in the line (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ParseIssue.line_number</span></code>) (or
-1 if not applicable).</p></li>
<li><p><strong>message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A localizable message describing the parse issue.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Category</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.ovf_client.ParseIssue.Category"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ParseIssue.Category</span></code> class defines the categories of issues that can
be found when parsing files inside an OVF package (see <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ParseIssue"title="com.vmware.vcenter.ovf_client.ParseIssue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ParseIssue</span></code></a>)
including OVF descriptor (which is an XML document), manifest and
certificate files, or exporting an OVF package.</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">Category</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ATTRIBUTE_ILLEGAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='ATTRIBUTE_ILLEGAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_ILLEGAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Illegal attribute error. It indicates that an illegal attribute is set for
an element in the OVF descriptor. For example, empty disks do not use
format, parentRef, and populatedSize attributes, if these attributes are
present in an empty disk element then will get this pasrse issue.</p>
<codeclass="sig-name descname"><spanclass="pre">ATTRIBUTE_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='ATTRIBUTE_REQUIRED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ATTRIBUTE_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Required attribute error. It indicates that a required attribute is missing
<codeclass="sig-name descname"><spanclass="pre">ELEMENT_ILLEGAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='ELEMENT_ILLEGAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_ILLEGAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Illegal element error. It indicates that an element is present in a
location which is not allowed, or found multiple elements but only one is
allowed at the location in the OVF descriptor.</p>
<codeclass="sig-name descname"><spanclass="pre">ELEMENT_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='ELEMENT_REQUIRED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Required element error. It indicates that a required element is missing
<codeclass="sig-name descname"><spanclass="pre">ELEMENT_UNKNOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='ELEMENT_UNKNOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.ELEMENT_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Unknown element error. It indicates that an element is unsupported when
<codeclass="sig-name descname"><spanclass="pre">EXPORT_ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='EXPORT_ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.EXPORT_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Issue during OVF export, for example, malformed deviceId, controller not
found, or file backing for a device not found.</p>
<codeclass="sig-name descname"><spanclass="pre">GENERATE_ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='GENERATE_ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.GENERATE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>OVF descriptor (which is an XML document) generating error, for example,
well-formedness errors as well as unexpected processing conditions.</p>
<codeclass="sig-name descname"><spanclass="pre">INTERNAL_ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='INTERNAL_ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.INTERNAL_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Server encountered an unexpected error which prevented it from fulfilling
<codeclass="sig-name descname"><spanclass="pre">PARSE_ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='PARSE_ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.PARSE_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>OVF package parsing error, including:</p>
<ulclass="simple">
<li><p>OVF descriptor parsing errors, for example, syntax errors or schema
errors.</p></li>
<li><p>Manifest file parsing and verification errors.</p></li>
<li><p>Certificate file parsing and verification errors.</p></li>
<codeclass="sig-name descname"><spanclass="pre">SECTION_RESTRICTION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='SECTION_RESTRICTION')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_RESTRICTION"title="Permalink to this definition">¶</a></dt>
<dd><p>Section restriction error. It indicates that a section appears in place in
the OVF descriptor where it is not allowed, a section appears fewer times
than is required, or a section appears more times than is allowed.</p>
<codeclass="sig-name descname"><spanclass="pre">SECTION_UNKNOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='SECTION_UNKNOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.SECTION_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Section unknown error. It indicates that a section is unsupported when
<codeclass="sig-name descname"><spanclass="pre">VALIDATION_ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='VALIDATION_ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALIDATION_ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>An issue with the manifest and signing.</p>
<codeclass="sig-name descname"><spanclass="pre">VALUE_ILLEGAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Category(string='VALUE_ILLEGAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.ParseIssue.Category.VALUE_ILLEGAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Illegal value error. For example, the value is malformed, not a number, or
outside of the given range, and so on.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.Property">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Property</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">class_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">instance_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">category</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ui_optional</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</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.ovf_client.Property"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Property</span></code> class contains the information about a property in an OVF
package.</p>
<p>A property is uniquely identified by its [classid.]id[.instanceid]
fully-qualified name (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.class_id</span></code>, <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.id</span></code>,
and <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.instance_id</span></code>). If multiple properties in an OVF package
have the same fully-qualified name, then the property is excluded and
cannot be set. We do warn about this during import.</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>class_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The classId of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of this OVF property.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>instance_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The instanceId of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>category</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – If this is set to a non-empty string, this property starts a new
category.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. If None, the property
is in the same category as the previous item, otherwise, it starts
a new category.</p></li>
<li><p><strong>ui_optional</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Whether a category is UI optional. This is only used if this
property starts a new category (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Property.category</span></code>).</p>
<p>The value is stored in an optional attribute vmw:uioptional to the
ovf:Category element. The default value is false. If this value is
true, the properties within this category are optional. The UI
renders this as a group with a check box, and the group is grayed
out until the check box is selected. When the check box is
selected, the input values are read and used in deployment. If
properties within the same category specify conflicting values the
default is used. Only implemented in vSphere Web Client 5.1 and
later as of Nov 2012.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package.</p>
</p></li>
<li><p><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A description of this OVF property.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The type of this OVF property. Refer to the configuration of a
virtual appliance/virtual machine for the valid values.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The OVF property value. This contains the default value from
ovf:defaultValue if ovf:value is not present when read.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">PropertyParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">properties</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.PropertyParams"title="Permalink to this definition">¶</a></dt>
This attribute is optional in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ScaleOutGroup</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">instance_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">minimum_instance_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">maximum_instance_count</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.ovf_client.ScaleOutGroup"title="Permalink to this definition">¶</a></dt>
<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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the scale-out group.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the scale-out group.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>instance_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The scaling factor to use. It defines the number of replicas of the
prototypical virtual system or virtual system collection.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ScaleOutParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">groups</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.ScaleOutParams"title="Permalink to this definition">¶</a></dt>
<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>groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.ScaleOutGroup"title="com.vmware.vcenter.ovf_client.ScaleOutGroup"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ScaleOutGroup</span></code></a>) – The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of scale-out groups.
This attribute is optional in the input parameters when deploying
an OVF package. If None there are no scale-out groups. This
attribute will always be present in the result when retrieving
information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.ovf_client.SizeParams">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SizeParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">approximate_download_size</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">approximate_flat_deployment_size</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">approximate_sparse_deployment_size</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">variable_disk_size</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.SizeParams"title="Permalink to this definition">¶</a></dt>
<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>approximate_download_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) –<p>A best guess as to the total amount of data that must be
transferred to download the OVF package.</p>
<blockquote>
<div><p>This may be inaccurate due to disk compression etc.</p>
</div></blockquote>
<p>This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. It will be None if
there is insufficient information to provide a proper estimate.</p>
</p></li>
<li><p><strong>approximate_flat_deployment_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – A best guess as to the total amount of space required to deploy the
OVF package if using flat disks.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. It will be None if
there is insufficient information to provide a proper estimate.</p></li>
<li><p><strong>approximate_sparse_deployment_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – A best guess as to the total amount of space required to deploy the
OVF package using sparse disks.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. It will be None if
there is insufficient information to provide a proper estimate.</p></li>
<li><p><strong>variable_disk_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Whether the OVF uses variable disk sizes.</p>
<p>For empty disks, rather than specifying a fixed virtual disk
capacity, the capacity may be given using a reference to a
ovf:Property element in a ovf:ProductSection element in OVF
package.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute is optional in the result when
retrieving information about an OVF package. If None or false, the
OVF does not use variable disk sizes.</p>
</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_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.ovf_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.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">UnknownSection</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tag</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">info</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.ovf_client.UnknownSection"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">UnknownSection</span></code> class contains information about an unknown section
in an OVF package.</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>tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A namespace-qualified tag in the form <codeclass="docutils literal notranslate"><spanclass="pre">{ns}tag</span></code>.</p></li>
<li><p><strong>info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the Info element.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">UnknownSectionParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">unknown_sections</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.UnknownSectionParams"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">UnknownSectionParams</span></code> class contains a <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of unknown,
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">VcenterExtensionParams</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">required</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">registration_accepted</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.ovf_client.VcenterExtensionParams"title="Permalink to this definition">¶</a></dt>
<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>required</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether registration as a vCenter extension is required.
This attribute is not used in the input parameters when deploying
an OVF package. This attribute will always be present in the result
when retrieving information about an OVF package.</p></li>
<li><p><strong>registration_accepted</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Whether registration as a vCenter extension is accepted.</p>
<p>If registration as a vCenter extension is required (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VcenterExtensionParams.required</span></code>), this must be set to true
during deployment. Defaults to false when returned from server.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p>
</p></li>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier describing the type of the OVF parameters. The
value is the name of the OVF parameters class.
This attribute must be provided in the input parameters when
deploying an OVF package. This attribute will always be present in
the result when retrieving information about an OVF package.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">WarningInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ignored</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.ovf_client.WarningInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WarningInfo</span></code> class provides information about the warnings which are
raised during the OVF package deployment. This class was added in vSphere
API 7.0.2.0.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.WarningType"title="com.vmware.vcenter.ovf_client.WarningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WarningType</span></code></a>) – The warning type raised during the OVF package deployment. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The message specifying more details about the warning. This
attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>ignored</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) –<p>Indicates if this warning will be ignored when deploying the OVF
package.</p>
<p>The value is set to be <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> when it is returned from
<aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.filter"title="com.vmware.vcenter.ovf_client.LibraryItem.filter"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.filter()</span></code></a>, it should be updated to be <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>
when calling <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.LibraryItem.deploy"title="com.vmware.vcenter.ovf_client.LibraryItem.deploy"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">LibraryItem.deploy()</span></code></a> if the warning can be
ignored, otherwise the OVF package deployment will fail.. This
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.ovf_client.</span></code><codeclass="sig-name descname"><spanclass="pre">WarningType</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.ovf_client.WarningType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WarningType</span></code> class defines the warnings which can be raised during
the OVF package deployment. This enumeration was added in vSphere API
7.0.2.0.</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 <aclass="reference internal"href="#com.vmware.vcenter.ovf_client.WarningType"title="com.vmware.vcenter.ovf_client.WarningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WarningType</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">EXPIRED_CERTIFICATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">WarningType(string='EXPIRED_CERTIFICATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.WarningType.EXPIRED_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the OVF package content is expired. This
class attribute was added in vSphere API 7.0.2.0.</p>
<codeclass="sig-name descname"><spanclass="pre">NOT_YET_VALID_CERTIFICATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">WarningType(string='NOT_YET_VALID_CERTIFICATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.WarningType.NOT_YET_VALID_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the OVF package content is not yet valid.
This class attribute was added in vSphere API 7.0.2.0.</p>
<codeclass="sig-name descname"><spanclass="pre">SELF_SIGNED_CERTIFICATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">WarningType(string='SELF_SIGNED_CERTIFICATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.WarningType.SELF_SIGNED_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the OVF package content is self-signed.
This class attribute was added in vSphere API 7.0.2.0.</p>
<codeclass="sig-name descname"><spanclass="pre">UNTRUSTED_CERTIFICATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">WarningType(string='UNTRUSTED_CERTIFICATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.ovf_client.WarningType.UNTRUSTED_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the OVF package content is not trusted.
This class attribute was added in vSphere API 7.0.2.0.</p>
<spanid="com-vmware-vcenter-services-client-module"></span><h2>com.vmware.vcenter.services_client module<aclass="headerlink"href="#module-com.vmware.vcenter.services_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.services_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Service</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.services_client.Service"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service</span></code> class provides methods to manage a single/set of vCenter
Server services. This class was added in vSphere API 6.7.</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">Health</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.services_client.Service.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.Health</span></code> class defines the possible values for health of a
service. This enumeration was added in vSphere API 6.7.</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">Health</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DEGRADED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='DEGRADED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Health.DEGRADED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is in degraded state, it is not functional. This class attribute
<codeclass="sig-name descname"><spanclass="pre">HEALTHY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='HEALTHY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Health.HEALTHY"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is in a healthy state and is fully functional. This class attribute
<codeclass="sig-name descname"><spanclass="pre">HEALTHY_WITH_WARNINGS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='HEALTHY_WITH_WARNINGS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.Health.HEALTHY_WITH_WARNINGS"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is healthy with warnings. This class attribute was added in vSphere
<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">name_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">startup_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">health</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">health_messages</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.services_client.Service.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.Info</span></code> class contains information about a service. This class
was added in vSphere API 6.7.</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>name_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service name key. Can be used to lookup resource bundle. This
attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>description_key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service description key. Can be used to lookup resource bundle.
This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>startup_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.StartupType"title="com.vmware.vcenter.services_client.Service.StartupType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.StartupType</span></code></a>) – Startup Type. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State"title="com.vmware.vcenter.services_client.Service.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.State</span></code></a>) – Running State. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.Health"title="com.vmware.vcenter.services_client.Service.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.Health</span></code></a>) – Health of service. This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State.STARTED"title="com.vmware.vcenter.services_client.Service.State.STARTED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STARTED</span></code></a>.</p></li>
<li><p><strong>health_messages</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>) – Localizable messages associated with the health of the service.
This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State.STARTED"title="com.vmware.vcenter.services_client.Service.State.STARTED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STARTED</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StartupType</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.services_client.Service.StartupType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.StartupType</span></code> class defines valid Startup Type for vCenter
Server services. This enumeration was added in vSphere API 6.7.</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">StartupType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">AUTOMATIC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StartupType(string='AUTOMATIC')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.StartupType.AUTOMATIC"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Automatic, thus during starting all services or
issuing explicit start on the service will start it. This class attribute
<codeclass="sig-name descname"><spanclass="pre">DISABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StartupType(string='DISABLED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Disabled, thus it will not start unless the startup
type changes to manual or automatic. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StartupType(string='MANUAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.StartupType.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Startup type is Manual, thus issuing an explicit start on the
service will start it. This class attribute was added in vSphere API 6.7.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">State</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.State</span></code> class defines valid Run State for services. This
enumeration was added in vSphere API 6.7.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">State</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">STARTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='STARTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STARTED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Started, it is fully functional. This class attribute
<codeclass="sig-name descname"><spanclass="pre">STARTING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='STARTING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STARTING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Starting, it is still not functional. This class
<codeclass="sig-name descname"><spanclass="pre">STOPPED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='STOPPED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STOPPED"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Stopped. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">STOPPING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='STOPPING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.State.STOPPING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service Run State is Stopping, it is not functional. This class attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">startup_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.services_client.Service.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Service.UpdateSpec</span></code> class describes the changes to be made to the
configuration of the service. This class was added in vSphere API 6.7.</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>startup_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.StartupType"title="com.vmware.vcenter.services_client.Service.StartupType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service.StartupType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Startup Type. This attribute was added in vSphere API 6.7.
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the state of a service. This method was added in vSphere API
6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service whose state is being queried.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list_details</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.list_details"title="Permalink to this definition">¶</a></dt>
<dd><p>Lists details of vCenter services. This method was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">restart</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.restart"title="Permalink to this definition">¶</a></dt>
<dd><p>Restarts a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to restart
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">start</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Starts a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to start
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">stop</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.stop"title="Permalink to this definition">¶</a></dt>
<dd><p>Stops a service. This method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service to stop
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.services_client.Service.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the properties of a service. This method was added in vSphere
API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the service whose properties are being updated.
The parameter must be an identifier for the resource type:
if a request to set the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.UpdateSpec.startup_type</span></code>
attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> to <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.StartupType.DISABLED"title="com.vmware.vcenter.services_client.Service.StartupType.DISABLED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.StartupType.DISABLED</span></code></a> comes
in for a service that is not in <aclass="reference internal"href="#com.vmware.vcenter.services_client.Service.State.STOPPED"title="com.vmware.vcenter.services_client.Service.State.STOPPED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Service.State.STOPPED</span></code></a>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.services_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.services_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-storage-client-module"></span><h2>com.vmware.vcenter.storage_client module<aclass="headerlink"href="#module-com.vmware.vcenter.storage_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.storage_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Policies</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.storage_client.Policies"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies</span></code> class provides methods for managing the storage policies.
This class was added in vSphere API 6.7.</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">CompatibilityInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">compatible_datastores</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.storage_client.Policies.CompatibilityInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.CompatibilityInfo</span></code> class contains info about a list of
datastores compatible with a specific storage policy. This class was added
in vSphere API 6.7.</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>compatible_datastores</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo"title="com.vmware.vcenter.storage_client.Policies.CompatibleDatastoreInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.CompatibleDatastoreInfo</span></code></a>) – Info about a list of datastores compatible with a specific storage
policy. This attribute was added in vSphere API 6.7.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CompatibleDatastoreInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</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.storage_client.Policies.CompatibleDatastoreInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.CompatibleDatastoreInfo</span></code> class contains compatible
datastore’s information. This class was added in vSphere API 6.7.</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>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore. This attribute was added in vSphere
API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policies</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.storage_client.Policies.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code> class contains attributes used to filter the
results when listing the storage policies (see <aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.list"title="com.vmware.vcenter.storage_client.Policies.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Policies.list()</span></code></a>). This
class was added in vSphere API 6.7.</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>policies</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifiers of storage policies that can match the filter. This
attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will contain
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.StoragePolicy'</span></em><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for vAPI metadata policy. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</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.storage_client.Policies.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Policies.Summary</span></code> class contains commonly used information about a
storage policy. This class was added in vSphere API 6.7.</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>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the storage policy. This attribute was added in
vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.StoragePolicy</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the storage policy. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the storage policy. This attribute was added in
<codeclass="sig-name descname"><spanclass="pre">check_compatibility</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">datastores</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.storage_client.Policies.check_compatibility"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns datastore compatibility summary about a specific storage
policy. This method was added in vSphere API 6.7.</p>
<li><p><strong>datastores</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Datastores used to check compatibility against a storage policy.
The number of datastores is limited to 1024.
The parameter must contain identifiers for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</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.storage_client.Policies.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about at most 1024 visible (subject to permission
checks) storage solicies availabe in vCenter. These storage policies
can be used for provisioning virtual machines or disks. This method was
added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.FilterSpec"title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching storage policies for which information
should be returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.FilterSpec"title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code></a> with all attributes None which means
if the <aclass="reference internal"href="#com.vmware.vcenter.storage_client.Policies.FilterSpec"title="com.vmware.vcenter.storage_client.Policies.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Policies.FilterSpec</span></code></a> contains a value that is not
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.storage_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.storage_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-system-config-client-module"></span><h2>com.vmware.vcenter.system_config_client module<aclass="headerlink"href="#module-com.vmware.vcenter.system_config_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.system_config_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.system_config_client.DeploymentType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType</span></code> class provides methods to get/set the type of the
appliance. This class was added in vSphere API 6.7.</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">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.system_config_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 fields used to get the
appliance type. This class was added in vSphere API 6.7.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceType"title="com.vmware.vcenter.deployment_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.ApplianceType</span></code></a>) – The type of the appliance. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ReconfigureSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">remote_psc</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.system_config_client.DeploymentType.ReconfigureSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.ReconfigureSpec</span></code> class contains the fields used to
get and set the appliance type. This class was added in vSphere API 6.7.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.ApplianceType"title="com.vmware.vcenter.deployment_client.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.ApplianceType</span></code></a>) – The type of the appliance. This attribute was added in vSphere API
6.7.</p></li>
<li><p><strong>remote_psc</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.RemotePscSpec"title="com.vmware.vcenter.deployment_client.RemotePscSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – External PSC to register with when reconfiguring a VCSA_EMBEDDED
appliance to a VCSA_EXTERNAL appliance. This attribute was added in
vSphere API 6.7.
Only required when reconfiguring an VCSA_EMBEDDED node to a
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.DeploymentType.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the type of the vCenter appliance. This method was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">reconfigure</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.system_config_client.DeploymentType.reconfigure"title="Permalink to this definition">¶</a></dt>
<dd><p>Reconfigure the type of the vCenter appliance. This method was added in
vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec"title="com.vmware.vcenter.system_config_client.DeploymentType.ReconfigureSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentType.ReconfigureSpec</span></code></a>) – ReconfigureSpec to set the appliance type.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.system_config_client.</span></code><codeclass="sig-name descname"><spanclass="pre">PscRegistration</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.system_config_client.PscRegistration"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PscRegistration</span></code> class provides methods to get and set the
PSC_EXTERNAL appliance a VCSA_EXTERNAL appliance is registered with. This
class was added in vSphere API 6.7.</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">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">https_port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sso_domain</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.system_config_client.PscRegistration.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PscRegistration.Info</span></code> class has fields to specify information about
the PSC node. This class was added in vSphere API 6.7.</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>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the PSC this appliance is
registered with. This attribute was added in vSphere API 6.7.</p></li>
<li><p><strong>https_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The HTTPs port used by the external PSC. This attribute was added
in vSphere API 6.7.</p></li>
<li><p><strong>sso_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The Single Sign-On domain name of the external PSC. This attribute
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.system_config_client.PscRegistration.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get information of the PSC that this appliance is registered with. This
<codeclass="sig-name descname"><spanclass="pre">repoint</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.system_config_client.PscRegistration.repoint"title="Permalink to this definition">¶</a></dt>
<dd><p>Repoint this vCenter Server appliance to a different external PSC. This
method was added in vSphere API 6.7.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.deployment_client.RemotePscSpec"title="com.vmware.vcenter.deployment_client.RemotePscSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.deployment_client.RemotePscSpec</span></code></a>) – RemotePscSpec structure containing information about the external
PSC node to repoint this vCenter Server appliance to.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.system_config_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.system_config_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-tagging-client-module"></span><h2>com.vmware.vcenter.tagging_client module<aclass="headerlink"href="#module-com.vmware.vcenter.tagging_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.tagging_client</span></code> module provides classes for managing
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.tagging_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Associations</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.tagging_client.Associations"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Associations</span></code> class provides methods to list tag associations. This
class was added in vSphere API 7.0.0.0.</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">IterationSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">marker</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.tagging_client.Associations.IterationSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Associations.IterationSpec</span></code> class contains attributes used to break
results into pages when listing tags associated to objects see
<aclass="reference internal"href="#com.vmware.vcenter.tagging_client.Associations.list"title="com.vmware.vcenter.tagging_client.Associations.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Associations.list()</span></code></a>). This class was added in vSphere API 7.0.0.0.</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>marker</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Marker is an opaque token that allows the caller to request the
next page of tag associations. This attribute was added in vSphere
API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.tagging.associations.Marker</span></code>. When methods
return a value of this class as a return value, the attribute will
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">LastIterationStatus</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.tagging_client.Associations.LastIterationStatus"title="Permalink to this definition">¶</a></dt>
<p>The last status for the iterator. A field of this type is returned as part
of the result and indicates to the caller of the API whether it can
continue to make requests for more data.</p>
<p>The last status only reports on the state of the iteration at the time data
was last returned. As a result, it not does guarantee if the next call will
succeed in getting more data or not.</p>
<p>Failures to retrieve results will be returned as Error responses. These
last statuses are only returned when the iterator is operating as
expected.. This enumeration was added in vSphere API 7.0.0.0.</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">LastIterationStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">END_OF_DATA</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LastIterationStatus(string='END_OF_DATA')</span></em><aclass="headerlink"href="#com.vmware.vcenter.tagging_client.Associations.LastIterationStatus.END_OF_DATA"title="Permalink to this definition">¶</a></dt>
<dd><p>Iterator has finished iterating through its inventory. There are currently
no more entities to return and the caller can terminate iteration. If the
iterator returned some data, the marker may be set to allow the iterator to
continue from where it left off when additional data does become available.
This value is used to indicate that all available data has been returned by
the iterator. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">READY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">LastIterationStatus(string='READY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.tagging_client.Associations.LastIterationStatus.READY"title="Permalink to this definition">¶</a></dt>
<dd><p>Iterator has more data pending and is ready to provide it. The caller can
request the next page of data at any time.</p>
<p>The number of results returned may be less than the usual size. In other
words, the iterator may not fill the page. The iterator has returned at
least 1 result.. This class attribute was added in vSphere API 7.0.0.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ListResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">associations</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">marker</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.tagging_client.Associations.ListResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Associations.ListResult</span></code> class contains the list of tag associations
in a page, as well as related metadata fields. This class was added in
vSphere API 7.0.0.0.</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>associations</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.tagging_client.Associations.Summary"title="com.vmware.vcenter.tagging_client.Associations.Summary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Associations.Summary</span></code></a>) – List of tag associations. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>marker</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Marker is an opaque data structure that allows the caller to
request the next page of tag associations. This attribute was added
in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.tagging.associations.Marker</span></code>. When methods
return a value of this class as a return value, the attribute will
If None or empty, there are no more tag associations to request.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.tagging_client.Associations.LastIterationStatus"title="com.vmware.vcenter.tagging_client.Associations.LastIterationStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Associations.LastIterationStatus</span></code></a>) – The last status for the iterator that indicates whether any more
results can be expected if the caller continues to make requests
for more data using the iterator. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tag</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">object</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.tagging_client.Associations.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Associations.Summary</span></code> describes a tag association. This class was
added in vSphere API 7.0.0.0.</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>tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of a tag. This attribute was added in vSphere API
7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.tagging.Tag</span></code>.</p></li>
<li><p><strong>object</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a>) – The identifier of an associated object. This attribute was added in
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">iterate</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.tagging_client.Associations.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns tag associations that match the specified iteration spec. This
method was added in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>iterate</strong> (<aclass="reference internal"href="#com.vmware.vcenter.tagging_client.Associations.IterationSpec"title="com.vmware.vcenter.tagging_client.Associations.IterationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Associations.IterationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The specification of a page to be retrieved.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.tagging_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.tagging_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-tokenservice-client-module"></span><h2>com.vmware.vcenter.tokenservice_client module<aclass="headerlink"href="#module-com.vmware.vcenter.tokenservice_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">exception</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.tokenservice_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Error</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">data</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.tokenservice_client.Error"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Error</span></code> exception describes theattributes common to all standard
exceptions.</p>
<blockquote>
<div><p>This exception serves two purposes:</p>
</div></blockquote>
<olclass="arabic simple">
<li><p>It is the exception that clients in many programming languages can catch
to handle all standard exceptions. Typically those clients will display one
or more of the localizable messages from <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Error.messages</span></code> to a human.</p></li>
<li><p>It is the exception that methods can report when they need to report
some exception, but the exception doesn’t fit into any other standard
exception, and in fact the only reasonable way for a client to react to the
exception is to display the message(s) to a human.</p></li>
</ol>
<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>messages</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>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
ArgumentLocations, FileLocations, and TransientIndication classes
are intended as possible values for this attribute.
<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
a value for this attribute (although that is not its primary
purpose). Some classes may provide their own specific classes for
use as the value of this attribute when reporting exceptions from
their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property"><spanclass="pre">exception</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.tokenservice_client.</span></code><codeclass="sig-name descname"><spanclass="pre">InvalidGrant</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">data</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.tokenservice_client.InvalidGrant"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">InvalidGrant</span></code> exception indicates that provided authorization grant
(e.g., authorization code, resource owner credentials) or refresh token is
invalid, expired, revoked, does not match the redirection URI used in the
authorization request, or was issued to another client.</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>messages</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>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
ArgumentLocations, FileLocations, and TransientIndication classes
are intended as possible values for this attribute.
<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
a value for this attribute (although that is not its primary
purpose). Some classes may provide their own specific classes for
use as the value of this attribute when reporting exceptions from
their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property"><spanclass="pre">exception</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.tokenservice_client.</span></code><codeclass="sig-name descname"><spanclass="pre">InvalidRequest</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">data</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.tokenservice_client.InvalidRequest"title="Permalink to this definition">¶</a></dt>
<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>messages</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>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
ArgumentLocations, FileLocations, and TransientIndication classes
are intended as possible values for this attribute.
<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
a value for this attribute (although that is not its primary
purpose). Some classes may provide their own specific classes for
use as the value of this attribute when reporting exceptions from
their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property"><spanclass="pre">exception</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.tokenservice_client.</span></code><codeclass="sig-name descname"><spanclass="pre">InvalidScope</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">data</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.tokenservice_client.InvalidScope"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">InvalidScope</span></code> exception indicates requested scope is invalid,
unknown, malformed, or exceeds the scope granted by the resource owner.</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>messages</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>) –<p>Stack of one or more localizable messages for human exception
consumers.</p>
<p>The message at the top of the stack (first in the list) describes
the exception from the perspective of the method the client
invoked. Each subsequent message in the stack describes the “cause”
of the prior message.</p>
</p></li>
<li><p><strong>data</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Data to facilitate clients responding to the method reporting a
standard exception to indicating that it was unable to complete
successfully.</p>
<p>Methods may provide data that clients can use when responding to
exceptions. Since the data that clients need may be specific to the
context of the method reporting the exception, different methods
that report the same exception may provide different data in the
exception. The documentation for each each method will describe
what, if any, data it provides for each exception it reports. The
ArgumentLocations, FileLocations, and TransientIndication classes
are intended as possible values for this attribute.
<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> may also be useful as
a value for this attribute (although that is not its primary
purpose). Some classes may provide their own specific classes for
use as the value of this attribute when reporting exceptions from
their methods.
Some methods will not set this attribute when reporting exceptions.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.tokenservice_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.tokenservice_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.tokenservice_client.</span></code><codeclass="sig-name descname"><spanclass="pre">TokenExchange</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.tokenservice_client.TokenExchange"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TokenExchange</span></code> interface provides possibility to exchange between
different tokens types. Implementation of “OAuth 2.0 Token Exchange”
standard (<aclass="reference external"href="https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12">https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12</a>).</p>
<p>This interface has been deprecated in the vSphere 7.0 U2 release. Use
<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>
<codeclass="sig-name descname"><spanclass="pre">ACCESS_TOKEN_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'urn:ietf:params:oauth:token-type:access_token'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ACCESS_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">BEARER_TOKEN_METHOD_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'Bearer'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.BEARER_TOKEN_METHOD_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates that the security token is a bearer token.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec</span></code> class contains arguments required for
token exchange.</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>grant_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of <aclass="reference internal"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"title="com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TokenExchange.TOKEN_EXCHANGE_GRANT</span></code></a> indicates
that a token exchange is being performed.</p></li>
<li><p><strong>resource</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Indicates the location of the target service or resource where the
client intends to use the requested security token.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>audience</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The logical name of the target service where the client intends to
use the requested security token. This serves a purpose similar to
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec.resource</span></code> parameter, but with
the client providing a logical name rather than a location.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>scope</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of space-delimited, case-sensitive strings, that allow the
client to specify the desired scope of the requested security token
in the context of the service or resource where the token will be
used.
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>requested_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – An identifier for the type of the requested security token. If the
requested type is unspecified, the issued token type is at the
discretion of the server and may be dictated by knowledge of the
requirements of the service or resource indicated by the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TokenExchange.ExchangeSpec.resource</span></code> or
if can be inferred from other arguments or not needed for specific
case of exchange.</p></li>
<li><p><strong>subject_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A security token that represents the identity of the party on
behalf of whom exchange is being made. Typically, the subject of
this token will be the subject of the security token issued. Token
is base64-encoded.</p></li>
<li><p><strong>subject_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An identifier, that indicates the type of the security token in the
<li><p><strong>actor_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A security token that represents the identity of the acting party.
Typically, this will be the party that is authorized to use the
requested security token and act on behalf of the subject.
if not needed for specific case of exchange.</p></li>
<li><p><strong>actor_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – An identifier, that indicates the type of the security token in the
<codeclass="sig-name descname"><spanclass="pre">ID_TOKEN_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'urn:ietf:params:oauth:token-type:id_token'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.ID_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates OIDC ID token type.</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">access_token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issued_token_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">token_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">expires_in</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">scope</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">refresh_token</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.tokenservice_client.TokenExchange.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TokenExchange.Info</span></code> class contains data that represents successful
token exchange response.</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>access_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The security token issued by the server in response to the token
exchange request. Token is base64-encoded.</p></li>
<li><p><strong>issued_token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – An identifier, that indicates the type of the security token in the
<li><p><strong>token_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A case-insensitive value specifying the method of using the access
token issued.</p></li>
<li><p><strong>expires_in</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The validity lifetime, in seconds, of the token issued by the
server.
if not applicable for issued token.</p></li>
<li><p><strong>scope</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Scope of the issued security token.
if the scope of the issued security token is identical to the scope
requested by the client.</p></li>
<li><p><strong>refresh_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A refresh token can be issued in cases where the client of the
token exchange needs the ability to access a resource even when the
original credential is no longer valid.
if not needed for specific case of exchange.</p></li>
<codeclass="sig-name descname"><spanclass="pre">N_A_TOKEN_METHOD_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'N_A'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.N_A_TOKEN_METHOD_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">REFRESH_TOKEN_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'urn:ietf:params:oauth:token-type:refresh_token'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.REFRESH_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SAML1_TOKEN_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'urn:ietf:params:oauth:token-type:saml1'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.SAML1_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SAML2_TOKEN_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'urn:ietf:params:oauth:token-type:saml2'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.SAML2_TOKEN_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TOKEN_EXCHANGE_GRANT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'urn:ietf:params:oauth:grant-type:token-exchange'</span></em><aclass="headerlink"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.TOKEN_EXCHANGE_GRANT"title="Permalink to this definition">¶</a></dt>
<dd><p>Class attribute indicates that token exchange grant type.</p>
<codeclass="sig-name descname"><spanclass="pre">exchange</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.tokenservice_client.TokenExchange.exchange"title="Permalink to this definition">¶</a></dt>
<dd><p>Exchanges incoming token based on the spec and current client
authorization data.</p>
<p>This method has been deprecated in the vSphere 7.0 U2 release. Use
<ddclass="field-odd"><p><aclass="reference internal"href="#com.vmware.vcenter.tokenservice_client.TokenExchange.Info"title="com.vmware.vcenter.tokenservice_client.TokenExchange.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TokenExchange.Info</span></code></a> class that contains new token.</p>
<spanid="com-vmware-vcenter-topology-client-module"></span><h2>com.vmware.vcenter.topology_client module<aclass="headerlink"href="#module-com.vmware.vcenter.topology_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.topology_client</span></code> module provides classes to retrieve
all vCenter and Platform Services Controller nodes and replication status in
the topology.</p>
<dlclass="py class">
<dtid="com.vmware.vcenter.topology_client.Nodes">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.topology_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Nodes</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.topology_client.Nodes"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes</span></code> interface provides methods to retrieve vCenter and Platform
Services Controller nodes information in the topology. This class was added
in vSphere API 6.7.2.</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">ApplianceType</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.topology_client.Nodes.ApplianceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code> class defines values for valid appliance types
for the vCenter and Platform Services Controller node. See
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.Info"title="com.vmware.vcenter.topology_client.Nodes.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.Info</span></code></a>. This enumeration was added in vSphere API 6.7.2.</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">ApplianceType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">PSC_EXTERNAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceType(string='PSC_EXTERNAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.PSC_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>An external Platform Services Controller. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">VCSA_EMBEDDED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceType(string='VCSA_EMBEDDED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an embedded Platform Services Controller.
This class attribute was added in vSphere API 6.7.2.</p>
<codeclass="sig-name descname"><spanclass="pre">VCSA_EXTERNAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplianceType(string='VCSA_EXTERNAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server Appliance with an external Platform Services Controller.
This class attribute was added in vSphere API 6.7.2.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">types</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.topology_client.Nodes.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code> class contains attribute used to filter the
results when listing vCenter and Platform Services Controller nodes (see
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.list"title="com.vmware.vcenter.topology_client.Nodes.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Nodes.list()</span></code></a>). This class was added in vSphere API 6.7.2.</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>types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Types of the appliance that a vCenter and Platform Services
Controller node must be to match the filter (see
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a>. This attribute was added in vSphere
API 6.7.2.
If None or empty, node of any ApplianceType match the filter.</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">domain</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">replication_partners</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_affinity</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.topology_client.Nodes.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.Info</span></code> class contains vCenter or Platform Services Controller
node details. This class was added in vSphere API 6.7.2.</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>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Domain name of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a>) – Appliance type of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>replication_partners</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of replication partners’ node identifiers. Identifiers can be
either IP address or DNS resolvable name of the partner node. This
attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">node</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">replication_partners</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_affinity</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.topology_client.Nodes.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Nodes.Summary</span></code> class contains commonly used information of vCenter
or Platform Services Controller node. This class was added in vSphere API
6.7.2.</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>node</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the vCenter or Platform Services Controller node.
Identifier can be either IP address or DNS resolvable name of the
node. This attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType</span></code></a>) – Appliance type of the node. This attribute was added in vSphere API
6.7.2.</p></li>
<li><p><strong>replication_partners</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of replication partners’ node identifiers. Identifiers can be
either IP address or DNS resolvable name of the partner node. This
attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"title="com.vmware.vcenter.topology_client.Nodes.ApplianceType.VCSA_EMBEDDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.ApplianceType.VCSA_EMBEDDED</span></code></a> or
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">node</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.topology_client.Nodes.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve details for a given identifier of the vCenter or Platform
Services Controller node. This method was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>node</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the vCenter or Platform Services Controller node.
Identifier can be either IP address or DNS resolvable name of the
node.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</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.topology_client.Nodes.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about all vCenter and Platform Services Controller
nodes matching the <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec"title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code></a>. This method was added in
vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec"title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching vCenter and Platform Services Controller
nodes for which information should be returned.
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.vcenter.topology_client.Nodes.FilterSpec"title="com.vmware.vcenter.topology_client.Nodes.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nodes.FilterSpec</span></code></a>
with all attributes None which means all nodes match the filter.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.topology_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ReplicationStatus</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.topology_client.ReplicationStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicationStatus</span></code> interface provides methods to retrieve
replication status information of vCenter and Platform Services Controller
nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>).
This class was added in vSphere API 6.7.2.</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">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">nodes</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.topology_client.ReplicationStatus.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code> class contains attribute used to
filter the results when listing replication status for the vCenter and
Platform Services Controller nodes (see <aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.list"title="com.vmware.vcenter.topology_client.ReplicationStatus.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">ReplicationStatus.list()</span></code></a>) of
type VCSA_EMBEDDED/PSC_EXTERNAL (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>). This class
was added in vSphere API 6.7.2.</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>nodes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier that a vCenter and Platform Services Controller node
must have to match the filter. (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.node</span></code>). This attribute was added
in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will contain
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">node</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">replication_partner</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">partner_available</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">status_available</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">replicating</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">change_lag</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.topology_client.ReplicationStatus.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary</span></code> class contains replication information of
partner vCenter or Platform Services Controller node of type
VCSA_EMBEDDED/PSC_EXTERNAL (see <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>). This class was
added in vSphere API 6.7.2.</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>node</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the vCenter or Platform Services Controller node.
Identifier can be either IP address or DNS resolvable name of the
node. This attribute was added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>replication_partner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the vCenter or Platform Services Controller
replication partner. Identifier can be either IP address or DNS
resolvable name of the replication partner. This attribute was
added in vSphere API 6.7.2.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.VCenter.name</span></code>.</p></li>
<li><p><strong>partner_available</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if the VMware Directory Service on partner is reachable
or not. This attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>status_available</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if the replication status for the node with respect to
replication partner can be retrieved or not. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>replicating</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Indicates if node is processing replication changes from the
replication partner. This attribute was added in vSphere API 6.7.2.
This attribute will be None if the partner host or replication
status is not available, i.e, if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.partner_available</span></code> or
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
<li><p><strong>change_lag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of replication changes node is behind the replication
partner. This attribute was added in vSphere API 6.7.2.
This attribute will be None if the partner host or replication
status is not available, i.e, if
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.partner_available</span></code> or
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ReplicationStatus.Summary.status_available</span></code> is false.</p></li>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</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.topology_client.ReplicationStatus.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the replication information of vCenter and Platform Services
Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Nodes.Info.type</span></code>) matching the
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code></a>. This method was added in vSphere
API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of matching vCenter and Platform Services Controller
nodes for which information should be returned.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"title="com.vmware.vcenter.topology_client.ReplicationStatus.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ReplicationStatus.FilterSpec</span></code></a> with all attributes None
which means all vCenter and Platform Services Controller nodes of
type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.topology_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.topology_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-trusted-infrastructure-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><codeclass="sig-name descname"><spanclass="pre">NetworkAddress</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">hostname</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</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.trusted_infrastructure_client.NetworkAddress"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NetworkAddress</span></code> class contains an IP address or DNS resolvable name
and a port on which a connection can be established. This class was added
in vSphere API 7.0.0.0.</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>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the service. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The port of the service. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Principal</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.trusted_infrastructure_client.Principal"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Principal</span></code> class contains information about the certificates which
sign the tokens used by vCenter for authentication. This class was added in
vSphere API 7.0.0.0.</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">certificates</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issuer</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">principal</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.Principal.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Principal.Info</span></code> class contains the information about the principal
and certificates used by this vCenter to retrieve tokens. This class was
added in vSphere API 7.0.0.0.</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>certificates</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">X509CertChain</span></code></a>) – The certificates used by the STS to sign tokens for this vCenter.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>principal</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StsPrincipal</span></code></a>) – The principal used by this vCenter instance to retrieve tokens.
Currently this is the vCenter solution user. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The user-friednly name of the vCenter. This attribute was added in
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.Principal.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the STS used by this vCenter instance. This
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StsPrincipal</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">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.trusted_infrastructure_client.StsPrincipal"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">StsPrincipal</span></code> class contains a IDM principal. This class was added
in vSphere API 7.0.0.0.</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>id</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalId"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalId"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StsPrincipalId</span></code></a>) – The principal’s ID. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StsPrincipalType</span></code></a>) – The type of the principal (user or group). This attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StsPrincipalId</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">domain</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.trusted_infrastructure_client.StsPrincipalId"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">StsPrincipalId</span></code> class contains an IDM principal ID. This class was
added in vSphere API 7.0.0.0.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The principal’s username. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The principal’s domain. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StsPrincipalType</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.trusted_infrastructure_client.StsPrincipalType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">StsPrincipalType</span></code> enum can be either users or groups. This
enumeration was added in vSphere API 7.0.0.0.</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 <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StsPrincipalType</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">STS_GROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StsPrincipalType(string='STS_GROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType.STS_GROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>The principal is a group. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">STS_USER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StsPrincipalType(string='STS_USER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipalType.STS_USER"title="Permalink to this definition">¶</a></dt>
<dd><p>The principal is a user. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_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.trusted_infrastructure_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.trusted_infrastructure_client.</span></code><codeclass="sig-name descname"><spanclass="pre">TrustAuthorityClusters</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.trusted_infrastructure_client.TrustAuthorityClusters"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code> class manages all the Trust Authority
Components on each Trust Authority Host in the cluster. The
<codeclass="docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code> class transforms a ClusterComputeResource into
Trust Authority Cluster and vice versa. This class was added in vSphere API
7.0.0.0.</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">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</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.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.FilterSpec</span></code> class contains the data necessary
for identifying a <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a>. This class was added in
vSphere API 7.0.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifies the cluster. This attribute was added in vSphere API
7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
cluster If {\@term.unset} return all Trust Authority Clusters.</p></li>
<li><p><strong>state</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.State</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The state of the <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a>. This attribute
was added in vSphere API 7.0.0.0.
state If {\@term.unset} return all Trust Authority Clusters.</p></li>
<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">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</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.trusted_infrastructure_client.TrustAuthorityClusters.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.Info</span></code> class contains the data necessary for
retrieving the <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a> info. This class was added
in vSphere API 7.0.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifies the cluster. This attribute was added in vSphere API
7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.State</span></code></a>) – The state of the cluster. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">State</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.State</span></code> class defines the states of the
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a>. This enumeration was added in vSphere API
7.0.0.0.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">State</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DISABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='DISABLE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State.DISABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>The <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a> is disabled. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">ENABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='ENABLE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State.ENABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>The <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a> is enabled. This class attribute was
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</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.trusted_infrastructure_client.TrustAuthorityClusters.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.Summary</span></code> class contains information about
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a> id and state. This class was added in
vSphere API 7.0.0.0.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifies the cluster. This attribute was added in vSphere API
7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.State</span></code></a>) – The state of the <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a>. This attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.UpdateSpec</span></code> class contains the data necessary
for update of a <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a>. This class was added in
vSphere API 7.0.0.0.</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>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.State</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The state of the <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters</span></code></a>. This attribute
was added in vSphere API 7.0.0.0.
state If {\@term.unset} no operation is performed.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the result of the last Update operation which matches the cluster
id. This method was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</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.trusted_infrastructure_client.TrustAuthorityClusters.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of clusters for this vCenter instance which matches the
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.FilterSpec</span></code></a>. This method was added in
vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Return only clusters matching the specified filters.
<ddclass="field-odd"><p>List of <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.Summary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.Summary</span></code></a> for a
<codeclass="sig-name descname"><spanclass="pre">update_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.update_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the state of a cluster. This method was added in vSphere API
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.UpdateSpec"title="com.vmware.vcenter.trusted_infrastructure_client.TrustAuthorityClusters.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustAuthorityClusters.UpdateSpec</span></code></a>) – The specification for update of a cluster.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.</span></code><codeclass="sig-name descname"><spanclass="pre">X509CertChain</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cert_chain</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.trusted_infrastructure_client.X509CertChain"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">X509CertChain</span></code> class contains x509 certificate chain. This class was
added in vSphere API 7.0.0.0.</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>cert_chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Certificate chain in base64 format. This attribute was added in
<spanid="com-vmware-vcenter-vcha-client-module"></span><h2>com.vmware.vcenter.vcha_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vcha_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client</span></code> module provides classes for deploying
and monitoring a vCenter High Availability (VCHA) Cluster.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CertificateInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumbprint</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_client.CertificateInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CertificateInfo</span></code> Class contains information about the SSL
certificate for a management vCenter server. 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>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SHA-256 thumbprint of the SSL certificate for a management
vCenter server. This attribute was added in vSphere API 6.7.1.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vcha_client.Cluster">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Cluster</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_client.Cluster"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster</span></code> class provides methods to deploy and undeploy a vCenter
High Availability (VCHA) cluster, failover from the active VCHA node to the
passive VCHA node, and retrieve the status of the 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">ActiveSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ha_network_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ha_network</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_client.Cluster.ActiveSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec</span></code> class contains the deploy specification for the
Active Node 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"><ulclass="simple">
<li><p><strong>ha_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used by the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> field must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
unset, then the second NIC is assumed to be already configured.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
set, then an error is reported.</p></li>
<li><p><strong>ha_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is set, then
the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute must be
set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network_type</span></code>
attribute is unset, then the second NIC is assumed to be already
configured.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec.ha_network</span></code> attribute is
set, then an error is reported.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
<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_client.Cluster.ClusterMode"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.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_client.Cluster.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_client.Cluster.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_client.Cluster.ClusterMode.MAINTENANCE"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA Cluster is in maintenance mode. State replication between the Active
and Passive node is enabled but automatic failover is not allowed. This
class attribute was added in vSphere API 6.7.1.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ClusterState</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_client.Cluster.ClusterState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.ClusterState</span></code> class defines the possible 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">ClusterState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DEGRADED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ClusterState(string='DEGRADED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.DEGRADED"title="Permalink to this definition">¶</a></dt>
<dd><p>A VCHA Cluster is said to be in a degraded state for either or all of the
following reasons:</p>
<ulclass="simple">
<li><p>There is a node loss.</p></li>
<li><p>State replication between the Active and Passive node fails.</p></li>
</ul>
<p>. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="sig-name descname"><spanclass="pre">HEALTHY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ClusterState(string='HEALTHY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.HEALTHY"title="Permalink to this definition">¶</a></dt>
<dd><p>All three nodes in a VCHA Cluster are healthy and connected. State
replication between Active and Passive node is working and both nodes are
in sync. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="sig-name descname"><spanclass="pre">ISOLATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ClusterState(string='ISOLATED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState.ISOLATED"title="Permalink to this definition">¶</a></dt>
<dd><p>All three nodes are isolated from each other. This class attribute was
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ConfigState</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_client.Cluster.ConfigState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.ConfigState</span></code> class defines the VCHA configuration state.
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">ConfigState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CONFIGURED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigState(string='CONFIGURED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.CONFIGURED"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA cluster is configured. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">INVALID</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigState(string='INVALID')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.INVALID"title="Permalink to this definition">¶</a></dt>
<dd><p>VCHA cluster is in an invalid/dirty state. This class attribute was added
<codeclass="sig-name descname"><spanclass="pre">NOTCONFIGURED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigState(string='NOTCONFIGURED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.NOTCONFIGURED"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">PREPARED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigState(string='PREPARED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState.PREPARED"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter server appliance has been prepared for VCHA cluster configuration.
This class attribute was added in vSphere API 6.7.1.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeploySpec</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">deployment</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">active</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">passive</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">witness</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_client.Cluster.DeploySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.DeploySpec</span></code> class contains the deploy specification for the
three nodes 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>vc_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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>deployment</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.Type"title="com.vmware.vcenter.vcha_client.Cluster.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.Type</span></code></a>) – Contains the deployment type. This attribute was added in vSphere
API 6.7.1.</p></li>
<li><p><strong>active</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ActiveSpec"title="com.vmware.vcenter.vcha_client.Cluster.ActiveSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ActiveSpec</span></code></a>) – Contains the active node’s network configuration. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>passive</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.PassiveSpec"title="com.vmware.vcenter.vcha_client.Cluster.PassiveSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.PassiveSpec</span></code></a>) – Contains the passive node’s placement configuration. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>witness</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.WitnessSpec"title="com.vmware.vcenter.vcha_client.Cluster.WitnessSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.WitnessSpec</span></code></a>) – Contains the witness node’s placement configuration. This attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ErrorCondition</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">error</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">recommendation</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_client.Cluster.ErrorCondition"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.ErrorCondition</span></code> class contains an error condition and a
recommendation to handle the error condition. 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>error</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Contains an error condition. This attribute was added in vSphere
API 6.7.1.</p></li>
<li><p><strong>recommendation</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains a recommendation on handling the error condition. This
attribute was added in vSphere API 6.7.1.
If None, there is no tip for the error condition.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.Info</span></code> class contains the configuration and health
information of the three nodes in 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>config_state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ConfigState"title="com.vmware.vcenter.vcha_client.Cluster.ConfigState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ConfigState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration state of the VCHA cluster.
The active node’s management vCenter server credentials are not
required to populate this attribute. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable.</p></li>
<li><p><strong>node1</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Node configuration information for the VCHA cluster. This attribute
was added in vSphere API 6.7.1.
If None, then the information is unavailable.</p></li>
<li><p><strong>node2</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Node configuration information for the VCHA cluster. This attribute
was added in vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>witness</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.WitnessInfo"title="com.vmware.vcenter.vcha_client.Cluster.WitnessInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Node configuration information for the VCHA cluster. This attribute
was added in vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterMode"title="com.vmware.vcenter.vcha_client.Cluster.ClusterMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ClusterMode</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Operational mode of the VCHA Cluster. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>health_state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ClusterState"title="com.vmware.vcenter.vcha_client.Cluster.ClusterState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ClusterState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Last known state of the VCHA Cluster. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
cloned yet.</p></li>
<li><p><strong>health_exception</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Health warning messages if the health information is unavailable.
This attribute was added in vSphere API 6.7.1.
If None, then the cluster is in a healthy state.</p></li>
<li><p><strong>health_warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.ErrorCondition"title="com.vmware.vcenter.vcha_client.Cluster.ErrorCondition"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.ErrorCondition</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A collection of messages describing the reason for a non-healthy
Cluster. This attribute was added in vSphere API 6.7.1.
If None, then the cluster is in a healthy state.</p></li>
<li><p><strong>manual_failover_allowed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies if manual failover is allowed. This attribute was added
in vSphere API 6.7.1.
If None, then the cluster state healthy and manual failover
allowance in accordance with the cluster mode.</p></li>
<li><p><strong>auto_failover_allowed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies if automatic failover is allowed. This attribute was
added in vSphere API 6.7.1.
If None, then the cluster state healthy and automatic failover
allowance in accordance with the cluster mode.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">IpFamily</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_client.Cluster.IpFamily"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.IpFamily</span></code> class defines the IP address family. 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 <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily"title="com.vmware.vcenter.vcha_client.IpFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpFamily</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">IPV4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpFamily(string='IPV4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"title="Permalink to this definition">¶</a></dt>
<dd><p>IPV4 address family. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="sig-name descname"><spanclass="pre">IPV6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpFamily(string='IPV6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"title="Permalink to this definition">¶</a></dt>
<dd><p>IPV6 address family. This class attribute was added in vSphere API 6.7.1.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">IpInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ip_family</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ipv4</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ipv6</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">gateway_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_client.Cluster.IpInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.IpInfo</span></code> class contains attributes related to an ip. 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>ip_family</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily"title="com.vmware.vcenter.vcha_client.Cluster.IpFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpFamily</span></code></a>) – Family of the ip. This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>ipv4</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.Ipv4Info"title="com.vmware.vcenter.vcha_client.Cluster.Ipv4Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.Ipv4Info</span></code></a>) – If the type of the ip family is IPV4, then this will point to IPv4
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV4"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.IpFamily.IPV4</span></code></a>.</p></li>
<li><p><strong>ipv6</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.Ipv6Info"title="com.vmware.vcenter.vcha_client.Cluster.Ipv6Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.Ipv6Info</span></code></a>) – If the type of the ip family is IPV6, then this will point to IPv6
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"title="com.vmware.vcenter.vcha_client.Cluster.IpFamily.IPV6"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.IpFamily.IPV6</span></code></a>.</p></li>
<li><p><strong>gateway_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Gateway IP address. This attribute was added in vSphere API 6.7.1.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Ipv4Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subnet_mask</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</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_client.Cluster.Ipv4Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.Ipv4Info</span></code> class contains attributes to describe IPV4
information of the configured network interface. 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>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address of the configured network interface. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>subnet_mask</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The subnet mask of the interface. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR prefix of the interface. This attribute was added in
vSphere API 6.7.1.
If None , then the subnet mask is invalid.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Ipv6Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</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_client.Cluster.Ipv6Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.Ipv6Info</span></code> class contains attributes to describe IPV6
information of the configured network interface. 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>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP address of the configured network interface. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The CIDR prefix of the interface. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NodeInfo</span></code><spanclass="sig-paren">(</span><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>, <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">runtime</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_client.Cluster.NodeInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo</span></code> class defines the configuration information for
the active and passive nodes in the 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>failover_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo"title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Failover IP address that this node will assume after the failover
to serve client requests. Each failover node can have a different
failover IP address.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo.failover_ip</span></code>. This
attribute was added in vSphere API 6.7.1.
If None, then it will assume the public IP address of the Active
vCenter Server.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo"title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpInfo</span></code></a>) – VCHA Cluster network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network.
The active node’s management vCenter server credentials are not
required to populate this <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo.ha_ip</span></code>. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>runtime</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Runtime information for the node in the VCHA Cluster.
The active node’s management vCenter server credentials are
required to populate some attributes of
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeInfo.runtime</span></code>. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the specified
Active vCenter server management credentials are invalid or the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NodeRole</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_client.Cluster.NodeRole"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.NodeRole</span></code> class defines the role node can be in 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">NodeRole</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ACTIVE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NodeRole(string='ACTIVE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.ACTIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is having a role of Active. In this role, node runs a vCenter Server
that serves client requests. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">PASSIVE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NodeRole(string='PASSIVE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.PASSIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is having a role of Passive. In this role node, runs as a standby for
the Active vCenter Server and receives state updates. This node takes over
the role of Active vCenter Server upon failover. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">WITNESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NodeRole(string='WITNESS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole.WITNESS"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is having a role of Witness. In this role, node acts as a quorum node
for avoiding the classic split-brain problem. This class attribute was
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NodeRuntimeInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">role</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_client.Cluster.NodeRuntimeInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo</span></code> class describes a node’s runtime
information in 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>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeState"title="com.vmware.vcenter.vcha_client.Cluster.NodeState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Last known state of the node.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo.state</span></code>. This
attribute was added in vSphere API 6.7.1.
If None, then information is unavailable or the passive and witness
nodes are not cloned yet.</p></li>
<li><p><strong>role</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRole"title="com.vmware.vcenter.vcha_client.Cluster.NodeRole"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeRole</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Last known role of the node.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo.role</span></code>. This
attribute was added in vSphere API 6.7.1.
If None, then information is unavailable or the passive and witness
nodes are not cloned yet.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.PlacementInfo"title="com.vmware.vcenter.vcha_client.PlacementInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PlacementInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Placement information of the node.
The active node’s management vCenter server credentials are
required to populate most attributes of
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo.placement</span></code>. This attribute was added
in vSphere API 6.7.1.
If None, then the information is unavailable or the specified
Active vCenter server management credentials are invalid or the
node is not cloned yet or the VCHA cluster was deployed in a manual
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NodeState</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_client.Cluster.NodeState"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.NodeState</span></code> class defines possible state a node can be in 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">NodeState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NodeState(string='DOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeState.DOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is down and has left the VCHA Cluster. This class attribute was added
<codeclass="sig-name descname"><spanclass="pre">UP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NodeState(string='UP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.NodeState.UP"title="Permalink to this definition">¶</a></dt>
<dd><p>Node is up and has joined the VCHA Cluster. This class attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NodeVmInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">bios_uuid</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_client.Cluster.NodeVmInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.NodeVmInfo</span></code> class contains information to describe the
Virtual Machine of a 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>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the virtual machine of the VCHA node. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine:VCenter</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine:VCenter</span></code>.</p></li>
<li><p><strong>bios_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – BIOS UUID for the node. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">PassiveSpec</span></code><spanclass="sig-paren">(</span><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_client.Cluster.PassiveSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.PassiveSpec</span></code> class contains the deploy specification for the
Passive Node 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"><ulclass="simple">
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the placement configuration of the node. This attribute
was added in vSphere API 6.7.1.
If None, then the it is assumed that the clone will be done
manually by the customer. In this case, the placement configuration
for the witness node should also be omitted. Only the network
configuration will be setup. Once the passive and witness nodes are
cloned from the active node, the VCHA high availability is turned
on.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>failover_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP specification for the management network. This attribute was
added in vSphere API 6.7.1.
If None, then it will assume the public IP address of the Active
<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_client.Cluster.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.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_client.Cluster.Type.AUTO"title="Permalink to this definition">¶</a></dt>
<dd><p>Passive and witness nodes are cloned automatically. This class attribute
<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_client.Cluster.Type.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Passive and witness nodes are not cloned automatically. After deployment,
the customer should clone the passive and witness virtual machines. This
class attribute was added in vSphere API 6.7.1.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UndeploySpec</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">force_delete</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vms</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_client.Cluster.UndeploySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec</span></code> class contains the undeploy specification for
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>vc_spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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>force_delete</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>Flag controlling in what circumstances the virtual machines will be
deleted. For this flag to take effect, the VCHA cluster should have
been successfully configured using automatic deployment.</p>
<ul>
<li><p>If true, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute will be
ignored, the VCHA cluster specific information is removed, and the
passive and witness virtual machines will be deleted.</p></li>
the information identifying the passive and witness virtual
machines.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is set, then it
will be validated prior to deleting the passive and witness virtual
machines and VCHA cluster specific information is removed.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is None, then
the passive and witness virtual machines will not be deleted. The
customer should delete them in order to cleanup completely. VCHA
cluster specific information is removed.</p></li>
</ul>
<p>. This attribute was added in vSphere API 6.7.1.
If None, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute contains
the information identifying the passive and witness virtual
machines.</p>
<ul>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is set, then it
will be validated prior to deleting the passive and witness virtual
machines. VCHA cluster specific information is removed.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.vms</span></code> attribute is None, then
the passive and witness virtual machines will not be deleted. The
customer should delete them in order to cleanup completely. VCHA
cluster specific information is removed.</p></li>
</ul>
</p></li>
<li><p><strong>vms</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.VmInfo"title="com.vmware.vcenter.vcha_client.Cluster.VmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.VmInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Contains virtual machine information for the passive and witness
virtual machines. For this flag to take effect, the VCHA cluster
should have been successfully configured using automatic
deployment.</p>
<p>If set, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
controls whether this information is validated.</p>
<ul>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
true, then this information is ignored, VCHA cluster specific
information is removed and the passive and witness virtual machines
will be deleted.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
None or false, then this information is validated prior to deleting
the passive and witness virtual machines. VCHA cluster specific
information is removed.</p></li>
</ul>
<p>. This attribute was added in vSphere API 6.7.1.
If None, the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute
controls the deletion of the passive and witness virtual machines.</p>
<ul>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
true, then the passive and witness virtual machines will be
deleted. VCHA cluster specific information is removed.</p></li>
<li><p>If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec.force_delete</span></code> attribute is
None or false, then the passive and witness virtual machines will
not be deleted. The customer should delete them in order to cleanup
completely. VCHA cluster specific information is removed.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VmInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">passive</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">witness</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_client.Cluster.VmInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.VmInfo</span></code> class contains information to describe the Virtual
Machines of passive and witness nodes 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>passive</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeVmInfo</span></code></a>) – The virtual machine information of the passive node. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>witness</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeVmInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeVmInfo</span></code></a>) – The virtual machine information of the witness node. This attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">WitnessInfo</span></code><spanclass="sig-paren">(</span><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">runtime</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_client.Cluster.WitnessInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo</span></code> class defines the configuration and runtime
information for the witness node in the 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>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.IpInfo"title="com.vmware.vcenter.vcha_client.Cluster.IpInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.IpInfo</span></code></a>) – VCHA Cluster network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network.
The active node’s management vCenter server credentials are not
required to populate <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo.ha_ip</span></code>. This
attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>runtime</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"title="com.vmware.vcenter.vcha_client.Cluster.NodeRuntimeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.NodeRuntimeInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Runtime information for the node in the VCHA Cluster.
The active node’s management vCenter server credentials are
required to populate some attributes of
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Cluster.WitnessInfo.runtime</span></code>. This attribute was added in
vSphere API 6.7.1.
If None, then the information is unavailable or the node is not
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">WitnessSpec</span></code><spanclass="sig-paren">(</span><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_client.Cluster.WitnessSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Cluster.WitnessSpec</span></code> class contains the deploy specification for the
Witness Node 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"><ulclass="simple">
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the placement configuration of the node. This attribute
was added in vSphere API 6.7.1.
If None, then it is assumed that the clone will be done manually by
the customer. In this case, the placement configuration for the
witness node should also be omitted. Only the network configuration
will be setup. Once the passive and witness nodes are cloned from
the active node, the VCHA high availability is turned on.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpSpec</span></code></a>) – IP specification for the HA network. This attribute was added in
<codeclass="sig-name descname"><spanclass="pre">deploy_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_client.Cluster.deploy_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Prepares, clones, and configures 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"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.DeploySpec"title="com.vmware.vcenter.vcha_client.Cluster.DeploySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.DeploySpec</span></code></a>) – Contains the deploy specification for all three nodes of a VCHA
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">failover_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">planned</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Cluster.failover_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Initiates failover from the active vCenter node to the passive node.</p>
<p>For forced failover, Active node immediately initiates a failover. This
may result into a data loss after failover.</p>
<p>For planned failover, Active node flushes all the state to the Passive
node, waits for the flush to complete before causing a failover. After
the failover, Passive node starts without any data loss.</p>
<blockquote>
<div><p>A failover is allowed only in the following cases:</p>
</div></blockquote>
<olclass="arabic simple">
<li><p>Cluster’s mode is enabled and all cluster members are present.</p></li>
<li><p>Cluster’s mode is maintenance and all cluster members are present.</p></li>
</ol>
<p>. 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>planned</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – If false, a failover is initiated immediately and may result in
data loss.
If true, a failover is initated after the Active node flushes its
<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_client.Cluster.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the status 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.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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
<codeclass="sig-name descname"><spanclass="pre">undeploy_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_client.Cluster.undeploy_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Destroys the VCHA cluster and removes all VCHA specific information
from the VCVA appliance. Optionally, the passive and witness node
virtual machines will be deleted only if VCHA was deployed using
automatic deployment. The active node in the cluster continues to run
as a standalone VCVA appliance after the destroy operation has been
performed.</p>
<p>If the VCHA cluster is in a transition state and not configured, then
the VCHA cluster specific information is removed.. 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>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Cluster.UndeploySpec"title="com.vmware.vcenter.vcha_client.Cluster.UndeploySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster.UndeploySpec</span></code></a>) – Contains the undeploy specification for a VCHA cluster.</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_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ConnectionSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">hostname</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumbprint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">username</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</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_client.ConnectionSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConnectionSpec</span></code> class contains information required to connect to a
vCenter server. The connection to the vCenter server always uses the HTTPS
protocol. 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>hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IP Address or DNS of the vCenter. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Port number. This attribute was added in vSphere API 6.7.1.
If None, port 443 will be used.</p></li>
<li><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SHA1 hash of the server SSL certificate. This attribute was added
in vSphere API 6.7.1.
If None, empty ssl thumbprint is assumed.</p></li>
<li><p><strong>username</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Username to access the server. This attribute was added in vSphere
API 6.7.1.
This attribute is currently required. If None, an error is
returned. In the future, if this attribute is None, the system will
attempt to identify the user. If a user cannot be identified, then
the requested operation will fail.</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Password for the specified user. This attribute was added in
vSphere API 6.7.1.
This attribute is currently required. If None, an empty password is
assumed. In the future, if this attribute is None, the system will
attempt to authenticate the user. If a user cannot be identified,
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CredentialsSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">active_location</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_client.CredentialsSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CredentialsSpec</span></code> class contains information to connect to the
vCenter server managing the VCHA nodes. 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>active_location</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.ConnectionSpec"title="com.vmware.vcenter.vcha_client.ConnectionSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectionSpec</span></code></a>) – Connection information for the management vCenter Server of the
Active Node in a VCHA Cluster. This attribute was added in vSphere
API 6.7.1.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vcha_client.DiskInfo">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DiskInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">datastore_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.DiskInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DiskInfo</span></code> class contains information to describe the storage
configuration of a vCenter virtual machine. 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>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the datastore to put all the virtual disks on.
This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore:VCenter</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
<li><p><strong>datastore_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the datastore. This attribute was added in vSphere API
6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vcha_client.DiskSpec">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DiskSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</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_client.DiskSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DiskSpec</span></code> class contains information to describe the storage
configuration of a vCenter virtual machine. 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>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the datastore to put all the virtual disks on.
This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore:VCenter</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">IpFamily</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_client.IpFamily"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpFamily</span></code> class defines the Ip address family. 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 <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily"title="com.vmware.vcenter.vcha_client.IpFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpFamily</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">IPV4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpFamily(string='IPV4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV4"title="Permalink to this definition">¶</a></dt>
<dd><p>IPV4 address family. This class attribute was added in vSphere API 6.7.1.</p>
<codeclass="sig-name descname"><spanclass="pre">IPV6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IpFamily(string='IPV6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV6"title="Permalink to this definition">¶</a></dt>
<dd><p>IPv6 address family. This class attribute was added in vSphere API 6.7.1.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vcha_client.IpSpec">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">IpSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ip_family</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ipv4</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ipv6</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_gateway</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">dns_servers</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_client.IpSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">IpSpec</span></code> class contains IP information used to configure a network
interface. 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>ip_family</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily"title="com.vmware.vcenter.vcha_client.IpFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpFamily</span></code></a>) – Family of the IP address to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>ipv4</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Ipv4Spec"title="com.vmware.vcenter.vcha_client.Ipv4Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv4Spec</span></code></a>) – If the family of the ip is IPV4, then this will point to IPv4
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV4"title="com.vmware.vcenter.vcha_client.IpFamily.IPV4"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">IpFamily.IPV4</span></code></a>.</p></li>
<li><p><strong>ipv6</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Ipv6Spec"title="com.vmware.vcenter.vcha_client.Ipv6Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Ipv6Spec</span></code></a>) – If the family of the ip is IPV6, then this will point to IPv6
address specification. This attribute was added in vSphere API
6.7.1.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">ipFamily</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.IpFamily.IPV6"title="com.vmware.vcenter.vcha_client.IpFamily.IPV6"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">IpFamily.IPV6</span></code></a>.</p></li>
<li><p><strong>default_gateway</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The IP address of the Gateway for this interface. This attribute
was added in vSphere API 6.7.1.
If None, gateway will not be used for the network interface.</p></li>
<li><p><strong>dns_servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The list of IP addresses of the DNS servers for this interface.
This list is a comma separated list. This attribute was added in
vSphere API 6.7.1.
If None, DNS servers will not be used for the network interface.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vcha_client.Ipv4Spec">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Ipv4Spec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subnet_mask</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</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_client.Ipv4Spec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv4Spec</span></code> class contains IPV4 information used to configure a
network interface. 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>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IPV4 address to be used to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>subnet_mask</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The subnet mask for the interface. This attribute was added in
vSphere API 6.7.1.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute is None, then an error will be
reported.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute is set, then the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code>
attribute will be used to create a subnet mask whose first prefix
bits are 1 and the remaining bits 0.
If both the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute
are set and they do not represent the same value, then an error
will be reported.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR prefix for the interface. This attribute was added in
vSphere API 6.7.1.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute is None, this an error
will be reported.
If None and the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute is set, then the
<codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute will be used.
If both the <codeclass="docutils literal notranslate"><spanclass="pre">subnetMask</span></code> attribute and the <codeclass="docutils literal notranslate"><spanclass="pre">prefix</span></code> attribute
are set and they do not represent the same value, then an error
will be reported.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vcha_client.Ipv6Spec">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Ipv6Spec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</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_client.Ipv6Spec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Ipv6Spec</span></code> class contains IPV6 information used to configure a
network interface. 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>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – IPv6 address to be used to configure the interface. This attribute
was added in vSphere API 6.7.1.</p></li>
<li><p><strong>prefix</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The CIDR prefix for the interface. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">NetworkType</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_client.NetworkType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">NetworkType</span></code> class defines the type of a vCenter Server network.
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 <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DISTRIBUTED_PORTGROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkType(string='DISTRIBUTED_PORTGROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.NetworkType.DISTRIBUTED_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>Distributed virtual switch. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">STANDARD_PORTGROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkType(string='STANDARD_PORTGROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.NetworkType.STANDARD_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere standard portgroup network. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Operations</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_client.Operations"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Operations</span></code> class provides methods to figure out the currently
active operations and currently disabled operations 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>
<codeclass="sig-name descname"><spanclass="pre">CLUSTER_DEPLOY_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.deploy'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster deploy operation. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">CLUSTER_FAILOVER_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.failover'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_FAILOVER_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster failover operation. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">CLUSTER_GET_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.get'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster get operation. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">CLUSTER_UNDEPLOY_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.undeploy'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the cluster undeploy operation. This class attribute was added in
<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">disabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">active</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_client.Operations.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Operations.Info</span></code> class contains information about which the VCHA
operations cannot be invoked in the current state of the system and the
list of currently active VCHA operations. 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>disabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the operations that are current disabled. These
operation strings are one of <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_UNDEPLOY_OP</span></code></a> and
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_GET_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_GET_OP</span></code></a>. This attribute was added in
vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>active</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of the operations that are currently running. These
operation strings are one of <aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_DEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_DEPLOY_OP</span></code></a>,
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"title="com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.MODE_SET_OP</span></code></a>, and
<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"title="com.vmware.vcenter.vcha_client.Operations.CLUSTER_UNDEPLOY_OP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Operations.CLUSTER_UNDEPLOY_OP</span></code></a>. This attribute was added in
vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<codeclass="sig-name descname"><spanclass="pre">MODE_GET_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.mode.get'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.MODE_GET_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the get mode operation. This class attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">MODE_SET_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.mode.set'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.MODE_SET_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the set mode operation. This class attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">PASSIVE_REDEPLOY_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.passive.redeploy'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.PASSIVE_REDEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the passive redeploy operation. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">WITNESS_REDEPLOY_OP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.vcha.cluster.witness.redeploy'</span></em><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.WITNESS_REDEPLOY_OP"title="Permalink to this definition">¶</a></dt>
<dd><p>Identifier of the witness redeploy operation. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vcha_client.Operations.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves the current active and disabled operations of a VCHA cluster.
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PlacementInfo</span></code> class contains information to describe the inventory
placement of a single node of a VCHA cluster.
The active node’s management vCenter server credentials are required to
populate all attributes except biosUuid. 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_vcenter_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The hostname of the vCenter server that is managing the VCHA node.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>management_vcenter_server_guid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The unique identifier of the vCenter server that is managing the
VCHA node. This attribute was added in vSphere API 7.0.0.1.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>vm_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The virtual machine name of the VCHA node. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>datacenter</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the datacenter of the VCHA node. This attribute
was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datacenter:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
<li><p><strong>datacenter_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the datacenter of the VCHA node. This attribute was
added in vSphere API 6.7.1.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the host of the VCHA node. This attribute was
added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
<li><p><strong>host_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the host of the VCHA node. This attribute was added in
vSphere API 6.7.1.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the cluster of which <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is member. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource:VCenter</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource:VCenter</span></code>.
If None, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is a standalone host.</p></li>
<li><p><strong>cluster_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the cluster of which <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is member. This attribute
was added in vSphere API 6.7.1.
If None, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is a standalone host.</p></li>
<li><p><strong>ha_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the HA network. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None, the information is currently unavailable or the haNetwork
is not configured.</p></li>
<li><p><strong>ha_network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the Network object used for the HA network. This
attribute was added in vSphere API 6.7.1.
If None, the information is currently unavailable or the haNetwork
is not configured.</p></li>
<li><p><strong>ha_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used for the HA network. This
attribute was added in vSphere API 6.7.1.
If None, the information is currently unavailable or the haNetwork
is not configured.</p></li>
<li><p><strong>management_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the Network object used for the Management
network. This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>management_network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the Network object used for the Management network.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>management_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a>) – The type of the Network object used for the Management network.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.DiskInfo"title="com.vmware.vcenter.vcha_client.DiskInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskInfo</span></code></a>) – The storage information of the VCHA node. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>bios_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – BIOS UUID for the node. This attribute was added in vSphere API
6.7.1.
If None, the information is currently unavailable.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PlacementSpec</span></code> class contains information to describe the inventory
placement of a single 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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the VCHA node to be used for the virtual machine name.
This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the folder to deploy the VCHA node to. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Folder:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the host to deploy the VCHA node to. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the resource pool to deploy the VCHA node to.
This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool:VCenter</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
If None, then the active node’s resource pool will be used.</p></li>
<li><p><strong>ha_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used by the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> field must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> attribute is ignored. This
attribute was added in vSphere API 6.7.1.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is
unset, then the same network present on the Active node virtual
machine is used to deploy the virtual machine with an assumption
that the network is present on the destination.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is set,
then an error is reported.</p></li>
<li><p><strong>ha_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the HA network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is set, then the
{#link #haNetworkType} attribute must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network</span></code> attribute is None, then the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> attribute is ignored. This
attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.ha_network_type</span></code> attribute is
unset, then the same network present on the Active node virtual
machine is used to deploy the virtual machine with an assumption
that the network is present on the destination.</p></li>
<li><p><strong>management_network_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.NetworkType"title="com.vmware.vcenter.vcha_client.NetworkType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NetworkType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the Network object used by the Management network.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute is set,
then the {#link #managementNetworkType} field must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute
is unset, then the same network present on the Active node virtual
machine is used to deploy the virtual machine with an assumption
that the network is present on the destination.
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute
is set, then an error is reported.</p></li>
<li><p><strong>management_network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the Network object used for the Management
network. If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute
is set, then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code>
attribute must be set.
If the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network</span></code> attribute is None,
then the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code> attribute is
ignored. This attribute was added in vSphere API 6.7.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Network:VCenter</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None and the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PlacementSpec.management_network_type</span></code>
attribute is unset, then the same network present on the Active
node virtual machine is used to deploy the virtual machine with an
assumption that the network is present on the destination.</p></li>
<li><p><strong>storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha_client.DiskSpec"title="com.vmware.vcenter.vcha_client.DiskSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DiskSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The storage specification to deploy the VCHA node to. This
attribute was added in vSphere API 6.7.1.
If None, see vim.vm.RelocateSpec.datastore.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha_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_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-vm-client-module"></span><h2>com.vmware.vcenter.vm_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client</span></code> module provides classes for managing
virtual machines.</p>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.GuestOS">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">GuestOS</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.vm_client.GuestOS"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">GuestOS</span></code> class defines the valid guest operating system types used
for configuring a virtual machine.</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 <aclass="reference internal"href="#com.vmware.vcenter.vm_client.GuestOS"title="com.vmware.vcenter.vm_client.GuestOS"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GuestOS</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">AMAZONLINUX2_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='AMAZONLINUX2_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX2_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Amazon Linux 2 (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">AMAZONLINUX3_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='AMAZONLINUX3_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.AMAZONLINUX3_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Amazon Linux 3 (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_3</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_3')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_3_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_3_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_3_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_4_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_4_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_4_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_5_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_5_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_5_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_7_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_7_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_8_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_8_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_8_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Asianux Server 8 (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">ASIANUX_9_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ASIANUX_9_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ASIANUX_9_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Asianux Server 9 (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">CENTOS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">CENTOS_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">CENTOS_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">CENTOS_6_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS_6_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">CENTOS_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">CENTOS_7_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS_7_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">CENTOS_8_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS_8_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_8_64"title="Permalink to this definition">¶</a></dt>
<dd><p>CentOS 8 (64-bit). This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">CENTOS_9_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CENTOS_9_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CENTOS_9_64"title="Permalink to this definition">¶</a></dt>
<dd><p>CentOS 9 (64-bit). This class attribute was added in vSphere API 7.0.1.0.</p>
<codeclass="sig-name descname"><spanclass="pre">COREOS_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='COREOS_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.COREOS_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">CRXPOD_1</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='CRXPOD_1')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.CRXPOD_1"title="Permalink to this definition">¶</a></dt>
<dd><p>CRX Pod 1. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">DARWIN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_10</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_10')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_10_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_10_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_10_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_11</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_11')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_11_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_11_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_11_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_12_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_12_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_12_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_13_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_13_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_13_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_14_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_14_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_14_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_15_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_15_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_15_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_16_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_16_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_16_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_17_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_17_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_17_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Mac OS 10.13 (64 bit). This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_18_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_18_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_18_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Mac OS 10.14 (64 bit). This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_19_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_19_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_19_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Mac OS 10.15 (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">DARWIN_20_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_20_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_20_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Mac OS 11 (64 bit). This class attribute was added in vSphere API 7.0.1.0.</p>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_21_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_21_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_21_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Mac OS 12 (64 bit). This class attribute was added in vSphere API 7.0.1.0.</p>
<codeclass="sig-name descname"><spanclass="pre">DARWIN_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DARWIN_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DARWIN_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_10</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_10')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_10_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_10_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_10_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_11</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_11')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_11"title="Permalink to this definition">¶</a></dt>
<dd><p>Debian GNU/Linux 11. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_11_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_11_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_11_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Debian GNU/Linux 11 (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_4_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_4_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_4_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_5</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_5')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_5_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_5_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_5_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_6_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_6_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_7_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_7_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_8</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_8')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_8_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_8_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_8_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_9</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_9')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DEBIAN_9_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DEBIAN_9_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DEBIAN_9_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Debian GNU/Linux 9 (64 bit)</p>
</dd></dl>
<dlclass="py attribute">
<dtid="com.vmware.vcenter.vm_client.GuestOS.DOS">
<codeclass="sig-name descname"><spanclass="pre">DOS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='DOS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.DOS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ECOMSTATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ECOMSTATION')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ECOMSTATION_2</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ECOMSTATION_2')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ECOMSTATION_2"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">FEDORA</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FEDORA')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">FEDORA_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FEDORA_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FEDORA_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">FREEBSD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">FREEBSD_11</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD_11')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11"title="Permalink to this definition">¶</a></dt>
<dd><p>FreeBSD 11. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">FREEBSD_11_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD_11_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_11_64"title="Permalink to this definition">¶</a></dt>
<dd><p>FreeBSD 11 x64. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">FREEBSD_12</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD_12')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12"title="Permalink to this definition">¶</a></dt>
<dd><p>FreeBSD 12. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">FREEBSD_12_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD_12_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_12_64"title="Permalink to this definition">¶</a></dt>
<dd><p>FreeBSD 12 x64. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">FREEBSD_13</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD_13')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_13"title="Permalink to this definition">¶</a></dt>
<dd><p>FreeBSD 13 or later. This class attribute was added in vSphere API 7.0.1.0.</p>
<codeclass="sig-name descname"><spanclass="pre">FREEBSD_13_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD_13_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_13_64"title="Permalink to this definition">¶</a></dt>
<dd><p>FreeBSD 13 x64 or later. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">FREEBSD_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='FREEBSD_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.FREEBSD_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">GENERIC_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='GENERIC_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.GENERIC_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MANDRAKE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='MANDRAKE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.MANDRAKE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MANDRIVA</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='MANDRIVA')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MANDRIVA_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='MANDRIVA_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.MANDRIVA_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NETWARE_4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='NETWARE_4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_4"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NETWARE_5</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='NETWARE_5')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_5"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NETWARE_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='NETWARE_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NETWARE_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NLD_9</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='NLD_9')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.NLD_9"title="Permalink to this definition">¶</a></dt>
<dd><p>Novell Linux Desktop 9</p>
</dd></dl>
<dlclass="py attribute">
<dtid="com.vmware.vcenter.vm_client.GuestOS.OES">
<codeclass="sig-name descname"><spanclass="pre">OES</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OES')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OES"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OPENSERVER_5</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OPENSERVER_5')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_5"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OPENSERVER_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OPENSERVER_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSERVER_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OPENSUSE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OPENSUSE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OPENSUSE_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OPENSUSE_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OPENSUSE_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX_6_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX_6_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX_7_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX_7_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX_8_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX_8_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_8_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Oracle Linux 8 (64-bit). This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">ORACLE_LINUX_9_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='ORACLE_LINUX_9_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.ORACLE_LINUX_9_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Oracle Linux 9 (64-bit). This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
<dlclass="py attribute">
<dtid="com.vmware.vcenter.vm_client.GuestOS.OS2">
<codeclass="sig-name descname"><spanclass="pre">OS2</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OS2')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OS2"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_24X_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_24X_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_24X_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_24X_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_24X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_26X_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_26X_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_26X_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_26X_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_26X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_3X_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_3X_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_3X_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_3X_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_3X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_4X_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_4X_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX"title="Permalink to this definition">¶</a></dt>
<dd><p>Linux 4.x Kernel. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">OTHER_4X_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_4X_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_4X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Linux 4.x Kernel (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">OTHER_5X_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_5X_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_5X_LINUX"title="Permalink to this definition">¶</a></dt>
<dd><p>Linux 5.x Kernel. This class attribute was added in vSphere API 7.0.1.0.</p>
<codeclass="sig-name descname"><spanclass="pre">OTHER_5X_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_5X_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_5X_LINUX_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Linux 5.x Kernel (64 bit). This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">OTHER_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Other Operating System (64 bit) (experimental)</p>
<codeclass="sig-name descname"><spanclass="pre">OTHER_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OTHER_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='OTHER_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.OTHER_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">REDHAT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='REDHAT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.REDHAT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_2</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_2')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_2"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_3</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_3')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_3_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_3_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_3_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_4</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_4')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_4_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_4_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_4_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_5</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_5')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_5"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_5_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_5_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_5_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Red Hat Enterprise Linux 5 (64 bit) (experimental)</p>
<codeclass="sig-name descname"><spanclass="pre">RHEL_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_6_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_6_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_6_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_7_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_7_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RHEL_8_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_8_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_8_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Red Hat Enterprise Linux 8 (64 bit). This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">RHEL_9_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='RHEL_9_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.RHEL_9_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Red Hat Enterprise Linux 9 (64 bit). This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">SJDS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SJDS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SJDS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SLES</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SLES_10</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_10')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_10"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SLES_10_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_10_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_10_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 10 (64 bit) (experimental)</p>
<codeclass="sig-name descname"><spanclass="pre">SLES_11</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_11')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_11"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SLES_11_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_11_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_11_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 11 (64 bit)</p>
<codeclass="sig-name descname"><spanclass="pre">SLES_12</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_12')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_12"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SLES_12_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_12_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_12_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 12 (64 bit)</p>
<codeclass="sig-name descname"><spanclass="pre">SLES_15_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_15_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_15_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 15 (64 bit). This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">SLES_16_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_16_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_16_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 16 (64 bit). This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">SLES_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SLES_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SLES_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Suse Linux Enterprise Server 9 (64 bit)</p>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS_10</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SOLARIS_10')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS_10_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SOLARIS_10_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_10_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS_11_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SOLARIS_11_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_11_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SOLARIS_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SOLARIS_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_7"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS_8</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SOLARIS_8')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_8"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS_9</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SOLARIS_9')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SOLARIS_9"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SUSE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SUSE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SUSE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SUSE_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='SUSE_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.SUSE_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TURBO_LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='TURBO_LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TURBO_LINUX_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='TURBO_LINUX_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.TURBO_LINUX_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UBUNTU</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='UBUNTU')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UBUNTU_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='UBUNTU_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.UBUNTU_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">UNIXWARE_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='UNIXWARE_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.UNIXWARE_7"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMKERNEL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='VMKERNEL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMKERNEL_5</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='VMKERNEL_5')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_5"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMKERNEL_6</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='VMKERNEL_6')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_6"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMKERNEL_65</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='VMKERNEL_65')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_65"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VMKERNEL_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='VMKERNEL_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMKERNEL_7"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware ESX 7. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VMWARE_PHOTON_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='VMWARE_PHOTON_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.VMWARE_PHOTON_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_7</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_7')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_7_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_7_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_7_SERVER_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_7_SERVER_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_7_SERVER_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_8</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_8')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_8_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_8_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_8_SERVER_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_8_SERVER_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_8_SERVER_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_9</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_9')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_9_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_9_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_9_SERVER_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_9_SERVER_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_9_SERVER_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_HYPERV</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_HYPERV')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_HYPERV"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_SERVER_2019</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_SERVER_2019')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_SERVER_2019"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2019. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">WINDOWS_SERVER_2021</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WINDOWS_SERVER_2021')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WINDOWS_SERVER_2021"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2022. This class attribute was added in vSphere API 7.0.1.0.</p>
<codeclass="sig-name descname"><spanclass="pre">WIN_2000_ADV_SERV</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_2000_ADV_SERV')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_ADV_SERV"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_2000_PRO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_2000_PRO')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_PRO"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_2000_SERV</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_2000_SERV')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_2000_SERV"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_31</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_31')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_31"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_95</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_95')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_95"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_98</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_98')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_98"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_LONGHORN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_LONGHORN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_LONGHORN_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_LONGHORN_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_LONGHORN_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_ME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_ME')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_ME"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_BUSINESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_BUSINESS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_BUSINESS"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_DATACENTER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_DATACENTER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Datacenter Edition</p>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_DATACENTER_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_DATACENTER_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_DATACENTER_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Datacenter Edition (64 bit) (experimental)</p>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_ENTERPRISE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_ENTERPRISE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Enterprise Edition</p>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_ENTERPRISE_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_ENTERPRISE_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_ENTERPRISE_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Enterprise Edition (64 bit)</p>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_STANDARD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_STANDARD')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_STANDARD_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_STANDARD_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_STANDARD_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows Server 2003, Standard Edition (64 bit)</p>
<codeclass="sig-name descname"><spanclass="pre">WIN_NET_WEB</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NET_WEB')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NET_WEB"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_NT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_NT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_NT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_VISTA</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_VISTA')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_VISTA_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_VISTA_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_VISTA_64"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_XP_HOME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_XP_HOME')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_HOME"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_XP_PRO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_XP_PRO')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WIN_XP_PRO_64</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOS(string='WIN_XP_PRO_64')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOS.WIN_XP_PRO_64"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows XP Professional Edition (64 bit)</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">GuestOSFamily</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.vm_client.GuestOSFamily"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">GuestOSFamily</span></code> class defines the valid guest operating system family
types reported by a virtual machine. This enumeration was added in vSphere
API 6.7.</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 <aclass="reference internal"href="#com.vmware.vcenter.vm_client.GuestOSFamily"title="com.vmware.vcenter.vm_client.GuestOSFamily"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GuestOSFamily</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DARWIN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOSFamily(string='DARWIN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.DARWIN"title="Permalink to this definition">¶</a></dt>
<dd><p>Mac OS operating system. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">LINUX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOSFamily(string='LINUX')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.LINUX"title="Permalink to this definition">¶</a></dt>
<dd><p>Linux operating system. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">NETWARE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOSFamily(string='NETWARE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.NETWARE"title="Permalink to this definition">¶</a></dt>
<dd><p>Novell Netware. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">OTHER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOSFamily(string='OTHER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.OTHER"title="Permalink to this definition">¶</a></dt>
<dd><p>Other operating systems. This class attribute was added in vSphere API 6.7.</p>
<codeclass="sig-name descname"><spanclass="pre">SOLARIS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOSFamily(string='SOLARIS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.SOLARIS"title="Permalink to this definition">¶</a></dt>
<dd><p>Solaris operating system. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">WINDOWS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">GuestOSFamily(string='WINDOWS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.GuestOSFamily.WINDOWS"title="Permalink to this definition">¶</a></dt>
<dd><p>Windows operating system. This class attribute was added in vSphere API
6.7.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.Hardware">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Hardware</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.vm_client.Hardware"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Hardware</span></code> class provides methods for configuring the virtual
hardware of a virtual machine.</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">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_error</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.vm_client.Hardware.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>upgrade_version</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.Version"title="com.vmware.vcenter.vm_client.Hardware.Version"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hardware.Version</span></code></a>) – Target hardware version to be used on the next scheduled virtual
hardware upgrade.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">upgradePolicy</span></code> is one of
<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN"title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN</span></code></a> or
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_version</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.vm_client.Hardware.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>If set to <aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.UpgradePolicy.NEVER</span></code></a>, the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.Info.upgrade_version</span></code> attribute will be reset to
None.
If None, the value is unchanged.</p>
</p></li>
<li><p><strong>upgrade_version</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.Version"title="com.vmware.vcenter.vm_client.Hardware.Version"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hardware.Version</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Target hardware version to be used on the next scheduled virtual
hardware upgrade.</p>
<p>If specified, this attribute must represent a newer virtual
hardware version than the current virtual hardware version reported
in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.Info.version</span></code>.
If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.UpdateSpec.upgrade_policy</span></code> is set to
<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"title="com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Hardware.UpgradePolicy.NEVER</span></code></a>, this attribute must be None.
Otherwise, if this attribute is None, default to the most recent
virtual hardware version supported by the server.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpgradePolicy</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.vm_client.Hardware.UpgradePolicy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Hardware.UpgradePolicy</span></code> class defines the valid virtual hardware
upgrade policies for a virtual machine.</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">UpgradePolicy</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">AFTER_CLEAN_SHUTDOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradePolicy(string='AFTER_CLEAN_SHUTDOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Run scheduled upgrade when the virtual machine is powered on after a clean
<codeclass="sig-name descname"><spanclass="pre">ALWAYS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradePolicy(string='ALWAYS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.ALWAYS"title="Permalink to this definition">¶</a></dt>
<dd><p>Run scheduled upgrade when the virtual machine is powered on.</p>
<codeclass="sig-name descname"><spanclass="pre">NEVER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradePolicy(string='NEVER')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradePolicy.NEVER"title="Permalink to this definition">¶</a></dt>
<dd><p>Do not upgrade the virtual machine when it is powered on.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpgradeStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Hardware.UpgradeStatus</span></code> class defines the valid virtual hardware
upgrade statuses for a virtual machine.</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">UpgradeStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAILED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradeStatus(string='FAILED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>The most recent scheduled upgrade was not successful.</p>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradeStatus(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>No scheduled upgrade has been attempted.</p>
<codeclass="sig-name descname"><spanclass="pre">PENDING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradeStatus(string='PENDING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.PENDING"title="Permalink to this definition">¶</a></dt>
<dd><p>Upgrade is scheduled but has not yet been run.</p>
<codeclass="sig-name descname"><spanclass="pre">SUCCESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradeStatus(string='SUCCESS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.UpgradeStatus.SUCCESS"title="Permalink to this definition">¶</a></dt>
<dd><p>The most recent scheduled upgrade was successful.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Version</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.vm_client.Hardware.Version"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Hardware.Version</span></code> class defines the valid virtual hardware versions
for a virtual machine. See <aclass="reference external"href="https://kb.vmware.com/s/article/1003746">https://kb.vmware.com/s/article/1003746</a> (Virtual
machine hardware versions (1003746)).</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">Version</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_03</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_03')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_03"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 3, first supported in ESXi 2.5.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_04</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_04')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_04"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 4, first supported in ESXi 3.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_06</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_06')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_06"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 6, first supported in WS 6.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_07</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_07')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_07"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 7, first supported in ESXi 4.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_08</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_08')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_08"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 8, first supported in ESXi 5.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_09</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_09')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_09"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 9, first supported in ESXi 5.1.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_10</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_10')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_10"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 10, first supported in ESXi 5.5.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_11</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_11')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_11"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 11, first supported in ESXi 6.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_12</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_12')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_12"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 12, first supported in Workstation 12.0.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_13</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_13')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_13"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 13, first supported in ESXi 6.5.</p>
<codeclass="sig-name descname"><spanclass="pre">VMX_14</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_14')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_14"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 14, first supported in ESXi 6.7. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">VMX_15</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_15')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_15"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 15, first supported in ESXi 6.7 Update 2. This class
<codeclass="sig-name descname"><spanclass="pre">VMX_16</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_16')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_16"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 16, first supported in Workstation 15.0. This class
<codeclass="sig-name descname"><spanclass="pre">VMX_17</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_17')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_17"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 17, first supported in ESXi 7.0.0-0. This class attribute
<codeclass="sig-name descname"><spanclass="pre">VMX_18</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_18')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_18"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 18, first supported in ESXi 7.0 U1. This class attribute
<codeclass="sig-name descname"><spanclass="pre">VMX_19</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Version(string='VMX_19')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.Version.VMX_19"title="Permalink to this definition">¶</a></dt>
<dd><p>Hardware version 19, first supported in ESXi 7.0 U2. This class attribute
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the virtual hardware settings of a virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Hardware.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the virtual hardware settings of a virtual machine.</p>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Hardware.UpdateSpec"title="com.vmware.vcenter.vm_client.Hardware.UpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hardware.UpdateSpec</span></code></a>) – Specification for updating the virtual hardware settings of the
<codeclass="sig-name descname"><spanclass="pre">upgrade</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</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.vm_client.Hardware.upgrade"title="Permalink to this definition">¶</a></dt>
<dd><p>Upgrades the virtual machine to a newer virtual hardware version.</p>
if the user doesn’t have the required privileges.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.Identity">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Identity</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.vm_client.Identity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Identity</span></code> class provides methods for managing the identity of a
virtual machine. 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">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">bios_uuid</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">instance_uuid</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.vm_client.Identity.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Identity.Info</span></code> class contains information about the identity of a
virtual machine. 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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Virtual machine name. This attribute was added in vSphere API
6.7.1.</p></li>
<li><p><strong>bios_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 128-bit SMBIOS UUID of a virtual machine represented as a
hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
format. This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>instance_uuid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – VirtualCenter-specific 128-bit UUID of a virtual machine,
represented as a hexademical string. This identifier is used by
VirtualCenter to uniquely identify all virtual machine instances,
including those that may share the same SMBIOS UUID. This attribute
was added in vSphere API 6.7.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.LibraryItem">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LibraryItem</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.vm_client.LibraryItem"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem</span></code> class provides methods to identify virtual machines
managed by Content Library. This class was added in vSphere API 6.9.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">CheckOutInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">library_item</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.vm_client.LibraryItem.CheckOutInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.CheckOutInfo</span></code> class contains information about a virtual
machine checked out of a content library item. This class was added in
vSphere API 6.9.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>library_item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item that the virtual machine is checked
out from. This attribute was added in vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.</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">check_out</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.vm_client.LibraryItem.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItem.Info</span></code> class contains information about the library item
associated with a virtual machine. This class was added in vSphere API
6.9.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>check_out</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo"title="com.vmware.vcenter.vm_client.LibraryItem.CheckOutInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItem.CheckOutInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about the checked out virtual machine. This attribute
was added in vSphere API 6.9.1.
If None, the virtual machine is not checked out from a library
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.LibraryItem.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the information about the library item associated with the
virtual machine. This method was added in vSphere API 6.9.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.Power">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Power</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.vm_client.Power"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Power</span></code> class provides methods for managing the power state of a
virtual machine.</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>
</dd>
</dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.Power.Info">
<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">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">clean_power_off</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.vm_client.Power.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Power.Info</span></code> class contains information about the power state of a
virtual machine.</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>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Power.State"title="com.vmware.vcenter.vm_client.Power.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Power.State</span></code></a>) – Power state of the virtual machine.</p></li>
<li><p><strong>clean_power_off</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether the virtual machine was powered off
cleanly. This attribute may be used to detect that the virtual
machine crashed unexpectedly and should be restarted.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.vm_client.Power.State.POWERED_OFF"title="com.vmware.vcenter.vm_client.Power.State.POWERED_OFF"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Power.State.POWERED_OFF</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.Power.State">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">State</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Power.State</span></code> class defines the valid power states for a virtual
machine.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">State</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">POWERED_OFF</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='POWERED_OFF')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State.POWERED_OFF"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">POWERED_ON</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='POWERED_ON')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State.POWERED_ON"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SUSPENDED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='SUSPENDED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.State.SUSPENDED"title="Permalink to this definition">¶</a></dt>
<dd><p>The virtual machine is suspended.</p>
</dd></dl>
</dd></dl>
<dlclass="py method">
<dtid="com.vmware.vcenter.vm_client.Power.get">
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the power state information of a virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">reset</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.reset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">start</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Powers on a powered-off or suspended virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">stop</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.stop"title="Permalink to this definition">¶</a></dt>
<dd><p>Powers off a powered-on or suspended virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">suspend</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Power.suspend"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_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.vm_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.vm_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Tools</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.vm_client.Tools"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tools</span></code> class provides methods for managing VMware Tools in the guest
operating system. This class was added in vSphere API 7.0.0.0.</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>
</dd>
</dl>
<dlclass="py class">
<dtid="com.vmware.vcenter.vm_client.Tools.Info">
<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">auto_update_supported</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">install_attempt_count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">error</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version_number</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version_status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">install_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">run_state</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.vm_client.Tools.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tools.Info</span></code> class describes the VMWare Tools properties of a virtual
machine. This class was added in vSphere API 7.0.0.0.</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>auto_update_supported</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Set if the virtual machine supports auto-upgrading Tools via
<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy"title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.UpgradePolicy</span></code></a>. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>install_attempt_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of attempts that have been made to install or upgrade the
version of Tools installed on this virtual machine. This attribute
was added in vSphere API 7.0.0.0.
This attribute will be None if there have been no Tools install or
upgrade attempt.</p></li>
<li><p><strong>error</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Error that happened, if any, during last attempt to upgrade or
install Tools. This attribute was added in vSphere API 7.0.0.0.
This attribute will be None if a the last Tools install or upgrade
attempt succeeded.</p></li>
<li><p><strong>version_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version of VMware Tools installed on the guest operating system.
This attribute was added in vSphere API 7.0.0.0.
This attribute wil be None if VMWare Tools is not installed. This
is an integer constructed as follows: (((MJR) << 10) + ((MNR) << 5)
+ (REV)) Where MJR is tha major verson, MNR is the minor version
and REV is the revision. Tools version = T Tools Version Major =
MJR = (T / 1024) Tools Version Minor = MNR = ((T % 1024) / 32)
Tools Version Revision = BASE = ((T % 1024) % 32) Tools actual
version = MJR.MNR.REV</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version of VMware Tools installed on the guest operating system.
This is a human-readable value that should not be parsed. This
attribute was added in vSphere API 7.0.0.0.
This attribute wil be None if VMWare Tools is not installed.</p></li>
<li><p><strong>upgrade_policy</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy"title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.UpgradePolicy</span></code></a>) – Tools upgrade policy setting for the virtual machine.
<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy"title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.UpgradePolicy</span></code></a>. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>version_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus"title="com.vmware.vcenter.vm_client.Tools.VersionStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.VersionStatus</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Current version status of VMware Tools in the guest operating
system, if known. This attribute was added in vSphere API 7.0.0.0.
This attribute will be None if the version status is not known, for
example if VMware Tools is too old to report the information.</p></li>
<li><p><strong>install_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType"title="com.vmware.vcenter.vm_client.Tools.ToolsInstallType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.ToolsInstallType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Current installation type of VMware Tools in the guest operating
system. This attribute was added in vSphere API 7.0.0.0.
This attribute will be None if the installation type is not known,
for example if VMware Tools is too old to report the information.</p></li>
<li><p><strong>run_state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.RunState"title="com.vmware.vcenter.vm_client.Tools.RunState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.RunState</span></code></a>) – Current run state of VMware Tools in the guest operating system.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RunState</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.vm_client.Tools.RunState"title="Permalink to this definition">¶</a></dt>
<p>Current run state of VMware Tools in the guest operating system. This
enumeration was added in vSphere API 7.0.0.0.</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">RunState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">EXECUTING_SCRIPTS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RunState(string='EXECUTING_SCRIPTS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.RunState.EXECUTING_SCRIPTS"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is running scripts as part of a state transition. This class
<codeclass="sig-name descname"><spanclass="pre">NOT_RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RunState(string='NOT_RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.RunState.NOT_RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is not running. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RunState(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.RunState.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is running. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ToolsInstallType</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.vm_client.Tools.ToolsInstallType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tools.ToolsInstallType</span></code> class defines the installation type of the
Tools in the guest operating system. This enumeration was added in vSphere
API 7.0.0.0.</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">ToolsInstallType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">MSI</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ToolsInstallType(string='MSI')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.MSI"title="Permalink to this definition">¶</a></dt>
<dd><p>MSI is the installation type used for VMware Tools on Windows. This class
<codeclass="sig-name descname"><spanclass="pre">OPEN_VM_TOOLS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ToolsInstallType(string='OPEN_VM_TOOLS')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.OPEN_VM_TOOLS"title="Permalink to this definition">¶</a></dt>
<dd><p>open-vm-tools are the open-source version of VMware Tools, may have been
packaged by the OS vendor. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">OSP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ToolsInstallType(string='OSP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.OSP"title="Permalink to this definition">¶</a></dt>
<dd><p>OSPs are RPM or Debian packages tailored for the OS in the VM. See
<aclass="reference external"href="http://packages.vmware.com">http://packages.vmware.com</a>. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">TAR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ToolsInstallType(string='TAR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.TAR"title="Permalink to this definition">¶</a></dt>
<dd><p>Tools have been installed by the tar installer. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">UNKNOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ToolsInstallType(string='UNKNOWN')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.ToolsInstallType.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Installation type is not known. Most likely tools have been installed by
OSPs or open-vm-tools, but a version that does not report its install type
or an install type that we do not recognize. This class attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_policy</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.vm_client.Tools.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The (\@name UpdateSpec} class describes the VMware Tools properties of a
virtual machine that can be updated. This class was added in vSphere API
7.0.0.0.</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>upgrade_policy</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy"title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.UpgradePolicy</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Tools upgrade policy setting for the virtual machine.
<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy"title="com.vmware.vcenter.vm_client.Tools.UpgradePolicy"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tools.UpgradePolicy</span></code></a>. This attribute was added in vSphere
API 7.0.0.0.
If None the upgrade policy will not be modified.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpgradePolicy</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.vm_client.Tools.UpgradePolicy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tools.UpgradePolicy</span></code> class defines when Tools are auto-upgraded for
a virtual machine. This enumeration was added in vSphere API 7.0.0.0.</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">UpgradePolicy</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradePolicy(string='MANUAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>No auto-upgrades for Tools will be performed for this virtual machine.
Users must manually invoke the <aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.upgrade"title="com.vmware.vcenter.vm_client.Tools.upgrade"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Tools.upgrade()</span></code></a> method to update
Tools. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">UPGRADE_AT_POWER_CYCLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UpgradePolicy(string='UPGRADE_AT_POWER_CYCLE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.UpgradePolicy.UPGRADE_AT_POWER_CYCLE"title="Permalink to this definition">¶</a></dt>
<dd><p>When the virtual machine is power-cycled, the system checks for a newer
version of Tools when the virtual machine is powered on. If it is
available, a Tools upgrade is automatically performed on the virtual
machine and it is rebooted if necessary. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VersionStatus</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.vm_client.Tools.VersionStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tools.VersionStatus</span></code> class defines the version status types of
VMware Tools installed in the guest operating system. This enumeration was
added in vSphere API 7.0.0.0.</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">VersionStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BLACKLISTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='BLACKLISTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.BLACKLISTED"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is installed, but the installed version is known to have a
grave bug and should be immediately upgraded. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">CURRENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='CURRENT')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.CURRENT"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is installed, and the version is current. This class attribute
<codeclass="sig-name descname"><spanclass="pre">NOT_INSTALLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='NOT_INSTALLED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.NOT_INSTALLED"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools has never been installed. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">SUPPORTED_NEW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='SUPPORTED_NEW')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.SUPPORTED_NEW"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is installed, supported, and newer than the version available
on the host. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">SUPPORTED_OLD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='SUPPORTED_OLD')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.SUPPORTED_OLD"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is installed, supported, but a newer version is available.
This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">TOO_NEW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='TOO_NEW')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.TOO_NEW"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is installed, and the version is known to be too new to work
correctly with this virtual machine. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">TOO_OLD_UNSUPPORTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='TOO_OLD_UNSUPPORTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.TOO_OLD_UNSUPPORTED"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is installed, but the version is too old. This class attribute
<codeclass="sig-name descname"><spanclass="pre">UNMANAGED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VersionStatus(string='UNMANAGED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.VersionStatus.UNMANAGED"title="Permalink to this definition">¶</a></dt>
<dd><p>VMware Tools is installed, but it is not managed by VMware. This includes
open-vm-tools or OSPs which should be managed by the guest operating
system. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dlclass="py method">
<dtid="com.vmware.vcenter.vm_client.Tools.get">
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the properties of VMware Tools. This method was added in vSphere
API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_client.Tools.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Update the properties of VMware Tools. This method was added in vSphere
API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">upgrade</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">command_line_options</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.vm_client.Tools.upgrade"title="Permalink to this definition">¶</a></dt>
<dd><p>Begins the Tools upgrade process. To monitor the status of the Tools
upgrade, clients should check the Tools status by calling
<aclass="reference internal"href="#com.vmware.vcenter.vm_client.Tools.get"title="com.vmware.vcenter.vm_client.Tools.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Tools.get()</span></code></a> and examining <codeclass="docutils literal notranslate"><spanclass="pre">versionStatus</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">runState</span></code>.
This method was added in vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the virtual machine.
The parameter must be an identifier for the resource type:
<li><p><strong>command_line_options</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Command line options passed to the installer to modify the
installation procedure for Tools.
Set if any additional options are desired.</p></li>
<spanid="com-vmware-vcenter-vm-template-client-module"></span><h2>com.vmware.vcenter.vm_template_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vm_template_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_template_client</span></code> module provides classes and
classes that will let its client manage VMTX template in Content Library.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_template_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LibraryItems</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.vm_template_client.LibraryItems"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems</span></code> class provides methods to deploy virtual machines from
library items containing virtual machine templates, as well as methods to
create library items containing virtual machine templates. The
<codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems</span></code> class also provides an operation to retrieve information
about the template contained in the library item. This class was added in
vSphere API 6.8.</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">CpuInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">count</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cores_per_socket</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.vm_template_client.LibraryItems.CpuInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.CpuInfo</span></code> class contains CPU related information about
the virtual machine template. This class was added in vSphere API 6.8.</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>count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of CPU cores per socket. This attribute was added in vSphere
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CpuUpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">num_cpus</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">num_cores_per_socket</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.vm_template_client.LibraryItems.CpuUpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.CpuUpdateSpec</span></code> class describes updates to the CPU
configuration of the deployed virtual machine. This class was added in
vSphere API 6.8.</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>num_cpus</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of virtual processors in the deployed virtual machine. This
attribute was added in vSphere API 6.8.
If {\@term.unset}, the deployed virtual machine has the same CPU
count as the source virtual machine template contained in the
library item.</p></li>
<li><p><strong>num_cores_per_socket</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of cores among which to distribute CPUs in the deployed
virtual machine. This attribute was added in vSphere API 6.8.
If {\@term.unset}, the deployed virtual machine has the same
number of cores per socket as the source virtual machine template
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreatePlacementSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">folder</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_pool</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.CreatePlacementSpec</span></code> class contains information used to
place a virtual machine template onto resources within the vCenter
inventory. This class was added in vSphere API 6.8.</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>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine folder into which the virtual machine template
should be placed. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
If None, the virtual machine template will be placed in the same
folder as the source virtual machine.</p></li>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the virtual machine template should be
placed. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None, the system will attempt to choose a suitable resource pool
for the virtual machine template; if a resource pool cannot be
chosen, the library item creation operation will fail.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host onto which the virtual machine template should be placed. If
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code>
must belong to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are both
specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. This attribute
was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine template; if a host cannot be chosen,
the library item creation operation will fail.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster onto which the virtual machine template should be placed.
If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of
<codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is specified, it is recommended
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpec</span></code> class defines the information required to
create a library item containing a virtual machine template. This class was
added in vSphere API 6.8.</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>source_vm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the source virtual machine to create the library item
from. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">VirtualMachine</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the library item. This attribute was added in vSphere API
6.8.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the library item. This attribute was added in
vSphere API 6.8.
If None, the newly created library item has the same description as
the source virtual machine.</p></li>
<li><p><strong>library</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library in which the new library item should be
created. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.Library</span></code>.</p></li>
<li><p><strong>vm_home_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStorage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecVmHomeStorage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage location for the virtual machine template’s configuration
and log files. This attribute was added in vSphere API 6.8.
If None, the virtual machine template’s configuration and log files
are placed on the default storage backing associated with the
library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p></li>
<li><p><strong>disk_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecDiskStorage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Storage specification for the virtual machine template’s disks.
This attribute was added in vSphere API 6.8.
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
virtual machine template’s disks are placed in the default storage
backing associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the virtual machine template’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are placed in the default storage backing
associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>disk_storage_overrides</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStorage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecDiskStorage</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Storage specification for individual disks in the virtual machine
template. This is specified as a mapping between disk identifiers
in the source virtual machine and their respective storage
specifications. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
virtual machine template’s disks are placed in the default storage
backing associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the virtual machine template’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are placed in the default storage backing
associated with the library specified by <codeclass="docutils literal notranslate"><spanclass="pre">library</span></code>.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreatePlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreatePlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Information used to place the virtual machine template. This
attribute was added in vSphere API 6.8.
This attribute is currently required. In the future, if this
attribute is None, the system will place the virtual machine
template on a suitable resource.</p>
<p>If specified, each attribute will be used for placement. If the
attributes result in disjoint placement, the operation will fail.
If the attributes along with the placement values of the source
virtual machine result in disjoint placement, the operation will
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpecDiskStorage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</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.vm_template_client.LibraryItems.CreateSpecDiskStorage"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecDiskStorage</span></code> class defines the storage
specification for a virtual machine template’s disks. This class was added
in vSphere API 6.8.</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>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier for the datastore associated with a virtual machine
template’s disk. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpecDiskStoragePolicy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">policy</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.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecDiskStoragePolicy</span></code> class defines the storage
policy specification for a virtual machine template’s disks. This class was
added in vSphere API 6.8.</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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecDiskStoragePolicy.Type</span></code></a>) – Policy type to be used when creating a virtual machine template’s
disk. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is
<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.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
<p>Policy type for a virtual machine template’s disk. This enumeration was
added in vSphere API 6.8.</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">USE_SPECIFIED_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpecVmHomeStorage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</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.vm_template_client.LibraryItems.CreateSpecVmHomeStorage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier of the datastore for the virtual machine template’s
configuration and log files. This attribute was added in vSphere
API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpecVmHomeStoragePolicy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">policy</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.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpecVmHomeStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the virtual machine template’s
configuration and log files. This attribute was added in vSphere
API 6.8.</p></li>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is
<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.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
<p>Policy type for the virtual machine template’s configuration and log files.
This enumeration was added in vSphere API 6.8.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname"><spanclass="pre">USE_SPECIFIED_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeployPlacementSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">folder</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resource_pool</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>folder</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Virtual machine folder into which the deployed virtual machine
should be placed. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Folder</span></code>.
This attribute is currently required.</p>
<p>If None, the system will attempt to choose a suitable folder for
the virtual machine; if a folder cannot be chosen, the virtual
machine deployment operation will fail.</p>
</p></li>
<li><p><strong>resource_pool</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource pool into which the deployed virtual machine should be
placed. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ResourcePool</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
If None, the system will attempt to choose a suitable resource pool
for the virtual machine; if a resource pool cannot be chosen, the
virtual machine deployment operation will fail.</p></li>
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host onto which the virtual machine should be placed. If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>
and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must
belong to <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. This attribute was added
in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute may be None if <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is
specified. If None, the system will attempt to choose a suitable
host for the virtual machine; if a host cannot be chosen, the
virtual machine deployment operation will fail.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster onto which the deployed virtual machine should be placed.
If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> are both specified,
<codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> must belong to <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. If <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> and
<codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> are both specified, <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> must be a member of
<codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code>. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If <codeclass="docutils literal notranslate"><spanclass="pre">resourcePool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">host</span></code> is specified, it is recommended
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the deployed virtual machine. This attribute was added in
vSphere API 6.8.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the deployed virtual machine. This attribute was
added in vSphere API 6.8.
If None, the deployed virtual machine has the same description as
the source library item.</p></li>
<li><p><strong>vm_home_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStorage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpecVmHomeStorage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Storage location for the deployed virtual machine’s configuration
and log files. This attribute was added in vSphere API 6.8.
If None, the deployed virtual machine’s configuration and log files
are created with the same storage spec as the source virtual
machine template’s configuration and log files.</p></li>
<li><p><strong>disk_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpecDiskStorage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Storage specification for the deployed virtual machine’s disks.
This attribute was added in vSphere API 6.8.
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
deployed virtual machine’s disks are created with the same storage
spec as the corresponding disks in the source virtual machine
template contained in the library item.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the deployed virtual machine’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are created with the same storage spec as
the corresponding disks in the source virtual machine template
contained in the library item.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>disk_storage_overrides</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStorage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpecDiskStorage</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Storage specification for individual disks in the deployed virtual
machine. This is specified as a mapping between disk identifiers in
the source virtual machine template contained in the library item
and their storage specifications. This attribute was added in
vSphere API 6.8.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are None, the
deployed virtual machine’s disks are created with the same storage
spec as the corresponding disks in the source virtual machine
template contained in the library item.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is None and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
specified, all of the deployed virtual machine’s disks are created
with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> is specified and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> is
None, disks with identifiers that are not in
<codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are created with the same storage spec as
the corresponding disks in the source virtual machine template
contained in the library item.</p>
<p>If both <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code> are specified,
disks with identifiers that are not in <codeclass="docutils literal notranslate"><spanclass="pre">diskStorageOverrides</span></code> are
created with the storage spec specified by <codeclass="docutils literal notranslate"><spanclass="pre">diskStorage</span></code>.</p>
</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeployPlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeployPlacementSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Information used to place the deployed virtual machine. This
attribute was added in vSphere API 6.8.
This attribute is currently required. In the future, if this
attribute is None, the system will use the values from the source
virtual machine template contained in the library item.</p>
<p>If specified, each attribute will be used for placement. If the
attributes result in disjoint placement, the operation will fail.
If the attributes along with the placement values of the source
virtual machine template result in disjoint placement, the
operation will fail.</p>
</p></li>
<li><p><strong>powered_on</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies whether the deployed virtual machine should be powered on
after deployment. This attribute was added in vSphere API 6.8.
If None, the virtual machine will not be powered on after
deployment.</p></li>
<li><p><strong>guest_customization</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.GuestCustomizationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Guest customization spec to apply to the deployed virtual machine.
This attribute was added in vSphere API 6.8.
If None, the guest operating system is not customized after
deployment.</p></li>
<li><p><strong>hardware_customization</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.HardwareCustomizationSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.HardwareCustomizationSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Hardware customization spec which specifies updates to the deployed
virtual machine. This attribute was added in vSphere API 6.8.
If None, the deployed virtual machine has the same hardware
configuration as the source virtual machine template contained in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeploySpecDiskStorage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</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.vm_template_client.LibraryItems.DeploySpecDiskStorage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier for the datastore associated the deployed virtual
machine’s disk. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeploySpecDiskStoragePolicy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">policy</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.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpecDiskStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the deployed virtual machine’s
disk. This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the storage policy to use. This attribute was added
in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is
<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.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
<p>Policy type for the deployed virtual machine’s disk. This enumeration was
added in vSphere API 6.8.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname"><spanclass="pre">USE_SOURCE_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USE_SOURCE_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SOURCE_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the storage policy that is associated with the corresponding disk in
the source virtual machine template. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">USE_SPECIFIED_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeploySpecVmHomeStorage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</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.vm_template_client.LibraryItems.DeploySpecVmHomeStorage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier of the datastore for the deployed virtual machine’s
configuration and log files. This attribute was added in vSphere
API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DeploySpecVmHomeStoragePolicy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">policy</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.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpecVmHomeStoragePolicy.Type</span></code></a>) – Policy type to be used when creating the deployed virtual machine’s
configuration and log files. This attribute was added in vSphere
API 6.8.</p></li>
<li><p><strong>policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the storage policy to use. This attribute was added
in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is
<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.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type"title="Permalink to this definition">¶</a></dt>
<p>Policy type for the deployed virtual machine’s configuration and log files.
This enumeration was added in vSphere API 6.8.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname"><spanclass="pre">USE_SOURCE_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USE_SOURCE_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SOURCE_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the storage policy that is associated with the source virtual machine
template’s configuration and log files. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">USE_SPECIFIED_POLICY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='USE_SPECIFIED_POLICY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the specified policy. This class attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DiskInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disk_storage</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.vm_template_client.LibraryItems.DiskInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Capacity of the virtual disk in bytes. This attribute was added in
vSphere API 6.8.
This attribute will be None if the virtual disk is inaccessible.</p></li>
<li><p><strong>disk_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskStorageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DiskStorageInfo</span></code></a>) – Disk storage related information. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DiskStorageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</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.vm_template_client.LibraryItems.DiskStorageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore where the disk is stored. This
attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the storage policy associated with the virtual disk.
This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>.
If None, the virtual disk does not have a storage policy associated
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DiskUpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">capacity</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.vm_template_client.LibraryItems.DiskUpdateSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Updated capacity of the virtual disk backing in bytes. This value
has to be larger than the original capacity of the disk. This
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">EthernetInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">backing_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">mac_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">network</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.vm_template_client.LibraryItems.EthernetInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>backing_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.EthernetInfo.NetworkBackingType</span></code></a>) – Network backing type for the virtual Ethernet adapter. This
attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>mac_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"title="com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.EthernetInfo.MacAddressType</span></code></a>) – MAC address type of the ethernet adapter. This attribute was added
in vSphere API 6.8.</p></li>
<li><p><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the network backing the virtual Ethernet adapter.
This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
This attribute will be None if the identifier of the network
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">MacAddressType</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.vm_template_client.LibraryItems.EthernetInfo.MacAddressType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.EthernetInfo.MacAddressType</span></code> class defines the valid
MAC address origins for a virtual Ethernet adapter. This enumeration was
added in vSphere API 6.8.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname"><spanclass="pre">ASSIGNED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MacAddressType(string='ASSIGNED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.ASSIGNED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is assigned by vCenter Server. This class attribute was added
<codeclass="sig-name descname"><spanclass="pre">GENERATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MacAddressType(string='GENERATED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.GENERATED"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is generated automatically. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MacAddressType(string='MANUAL')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.MacAddressType.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>MAC address is assigned statically. This class attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">NetworkBackingType</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.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LibraryItems.EthernetInfo.NetworkBackingType</span></code> class defines valid
network backing types for a virtual Ethernet adapter. This enumeration was
added in vSphere API 6.8.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname"><spanclass="pre">DISTRIBUTED_PORTGROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkBackingType(string='DISTRIBUTED_PORTGROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.DISTRIBUTED_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>Distributed virtual switch backing. This class attribute was added in
<codeclass="sig-name descname"><spanclass="pre">HOST_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkBackingType(string='HOST_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.HOST_DEVICE"title="Permalink to this definition">¶</a></dt>
<dd><p>Legacy host device network backing. Imported VMs may have virtual Ethernet
adapters with this type of backing, but this type of backing cannot be used
to create or to update a virtual Ethernet adapter. This class attribute was
<codeclass="sig-name descname"><spanclass="pre">OPAQUE_NETWORK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkBackingType(string='OPAQUE_NETWORK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.OPAQUE_NETWORK"title="Permalink to this definition">¶</a></dt>
<dd><p>Opaque network backing. This class attribute was added in vSphere API 6.8.</p>
<codeclass="sig-name descname"><spanclass="pre">STANDARD_PORTGROUP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">NetworkBackingType(string='STANDARD_PORTGROUP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.EthernetInfo.NetworkBackingType.STANDARD_PORTGROUP"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere standard portgroup network backing. This class attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">EthernetUpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">network</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.vm_template_client.LibraryItems.EthernetUpdateSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>network</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Identifier of the network backing the virtual Ethernet adapter.
This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">Network</span></code>.
This attribute is currently required.</p>
<p>If None, the virtual Ethernet adapter will be connected to same
network as it was in the source virtual machine template.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">GuestCustomizationSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.GuestCustomizationSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the customization specification. This attribute was added
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HardwareCustomizationSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">nics</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disks_to_remove</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">disks_to_update</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_update</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory_update</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.vm_template_client.LibraryItems.HardwareCustomizationSpec"title="Permalink to this definition">¶</a></dt>
If None, all Ethernet adapters will remain connected to the same
network as they were in the source virtual machine template. An
Ethernet adapter with a MacAddressType of MANUAL will not change.
An Ethernet adapter with a MacAddressType of GENERATED or ASSIGNED
will receive a new address.</p></li>
<li><p><strong>disks_to_remove</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Idenfiers of disks to remove from the deployed virtual machine.
This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return a
value of this class as a return value, the attribute will contain
If None, disks in the deployed virtual machine will have the same
settings as the corresponding disks in the source virtual machine
template contained in the library item.</p></li>
<li><p><strong>cpu_update</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CpuUpdateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – CPU update specification for the deployed virtual machine. This
attribute was added in vSphere API 6.8.
If {\@term.unset}, the deployed virtual machine has the same CPU
settings as the source virtual machine template contained in the
library item.</p></li>
<li><p><strong>memory_update</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.MemoryUpdateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Memory update specification for the deployed virtual machine. This
attribute was added in vSphere API 6.8.
If {\@term.unset}, the deployed virtual machine has the same
memory settings as the source virtual machine template contained in
<li><p><strong>guest_os</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_client.GuestOS"title="com.vmware.vcenter.vm_client.GuestOS"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm_client.GuestOS</span></code></a>) – Configured guest operating system of the virtual machine template.
This attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>cpu</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.CpuInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CpuInfo</span></code></a>) – CPU configuration of the virtual machine template. This attribute
was added in vSphere API 6.8.</p></li>
<li><p><strong>memory</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.MemoryInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.MemoryInfo</span></code></a>) – Memory configuration of the virtual machine template. This
attribute was added in vSphere API 6.8.</p></li>
<li><p><strong>vm_home_storage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.VmHomeStorageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.VmHomeStorageInfo</span></code></a>) – Storage information about the virtual machine template’s
configuration and log files. This attribute was added in vSphere
API 6.8.</p></li>
<li><p><strong>disks</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo"title="com.vmware.vcenter.vm_template_client.LibraryItems.DiskInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DiskInfo</span></code></a>) – Storage information about the virtual machine template’s virtual
disks. This attribute was added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vm.hardware.Disk</span></code>. When methods return
a value of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><p><strong>vm_template</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the latest virtual machine template contained in the
library item. This attribute is the managed object identifier used
to identify the virtual machine template in the vSphere Management
(SOAP) API. This attribute was added in vSphere API 6.8.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">MemoryInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">size_mib</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.vm_template_client.LibraryItems.MemoryInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>size_mib</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Memory size in mebibytes. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">MemoryUpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">memory</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.vm_template_client.LibraryItems.MemoryUpdateSpec"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>memory</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Size of a virtual machine’s memory in MB. This attribute was added
in vSphere API 6.8.
If {\@term.unset}, the deployed virtual machine has the same
memory size as the source virtual machine template.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VmHomeStorageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">datastore</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage_policy</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.vm_template_client.LibraryItems.VmHomeStorageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>datastore</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the datastore where the virtual machine template’s
configuration and log files are stored. This attribute was added in
vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>storage_policy</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the storage policy associated with the virtual
machine template’s configuration and log files. This attribute was
added in vSphere API 6.8.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.spbm.StorageProfile</span></code>.
If None, the virtual machine template’s configuration and log files
do not have a storage policy associated with them.</p></li>
<codeclass="sig-name descname"><spanclass="pre">create</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.vm_template_client.LibraryItems.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a library item in content library from a virtual machine. This
method creates a library item in content library whose content is a
virtual machine template created from the source virtual machine, using
the supplied create specification. The virtual machine template is
stored in a newly created library item. This method was added in
vSphere API 6.8.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.CreateSpec</span></code></a>) – information used to create the library item from the source virtual
<codeclass="sig-name descname"><spanclass="pre">deploy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">template_library_item</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.deploy"title="Permalink to this definition">¶</a></dt>
<dd><p>Deploys a virtual machine as a copy of the source virtual machine
template contained in the library item specified by
<codeclass="docutils literal notranslate"><spanclass="pre">template_library_item</span></code>. It uses the deployment specification in
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpec.guest_customization</span></code> are specified, the
server triggers the power on and/or guest customization operations,
which are executed asynchronously. This method was added in vSphere API
6.8.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>template_library_item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the content library item containing the source
virtual machine template to be deployed.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"title="com.vmware.vcenter.vm_template_client.LibraryItems.DeploySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LibraryItems.DeploySpec</span></code></a>) – specification of how the virtual machine should be deployed.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">template_library_item</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.vm_template_client.LibraryItems.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about a virtual machine template contained in the
library item specified by <codeclass="docutils literal notranslate"><spanclass="pre">template_library_item</span></code>. This method was
added in vSphere API 6.8.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>template_library_item</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of the library item containing the virtual machine
template.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vm_template_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.vm_template_client.StubFactory"title="Permalink to this definition">¶</a></dt>
