<spanid="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-package"></span><h1>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters"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-trusted-infrastructure-trust-authority-clusters-attestation-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_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.trust_authority_clusters.attestation_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ServiceStatus</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.trust_authority_clusters.attestation_client.ServiceStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus</span></code> class provides methods to get the Attestation Service
health status. 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">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.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus.Health</span></code> class defines the possible service health
states. 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
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is not functioning. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>No status available. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='OK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.OK"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is functioning normally. This class attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is functioning, however there is an issue that requires attention.
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">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">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.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus.Info</span></code> class contains information that describes the
status of the 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>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceStatus.Health</span></code></a>) – The service health status. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>details</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>Details regarding the health of the service.</p>
<p>When the service <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus.Health</span></code> is not
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.OK"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.OK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ServiceStatus.Health.OK</span></code></a> or
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.NONE"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ServiceStatus.Health.NONE</span></code></a>, this member will provide an
actionable description of the issues present.. This attribute was
<codeclass="sig-name descname"><spanclass="pre">get_task</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.trust_authority_clusters.attestation_client.ServiceStatus.get_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the Attestation service health in the given cluster. 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>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of 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.trusted_infrastructure.trust_authority_clusters.attestation_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.trust_authority_clusters.attestation_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-kms-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_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.trust_authority_clusters.kms_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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers</span></code> interface provides methods to create, update and delete
Key Providers that handoff to key servers. 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">CreateSpec</span></code><spanclass="sig-paren">(</span><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">master_key_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">key_server</span></span><spanclass="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.trust_authority_clusters.kms_client.Providers.CreateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>master_key_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Master key ID created for the provider.</p>
<p>A unique Key ID.. This attribute was added in vSphere API 7.0.0.0.</p>
</p></li>
<li><p><strong>key_server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KeyServerCreateSpec</span></code></a>) – Key server associated with this Provider. This attribute was added
<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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Health</span></code> class defines the possible health states. 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">Health</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Not healthy. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>No status available. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='OK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.OK"title="Permalink to this definition">¶</a></dt>
<dd><p>Health is normal. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>Health is normal, however there is an issue that requires attention. 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">master_key_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">key_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">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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Info</span></code> class contains attributes that describe the current
configuration of a 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>master_key_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Master key identifier created for the provider.</p>
<p>A unique Key identifier.. This attribute was added in vSphere API
7.0.0.0.</p>
</p></li>
<li><p><strong>key_server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KeyServerInfo</span></code></a>) – Key server associated with this provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Status"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Status</span></code></a>) – Status of the provider in the cluster. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">KeyServerCreateSpec</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">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">proxy_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">connection_timeout</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">kmip_server</span></span><spanclass="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.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.KeyServerCreateSpec</span></code> class contains attributes that
describe the desired configuration for the key 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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KeyServerCreateSpec.Type</span></code></a>) – Type of the key server. 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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the key server. This attribute was added in vSphere
API 7.0.0.0.
If None, description will not be added.</p></li>
<li><p><strong>proxy_server</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Proxy server configuration. This attribute was added in vSphere API
7.0.0.0.
If None, the key server will not use a proxy server.</p></li>
<li><p><strong>connection_timeout</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Connection timeout in seconds. This attribute was added in vSphere
API 7.0.0.0.
If None, connection timeout will not be set.</p></li>
<li><p><strong>kmip_server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerCreateSpec"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerCreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KmipServerCreateSpec</span></code></a>) – Configuration information for Key Management Interoperability
Protocol (KMIP) based key server. 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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type.KMIP"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type.KMIP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.KeyServerCreateSpec.Type.KMIP</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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.KeyServerCreateSpec.Type</span></code> class lists the key server
types. 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">KMIP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='KMIP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type.KMIP"title="Permalink to this definition">¶</a></dt>
<dd><p>Key Management Interoperability Protocol (KMIP) based key management
server. 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">KeyServerInfo</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">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">proxy_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">connection_timeout</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">kmip_server</span></span><spanclass="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.trust_authority_clusters.kms_client.Providers.KeyServerInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.KeyServerInfo</span></code> class contains attributes that describe the
current configuration of a key 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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KeyServerInfo.Type</span></code></a>) – Type of the key server. 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 key server. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>proxy_server</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Proxy server configuration.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, proxy server configuration will not be set.</p>
</p></li>
<li><p><strong>connection_timeout</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Connection timeout in seconds.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, connection timeout will be unset.</p>
</p></li>
<li><p><strong>kmip_server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerInfo"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KmipServerInfo</span></code></a>) – Configuration information for KMIP based key server. 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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type.KMIP"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type.KMIP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.KeyServerInfo.Type.KMIP</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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.KeyServerInfo.Type</span></code> class list the key server types. 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">KMIP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='KMIP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type.KMIP"title="Permalink to this definition">¶</a></dt>
<dd><p>Key Management Interoperability Protocol (KMIP) based key management
server. 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">KeyServerUpdateSpec</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">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">proxy_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">connection_timeout</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">kmip_server</span></span><spanclass="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.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.KeyServerUpdateSpec</span></code> class contains attributes that
describe new configuration for an existing key 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>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KeyServerUpdateSpec.Type</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Type of the key server.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, key server type and configuration information will remain
unchanged. In this case all key server configuration information
fields (e.g KMIP) should be unset.</p>
</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>) –<p>Description of the key server.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, description will remain unchanged.</p>
</p></li>
<li><p><strong>proxy_server</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Proxy server configuration.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, proxy server configuration will remain unchanged.</p>
</p></li>
<li><p><strong>connection_timeout</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Connection timeout in seconds.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, connection timeout will remain unchanged.</p>
</p></li>
<li><p><strong>kmip_server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerUpdateSpec"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KmipServerUpdateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Configuration information for KMIP based key server.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, kmip server configuration will remain unchanged.</p>
<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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.KeyServerUpdateSpec.Type</span></code> class list the key server types.
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">KMIP</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='KMIP')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type.KMIP"title="Permalink to this definition">¶</a></dt>
<dd><p>Key Management Interoperability Protocol (KMIP) based key management
server. 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">KmipServerCreateSpec</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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerCreateSpec"title="Permalink to this definition">¶</a></dt>
<p>Key servers must be configured for active-active replication. If
the server port is None, a default value for KMIP’s port will be
used.. This attribute was added in vSphere API 7.0.0.0.</p>
</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 for authentication. This attribute was added in vSphere
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">KmipServerInfo</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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.KmipServerInfo</span></code> class contains attributes that describe
the current configuration of a KMIP based key 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>servers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Server"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Server"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Server</span></code></a>) – List of KMIP compliant key servers. 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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Username for authentication.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">KmipServerUpdateSpec</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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerUpdateSpec"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider'</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for a Key Provider. This class attribute was added in vSphere API
<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">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">address</span></span><spanclass="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.trust_authority_clusters.kms_client.Providers.Server"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Server</span></code> class contains attributes that describe a
connection endpoint. 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>) –<p>Name of the server.</p>
<p>A unique string chosen by the client.. This attribute was added in
vSphere API 7.0.0.0.</p>
</p></li>
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The server’s address. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ServerInfo</span></code><spanclass="sig-paren">(</span><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">details</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_trust_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">server_trust_client</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.trust_authority_clusters.kms_client.Providers.ServerInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.ServerInfo</span></code> class contains attributes that describe the
status of a key 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>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Health</span></code></a>) – The connection status health of the server. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>details</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>Details regarding the health of the server connection.</p>
<p>When the service <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Health</span></code> is not
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.OK"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.OK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.Health.OK</span></code></a>, this attribute will provide an
actionable description of the issue.. This attribute was added in
vSphere API 7.0.0.0.</p>
</p></li>
<li><p><strong>client_trust_server</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether this client trusts the server. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>server_trust_client</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether the server trusts this client. 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 server. This attribute was added in vSphere API
<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">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">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Status</span></code> class contains attributes that describe the status
of the Key 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>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Health</span></code></a>) – The health of the provider. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>details</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>Details regarding the health of the provider.</p>
<p>When the service <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Health</span></code> is not
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.OK"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.OK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.Health.OK</span></code></a>, this attribute will provide an
actionable description of the issue.. This attribute was added in
vSphere API 7.0.0.0.</p>
</p></li>
<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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.ServerInfo"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.ServerInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.ServerInfo</span></code></a>) – Health of the key servers. 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">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">health</span></span><spanclass="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.trust_authority_clusters.kms_client.Providers.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Health</span></code></a>) – Health of the provider in the cluster. This 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">master_key_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">key_server</span></span><spanclass="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.trust_authority_clusters.kms_client.Providers.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.UpdateSpec</span></code> class contains attributes that describe the
new configuration for an existing 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>master_key_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>Master key identifier created for the provider.</p>
<blockquote>
<div><p>A unique Key identifier.</p>
</div></blockquote>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, masterKeyId will remain unchanged.</p>
</p></li>
<li><p><strong>key_server</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.KeyServerUpdateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Key server associated with this provider.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, key server configuration will remain unchanged.</p>
<codeclass="sig-name descname"><spanclass="pre">create_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.trust_authority_clusters.kms_client.Providers.create_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new Key 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>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">delete_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">provider</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.delete_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a Key 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>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get_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">provider</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.get_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about a Key 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>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list_task</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.trust_authority_clusters.kms_client.Providers.list_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of summary of Key Providers. 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>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<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">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.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.update_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Update an existing Key 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>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of 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.trusted_infrastructure.trust_authority_clusters.kms_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ServiceStatus</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.trust_authority_clusters.kms_client.ServiceStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus</span></code> class provides methods to get the Key Provider
Service health status. 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">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.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus.Health</span></code> class defines the possible service health
states. 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">Health</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is not functioning. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>No status available. This class attribute was added in vSphere API 7.0.0.0.</p>
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='OK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.OK"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is functioning normally. This class attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>Service is functioning, however there is an issue that requires attention.
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">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">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.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus.Info</span></code> class contains information that describes the
status of the 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>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceStatus.Health</span></code></a>) – The service health status. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>details</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>Details regarding the health of the service.</p>
<p>When the service <codeclass="docutils literal notranslate"><spanclass="pre">ServiceStatus.Health</span></code> is not
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.OK"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.OK"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ServiceStatus.Health.OK</span></code></a> or
<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.NONE"title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ServiceStatus.Health.NONE</span></code></a>, this member will provide an
actionable description of the issues present.. This attribute was
<codeclass="sig-name descname"><spanclass="pre">get_task</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.trust_authority_clusters.kms_client.ServiceStatus.get_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the Key Provider Service health in the given cluster. 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>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of 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.trusted_infrastructure.trust_authority_clusters.kms_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.trust_authority_clusters.kms_client.StubFactory"title="Permalink to this definition">¶</a></dt>
