Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
Code
d2e505f616
vsphere-automation-sdk-python/vsphere/7.0.3.2/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html
Vandit Mehta b18fe14f5a
Update docs for vSphere 7.0.3.2 
Signed-off-by: Vandit Mehta <vmehta@vmware.com>
2022-04-12 12:11:18 +05:30

1340 lines
115 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package &mdash; vSphere Automation SDK for Python. 7.0.3.2 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html" />
<link rel="prev" title="com.vmware.vcenter.trusted_infrastructure package" href="com.vmware.vcenter.trusted_infrastructure.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.3.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.trusted_infrastructure.html">com.vmware.vcenter.trusted_infrastructure package</a> &raquo;</li>
<li>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters">
<span id="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-package"></span><h1>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client">
<span id="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-attestation-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client" title="Permalink to this headline"></a></h2>
<p>The
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client</span></code>
module provides classes for configuring the Attestation Service. It attests the
state of a remote infrastructure node.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.</span></code><code class="sig-name descname"><span class="pre">ServiceStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ServiceStatus.Health</span></code> class defines the possible service health
states. This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='ERROR')</span></em><a class="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
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='NONE')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.OK">
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='OK')</span></em><a class="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
API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Health.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='WARNING')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>health</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Details regarding the health of the service.</p>
<p>When the service <code class="docutils literal notranslate"><span class="pre">ServiceStatus.Health</span></code> is not
<a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ServiceStatus.Health.OK</span></code></a> or
<a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ServiceStatus.Health.NONE</span></code></a>, this member will provide an
actionable description of the issues present.. This attribute was
added in vSphere API 7.0.0.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.ServiceStatus.get_task">
<code class="sig-name descname"><span class="pre">get_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
For any other error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the cluster id is empty.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the cluster is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client">
<span id="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-kms-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client" title="Permalink to this headline"></a></h2>
<p>The
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client</span></code>
module provides the interfaces for configuring the Key Provider Service. It
encapsulates one or more key servers and exposes Trusted Key Providers.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.</span></code><code class="sig-name descname"><span class="pre">Providers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">master_key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code> class contains attributes that describe the
desired configuration for a new Key Provider. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Name of the provider.</p>
<p>A unique string chosen by the client.. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider</span></code>.</p>
</p></li>
<li><p><strong>master_key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.KeyServerCreateSpec</span></code></a>) – Key server associated with this Provider. This attribute was added
in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> class defines the possible health states. This
enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='ERROR')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='NONE')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.OK">
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='OK')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Health.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='WARNING')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">master_key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>master_key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Status</span></code></a>) – Status of the provider in the cluster. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">KeyServerCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kmip_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.KeyServerCreateSpec.Type.KMIP</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.KeyServerCreateSpec.Type</span></code> class lists the key server
types. This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerCreateSpec.Type.KMIP">
<code class="sig-name descname"><span class="pre">KMIP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='KMIP')</span></em><a class="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>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">KeyServerInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kmip_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.KeyServerInfo.Type.KMIP</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.KeyServerInfo.Type</span></code> class list the key server types. This
enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerInfo.Type.KMIP">
<code class="sig-name descname"><span class="pre">KMIP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='KMIP')</span></em><a class="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>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">KeyServerUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proxy_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kmip_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.KeyServerUpdateSpec.Type</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.KmipServerUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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>
</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.KeyServerUpdateSpec.Type</span></code> class list the key server types.
This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KeyServerUpdateSpec.Type.KMIP">
<code class="sig-name descname"><span class="pre">KMIP</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='KMIP')</span></em><a class="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>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">KmipServerCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.KmipServerCreateSpec</span></code> class contains attributes that
describe Key Management Interoperability Protocol (KMIP) desired key server
configuration. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Server</span></code></a>) – <p>List of Key Management Interoperability Protocol (KMIP) compliant
key servers.</p>
<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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Username for authentication. This attribute was added in vSphere
API 7.0.0.0.
If None, no username will be added.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">KmipServerInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Username for authentication.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, username will not be set.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">KmipServerUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.KmipServerUpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.KmipServerUpdateSpec</span></code> class contains attributes that
describe new configuration for KMIP based key server. This class was added
in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>servers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Server</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>List of KMIP compliant key servers.</p>
<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.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, server configuration will remain unchanged.</p>
</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Username for authentication.</p>
<p>. This attribute was added in vSphere API 7.0.0.0.
If None, username will remain unchanged.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider'</span></em><a class="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
7.0.0.0.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Server">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Server</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Server" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Server</span></code> class contains attributes that describe a
connection endpoint. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The server’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.ServerInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ServerInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_trust_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_trust_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.ServerInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>health</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Details regarding the health of the server connection.</p>
<p>When the service <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> is not
<a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the server. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Status">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">servers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>health</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Details regarding the health of the provider.</p>
<p>When the service <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> is not
<a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ServerInfo</span></code></a>) – Health of the key servers. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code> class contains attributes that summarize a
provider. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Name of the provider.</p>
<p>A unique string chosen by the client.. 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:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider</span></code>.</p>
</p></li>
<li><p><strong>health</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a>) – Health of the provider in the cluster. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">master_key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>master_key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.KeyServerUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="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>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.create_task">
<code class="sig-name descname"><span class="pre">create_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.CreateSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code></a>) – Provider information.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
If the provider already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the spec is invalid or cluster id is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the cluster is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
For any other error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.delete_task">
<code class="sig-name descname"><span class="pre">delete_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the provider.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the cluster or provider id is empty.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the cluster or provider is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
For any other error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.get_task">
<code class="sig-name descname"><span class="pre">get_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the provider.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the cluster or provider id is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the cluster or provider is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
For any other error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.list_task">
<code class="sig-name descname"><span class="pre">list_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the cluster id is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the cluster is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
For any other error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.update_task">
<code class="sig-name descname"><span class="pre">update_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the provider.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.UpdateSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.Providers.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code></a>) – Provider information.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the cluster or provider id is empty, or the spec is invalid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the cluster or provider is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
For any other error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.</span></code><code class="sig-name descname"><span class="pre">ServiceStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ServiceStatus.Health</span></code> class defines the possible service health
states. This enumeration was added in vSphere API 7.0.0.0.</p>
<div class="admonition note">
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='ERROR')</span></em><a class="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
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='NONE')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.OK">
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='OK')</span></em><a class="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
API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Health.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='WARNING')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>health</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Details regarding the health of the service.</p>
<p>When the service <code class="docutils literal notranslate"><span class="pre">ServiceStatus.Health</span></code> is not
<a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ServiceStatus.Health.OK</span></code></a> or
<a class="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"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ServiceStatus.Health.NONE</span></code></a>, this member will provide an
actionable description of the issues present.. This attribute was
added in vSphere API 7.0.0.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.ServiceStatus.get_task">
<code class="sig-name descname"><span class="pre">get_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
For any other error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the cluster id is empty.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the cluster is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vcenter.trusted_infrastructure.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.trusted_infrastructure package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2022, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink