Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00
Code
gh-pages
vsphere-automation-sdk-python/vsphere/8.0.2.0/com.vmware.vcenter.trusted_infrastructure.html
Ankit Agrawal fee6f16acc Updated VC docs for v8.0.2.0. 
Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
2023-09-25 09:28:29 +05:30

2121 lines
216 KiB
HTML
Raw Permalink 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="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.trusted_infrastructure package &mdash; vSphere Automation SDK for Python. 8.0.2.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" 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 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.hosts package" href="com.vmware.vcenter.trusted_infrastructure.hosts.html" />
<link rel="prev" title="com.vmware.vcenter.system_config.features package" href="com.vmware.vcenter.system_config.features.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">
8.0.2.0
</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" aria-label="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="Navigation menu">
<p class="caption" role="heading"><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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a></li>
<li class="breadcrumb-item active">com.vmware.vcenter.trusted_infrastructure package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.trusted_infrastructure.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">
<section id="module-com.vmware.vcenter.trusted_infrastructure">
<span id="com-vmware-vcenter-trusted-infrastructure-package"></span><h1>com.vmware.vcenter.trusted_infrastructure package<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure" title="Permalink to this headline"></a></h1>
<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.hosts.html">com.vmware.vcenter.trusted_infrastructure.hosts package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html">com.vmware.vcenter.trusted_infrastructure.hosts.hardware package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.html#module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client">com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><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-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><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-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html#submodules">Submodules</a></li>
<li class="toctree-l6"><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-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html#submodules">Submodules</a></li>
<li class="toctree-l4"><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-l3"><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-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><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-l6"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html#submodules">Submodules</a></li>
<li class="toctree-l6"><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-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html#submodules">Submodules</a></li>
<li class="toctree-l4"><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>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html">com.vmware.vcenter.trusted_infrastructure.trusted_clusters package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.html#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client module</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-com.vmware.vcenter.trusted_infrastructure.attestation_client">
<span id="com-vmware-vcenter-trusted-infrastructure-attestation-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.attestation_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.attestation_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client</span></code> module
provides classes for configuring Attestation Services for Trusted vCenter.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.</span></span><span class="sig-name descname"><span class="pre">Services</span></span><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.attestation_client.Services" 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">Services</span></code> class contains information about the registered instances
of the Attestation Service in vCenter. 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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.CreateSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><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>, <em class="sig-param"><span class="n"><span class="pre">trusted_ca</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">group</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">trust_authority_cluster</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.attestation_client.Services.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">Services.CreateSpec</span></code> class contains the data necessary for
registering an Attestation Service instance to the environment. 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>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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group specifies the Key Provider Service instances that can
accept reports issued by this Attestation Service instance. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Attestation
Service belongs to. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.FilterSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">trust_authority_cluster</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.attestation_client.Services.FilterSpec" 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">Services.FilterSpec</span></code> class contains the data necessary for
identifying an Attestation Service instance. 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>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – A set of IDs by which to filter the services. This attribute was
added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation.Service</span></code>.
When methods return a value of this class as a return value, the
attribute will contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation.Service</span></code>.
If None, the services will not be filtered by ID.</p></li>
<li><p><strong>address</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.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>) – A set of address by which to filter. This attribute was added in
vSphere API 7.0.0.0.
If None, the services will not be filtered by address.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The group specifies the Key Provider Service instances that can
accept reports issued by this Attestation Service instance. This
attribute was added in vSphere API 7.0.0.0.
If None, the services will not be filtered by group.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The cluster specifies the Trust Authority Cluster this Attestation
Service belongs to. This attribute was added in vSphere API
7.0.0.0.
If None, the services will not be filtered by
trustAuthorityCluster.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><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>, <em class="sig-param"><span class="n"><span class="pre">trusted_ca</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">group</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">trust_authority_cluster</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.attestation_client.Services.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">Services.Info</span></code> class contains all the stored information about a
registered Attestation Service instance. 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>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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group specifies the Key Provider Service instances that can
accept reports issued by this Attestation Service instance. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Attestation
Service belongs to. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.trusted_infrastructure.attestation.Service'</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for the Attestation Service instances. This class attribute
was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Summary">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">trust_authority_cluster</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.attestation_client.Services.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">Services.Summary</span></code> class contains basic information about a
registered Attestation Service instance. 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>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service’s unique identifier. 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.attestation.Service</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation.Service</span></code>.</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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group specifies the Key Provider Service instances that can
accept reports issued by this Attestation Service instance. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Attestation
Service instance belongs to. This attribute was added in vSphere
API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><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.attestation_client.Services.create" title="Permalink to this definition"></a></dt>
<dd><p>Registers a new Attestation Service instance in this vCenter. 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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.CreateSpec" title="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.CreateSpec</span></code></a>) – The CreateSpec for the new service.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>ID of the newly registered Attestation Service instance.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation.Service</span></code>.</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.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 there is already a Attestation Service instance with the same
Address.</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>
if there is a generic 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 CreateSpec contains invalid data.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ManageTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.delete" title="Permalink to this definition"></a></dt>
<dd><p>Removes a registered Attestation Service instance from this vCenter.
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>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the Attestation Service instance unique identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation.Service</span></code>.</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>
if an error occurred while deleting the service.</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>
if there is a generic 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.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 Attestation Service instance 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.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the Attestation Service instance is used by a configuration on a
cluster level.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ManageTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the detailed information about a registered Attestation Service
instance in this vCenter. 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>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the Attestation Service instance unique identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation.Service</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Info" title="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Detailed information about the specified Attestation Service
instance.</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>
if an error occurred while getting the data.</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 there is no registered Attestation Service instance with the
specified ID.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</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.attestation_client.Services.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns detailed information about all registered Attestation Service
instances in this vCenter. 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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Return only services matching the specified filters.
If {\&#64;term.unset} return all services.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.list" title="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Summary" title="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Detailed information about all registered Attestation Service
instances in this vCenter.</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>
if an error occurred while getting the data.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.attestation_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.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>
</section>
<section id="module-com.vmware.vcenter.trusted_infrastructure.hosts_client">
<span id="com-vmware-vcenter-trusted-infrastructure-hosts-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.hosts_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.hosts_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts_client</span></code> module provides
classes to manage trusted infrastructure hosts.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.hosts_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>
</section>
<section id="module-com.vmware.vcenter.trusted_infrastructure.kms_client">
<span id="com-vmware-vcenter-trusted-infrastructure-kms-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.kms_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.kms_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client</span></code> module provides
classes for configuring Key Provider Services for Trusted vCenter.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.</span></span><span class="sig-name descname"><span class="pre">Services</span></span><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.kms_client.Services" 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">Services</span></code> class contains information about the registered instances
of the Key Provider Service in vCenter. 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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.CreateSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><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>, <em class="sig-param"><span class="n"><span class="pre">trusted_ca</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">group</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">trust_authority_cluster</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.kms_client.Services.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">Services.CreateSpec</span></code> class contains the data necessary for
registering a Key Provider Service instance to the environment. 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>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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group determines the Attestation Service instances this Key
Provider service can accept reports from. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Key Provider
Service belongs to. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.FilterSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">trust_authority_cluster</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.kms_client.Services.FilterSpec" 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">Services.FilterSpec</span></code> class contains the data necessary for
identifying a Key Provider Service instance. 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>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – A set of IDs by which to filter the services. This attribute was
added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms.Service</span></code>. When
methods return a value of this class as a return value, the
attribute will contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms.Service</span></code>.
If None, the services will not be filtered by ID.</p></li>
<li><p><strong>address</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.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>) – A set of address by which to filter. This attribute was added in
vSphere API 7.0.0.0.
If None, the services will not be filtered by address.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The group determines the Attestation Service instances this Key
Provider Service can accept reports from. This attribute was added
in vSphere API 7.0.0.0.
If None, the Services will not be filtered by group.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The cluster specifies the Trust Authority Cluster this Key Provider
Service belongs to. This attribute was added in vSphere API
7.0.0.0.
If None, the Services will not be filtered by
trustAuthorityCluster.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><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>, <em class="sig-param"><span class="n"><span class="pre">trusted_ca</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">group</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">trust_authority_cluster</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.kms_client.Services.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">Services.Info</span></code> class contains all the stored information about a
registered Key Provider Service instance. 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>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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group determines the Attestation Service instances this Key
Provider Service can accept reports from. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Key Provider
Service belongs to. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.trusted_infrastructure.kms.Service'</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The resource type for the Key Provider Service instance. This class attribute
was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Summary">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">trust_authority_cluster</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.kms_client.Services.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">Services.Summary</span></code> class contains basic information about a
registered Key Provider Service instance. 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>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service’s unique identifier. 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.kms.Service</span></code>. When
methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms.Service</span></code>.</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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group determines the Attestation Service instances this Key
Provider Service can accept reports from. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Key Provider
service belongs to. This attribute was added in vSphere API
7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><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.kms_client.Services.create" title="Permalink to this definition"></a></dt>
<dd><p>Registers a Key Provider Service instance in this vCenter. 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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.CreateSpec" title="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.CreateSpec</span></code></a>) – The CreateSpec for the new service.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>ID of the newly registered Key Provider Service instance.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms.Service</span></code>.</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.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 there is already a Key Provider Service instance with the same
Address.</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>
if there is a generic 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 CreateSpec contains invalid data.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ManageTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.delete" title="Permalink to this definition"></a></dt>
<dd><p>Removes a currently registered Key Provider Service instance from this
vCenter. 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>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the Key Provider Service instance unique identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms.Service</span></code>.</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>
if an error occurred while deleting the service.</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 Key Provider Service instance 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.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if the Key Provider Service instance is used by a configuration on
a cluster level.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ManageTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the detailed information about a registered Key Provider
Service instance in this vCenter. 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>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the Key Provider Service instance unique identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms.Service</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Info" title="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Detailed information about the specified Key Provider Service
instance.</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>
if an error occurred while getting the data.</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 there is no Key Provider Service instance with the specified ID.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</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.kms_client.Services.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns basic information about all registered Key Provider Service
instances in this vCenter. 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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Return only services matching the specified filters.
If {\&#64;term.unset} return all services.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.list" title="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Summary" title="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Basic information about all registered Key Provider Service
instances in this vCenter.</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>
if an error occurred while getting the data.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.kms_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.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>
</section>
<section id="module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client">
<span id="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_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_client</span></code>
module provides the Trust Authority Components.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.</span></span><span class="sig-name descname"><span class="pre">ConsumerPrincipals</span></span><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_client.ConsumerPrincipals" 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">ConsumerPrincipals</span></code> class configures the token policies and STS
trust necessary for the workload vCenter to query the trusted services for
their 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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.CreateSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificates</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">issuer_alias</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">issuer</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">principal</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_client.ConsumerPrincipals.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">ConsumerPrincipals.CreateSpec</span></code> class contains the information
necessary to establish trust between a workload vCenter and a Trust
Authority Host. 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>certificates</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.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The certificates used by the vCenter STS to sign tokens. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer_alias</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A user-friendly alias of the service which created and signed the
security token. 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.esx.authentication.trust.security-token-issuer</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.esx.authentication.trust.security-token-issuer</span></code>.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>principal</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal</span></code></a>) – The principal used by the vCenter to retrieve tokens. This
attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.FilterSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">principals</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">issuer</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_client.ConsumerPrincipals.FilterSpec" 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">ConsumerPrincipals.FilterSpec</span></code> class contains data which identifies
a connection profile on the trusted vCenter. 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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The unqiue identifier of a connection profile. This attribute was
added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.authentication.clientprofile</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.authentication.clientprofile</span></code>.
If None, no filtration will be performed by ID.</p></li>
<li><p><strong>principals</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.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The principal used by the vCenter to retrieve tokens. This
attribute was added in vSphere API 7.0.0.0.
If None, no filtration will be performed by principals.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.authentication.trust.security-token-issuer</span></code>. When
methods return a value of this class as a return value, the
attribute will contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.authentication.trust.security-token-issuer</span></code>.
If None, no filtration will be performed by issuer.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Health</span></span><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_client.ConsumerPrincipals.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">ConsumerPrincipals.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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><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_client.ConsumerPrincipals.Health.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Error. Not healthy. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health.NONE">
<span class="sig-name descname"><span class="pre">NONE</span></span><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_client.ConsumerPrincipals.Health.NONE" title="Permalink to this definition"></a></dt>
<dd><p>None. No status available. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health.OK">
<span class="sig-name descname"><span class="pre">OK</span></span><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_client.ConsumerPrincipals.Health.OK" title="Permalink to this definition"></a></dt>
<dd><p>OK. Health is normal. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health.WARNING">
<span class="sig-name descname"><span class="pre">WARNING</span></span><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_client.ConsumerPrincipals.Health.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Warning. 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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">principal</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">issuer_alias</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">issuer</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">certificates</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>, <em class="sig-param"><span class="n"><span class="pre">message</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_client.ConsumerPrincipals.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">ConsumerPrincipals.Info</span></code> class contains the information necessary to
establish trust between a workload vCenter and a Trust Authority Host. 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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unqiue identifier of a connection profile. 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.esx.authentication.clientprofile</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.esx.authentication.clientprofile</span></code>.</p></li>
<li><p><strong>principal</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal</span></code></a>) – The principal used by the vCenter to retrieve tokens. Currently
this is the vCenter solution user. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer_alias</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A user-friendly alias of the service which created and signed the
security token. 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.esx.authentication.trust.security-token-issuer</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.esx.authentication.trust.security-token-issuer</span></code>.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>certificates</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.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The certificates used by the vCenter STS to sign tokens. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConsumerPrincipals.Health</span></code></a>) – The consistency of the profile across the hosts in the cluster.
This attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>message</strong> (<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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A localizable message describing the health of the profile. This
attribute was added in vSphere API 7.0.0.0.
If None, the certificates won’t be updated.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Summary">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">principal</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">issuer_alias</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">issuer</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_client.ConsumerPrincipals.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">ConsumerPrincipals.Summary</span></code> class contains a summary of the
information necessary to establish trust between a workload vCenter and a
Trust Authority Host. 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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The unqiue identifier of a connection profile. 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.esx.authentication.clientprofile</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.esx.authentication.clientprofile</span></code>.</p></li>
<li><p><strong>principal</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal" title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal</span></code></a>) – The principal used by the vCenter to retrieve tokens. Currently
this is the vCenter solution user. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>issuer_alias</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A user-friendly alias of the service which created and signed the
security token. 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.esx.authentication.trust.security-token-issuer</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.esx.authentication.trust.security-token-issuer</span></code>.</p></li>
<li><p><strong>issuer</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.create_task">
<span class="sig-name descname"><span class="pre">create_task</span></span><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_client.ConsumerPrincipals.create_task" title="Permalink to this definition"></a></dt>
<dd><p>Creates a profile with the specified connection information on all
hosts from a Trust Authority 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"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the Trust Authority Cluster to configure.
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_client.ConsumerPrincipals.CreateSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConsumerPrincipals.CreateSpec</span></code></a>) – The CreateSpec specifying the connection information.</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.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 a profile for the issuer already exists.</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>
if there is a generic error.</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 there is no such cluster.</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 user can not be authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.delete_task">
<span class="sig-name descname"><span class="pre">delete_task</span></span><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">profile</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.delete_task" title="Permalink to this definition"></a></dt>
<dd><p>Removes the read-only policy configured on ESX for a specific
principal. 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>) – The ID of the Trust Authority Cluster to configure.
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>profile</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the connection profile to modify.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.authentication.clientprofile</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.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>
if there is a generic error.</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 there is no profile configured with that ID.</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 user can not be authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.get_task">
<span class="sig-name descname"><span class="pre">get_task</span></span><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">profile</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.get_task" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve information for a specific profile. 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>) – The ID of the Trust Authority Cluster on which the profile is
configured.
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>profile</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the profile.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.authentication.clientprofile</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.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>
if there is a generic 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.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 there is no profile configured with that ID.</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 user can not be authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.list_task">
<span class="sig-name descname"><span class="pre">list_task</span></span><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><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_client.ConsumerPrincipals.list_task" title="Permalink to this definition"></a></dt>
<dd><p>Lists all policies configured on a specific 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"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the Trust Authority Cluster on which the profile is
configured.
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_client.ConsumerPrincipals.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConsumerPrincipals.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A FilterSpec specifying the profiles to be listed.
If {\&#64;term.unset} return all policies.</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.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>
if there is a generic 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.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 there is no profile configured with that ID.</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 user can not be authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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_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>
</section>
<section id="module-com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client">
<span id="com-vmware-vcenter-trusted-infrastructure-trust-authority-hosts-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_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_hosts_client</span></code>
module provides classes that provide information necessary to connect to the
hosts running the Trust Authority Components.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.</span></span><span class="sig-name descname"><span class="pre">Attestation</span></span><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_hosts_client.Attestation" 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">Attestation</span></code> class contains information necessary to connect to the
hosts running Attestation Service. 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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.FilterSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hosts</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">clusters</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>, <em class="sig-param"><span class="n"><span class="pre">groups</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_hosts_client.Attestation.FilterSpec" 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">Attestation.FilterSpec</span></code> class contains the data necessary for
identifying a Attestation 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>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – A set of host IDs by which to filter the services. This attribute
was added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
If None, the services will not be filtered by the hosts on which
they run.</p></li>
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – A set of cluster IDs by which to filter the services. This
attribute was added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
If None, the services will not be filtered by the clusters on which
they run.</p></li>
<li><p><strong>address</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.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>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.
If None, the services will not be filtered by address.</p></li>
<li><p><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The group IDs determines which Attestation Service instances this
Attestation Service can communicate with. This attribute was added
in vSphere API 7.0.0.0.
If None, the services will not be filtered by groupId.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">cluster</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">trusted_ca</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_hosts_client.Attestation.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">Attestation.Info</span></code> class contains all the stored information about a
Attestation 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>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The trusted ESX on which the service runs. 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">HostSystem</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">HostSystem</span></code>.</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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group ID determines which Attestation Service instances this
Attestation Service can communicate with. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The opaque string identifier of the cluster in which the
Attestation Service is part of. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Summary">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">summary_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">host</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">cluster</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">trusted_ca</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_hosts_client.Attestation.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">Attestation.Summary</span></code> class contains all the stored information about
a Attestation 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>summary_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.SummaryType</span></code></a>) – Defines the verbosity of the summary. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The trusted ESX on which the service runs. 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">HostSystem</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">HostSystem</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.BRIEF" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.BRIEF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.BRIEF</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.NORMAL</span></code></a>, or
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.FULL</span></code></a>.</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 service’s address. This attribute was added in vSphere API
7.0.0.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.BRIEF" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.BRIEF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.BRIEF</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.NORMAL</span></code></a>, or
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group ID determines which Attestation Service instances this
Attestation Service can communicate with. 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">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.NORMAL</span></code></a>
or <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The opaque string identifier of the cluster in which the
Attestation Service is part of. 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">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.NORMAL</span></code></a>
or <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. 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">summaryType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.SummaryType.FULL</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">SummaryType</span></span><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_hosts_client.Attestation.SummaryType" 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 connection information could include the certificates or be a shorter
summary. 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">SummaryType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.BRIEF">
<span class="sig-name descname"><span class="pre">BRIEF</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SummaryType(string='BRIEF')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.BRIEF" title="Permalink to this definition"></a></dt>
<dd><p>A brief summary, containing only the hostname for the Attestation Service.
This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL">
<span class="sig-name descname"><span class="pre">FULL</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SummaryType(string='FULL')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.FULL" title="Permalink to this definition"></a></dt>
<dd><p>The full connection information, including certificates. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL">
<span class="sig-name descname"><span class="pre">NORMAL</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SummaryType(string='NORMAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType.NORMAL" title="Permalink to this definition"></a></dt>
<dd><p>A summary containing only the hostname, port, and the group ID which
determines the Attestation Services this Attestation Service can
communicate with. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the connection info about the Attestation Service running on
the specified host. 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>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – \&#64;{link com.vmware.vcenter.Host} id.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Info" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Info" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.Info</span></code></a> instance which contains the
information necessary to connect to the Attestation Service.</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>
if service’s TLS certificate chain is not valid.</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 <code class="docutils literal notranslate"><span class="pre">host</span></code> doesn’t match to any Host.</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.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if connection to <code class="docutils literal notranslate"><span class="pre">host</span></code> failed.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</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">projection</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_hosts_client.Attestation.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of the hosts running a Attestation Service matching the
specified <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.FilterSpec</span></code></a>. 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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Return details about Attestation Services matching the filter.
If {\&#64;term.unset} return all registered Attestation Services.</p></li>
<li><p><strong>projection</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.SummaryType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of the returned summary - brief, normal, or full.
If {\&#64;term.unset} a normal projection will be used.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.list" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Summary" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Summary" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attestation.Summary</span></code></a> of Attestation Services.</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>
if there is a generic error.</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 response data will exceed the message limit.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.FilterSpec.hosts</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">Attestation.FilterSpec.clusters</span></code> requires
<code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.</span></span><span class="sig-name descname"><span class="pre">Kms</span></span><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_hosts_client.Kms" 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">Kms</span></code> class contains information necessary to connect to the hosts
running Key Provider Service. 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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.FilterSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hosts</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">clusters</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>, <em class="sig-param"><span class="n"><span class="pre">groups</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_hosts_client.Kms.FilterSpec" 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">Kms.FilterSpec</span></code> class contains the data necessary for identifying a
Key Provider 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>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – A set of host IDs by which to filter the services. This attribute
was added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
If None, the services will not be filtered by the hosts on which
they run.</p></li>
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – A set of cluster IDs by which to filter the services. This
attribute was added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
If None, the services will not be filtered by the clusters on which
they run.</p></li>
<li><p><strong>address</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.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>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.
If None, the services will not be filtered by address.</p></li>
<li><p><strong>groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <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>) – The group determines reports issued by which Attestation Service
instances this Key Provider Service can accept. This attribute was
added in vSphere API 7.0.0.0.
If None, the services will not be filtered by groupId.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">cluster</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">trusted_ca</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_hosts_client.Kms.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">Kms.Info</span></code> class contains all the stored information about a Key
Provider 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>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The trusted ESX on which the service runs. 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">HostSystem</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">HostSystem</span></code>.</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 service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group ID determines which Attestation Service instances this
Key Provider Service can communicate with. This attribute was added
in vSphere API 7.0.0.0.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The opaque string identifier of the cluster in which the Key
Provider Service is part of. This attribute was added in vSphere
API 7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Summary">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">summary_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">host</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>, <em class="sig-param"><span class="n"><span class="pre">group</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">cluster</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">trusted_ca</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_hosts_client.Kms.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">Kms.Summary</span></code> class contains all the stored information about a Key
Provider 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>summary_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.SummaryType</span></code></a>) – Defines the verbosity of the summary. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The trusted ESX on which the service runs. 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">HostSystem</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">HostSystem</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.BRIEF" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.BRIEF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.BRIEF</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.NORMAL</span></code></a>, or <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.FULL</span></code></a>.</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 service’s address. This attribute was added in vSphere API
7.0.0.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.BRIEF" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.BRIEF"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.BRIEF</span></code></a>,
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.NORMAL</span></code></a>, or <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group ID determines which Attestation Service instances this
Key Provider Service can communicate with. 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">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.NORMAL</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The opaque string identifier of the cluster in which the Key
Provider Service is part of. 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">summaryType</span></code> is one of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.NORMAL</span></code></a> or
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. 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">summaryType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.SummaryType.FULL</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">SummaryType</span></span><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_hosts_client.Kms.SummaryType" 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 connection information could include the certificates or be a shorter
summary. 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">SummaryType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.BRIEF">
<span class="sig-name descname"><span class="pre">BRIEF</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SummaryType(string='BRIEF')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.BRIEF" title="Permalink to this definition"></a></dt>
<dd><p>A brief summary, containing only the hostname for the Key Provider Service.
This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL">
<span class="sig-name descname"><span class="pre">FULL</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SummaryType(string='FULL')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.FULL" title="Permalink to this definition"></a></dt>
<dd><p>The full connection information, including certificates. This class
attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL">
<span class="sig-name descname"><span class="pre">NORMAL</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SummaryType(string='NORMAL')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType.NORMAL" title="Permalink to this definition"></a></dt>
<dd><p>A summary containing only the hostname, port, and the group which
determines the Attestation Services this Key Provider Service can
communicate with. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the connection info about the Key Provider Service running on
the specified host. 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>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – \&#64;{link com.vmware.vcenter.Host} id.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Info" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Info" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.Info</span></code></a> instance which contains the information
necessary to connect to the Key Provider Service.</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>
if service’s TLS certificate chain is not valid.</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 <code class="docutils literal notranslate"><span class="pre">host</span></code> doesn’t match to any Host.</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 user can not be 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.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
if connection to <code class="docutils literal notranslate"><span class="pre">host</span></code> failed.</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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</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">projection</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_hosts_client.Kms.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of the hosts running a Key Provider Service matching the
specified <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.FilterSpec</span></code></a>. 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>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Return details about Key Provider Services matching the filter.
If {\&#64;term.unset} return all registered Key Provider Services.</p></li>
<li><p><strong>projection</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.SummaryType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The type of the returned summary - brief, normal, or full.
If {\&#64;term.unset} a normal projection will be used.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.list" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Summary" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Summary" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Kms.Summary</span></code></a> of Key Provider Services.</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>
if there is a generic error.</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 response data will exceed the message limit.</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 user can not be 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.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the attribute
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.FilterSpec.hosts</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">Kms.FilterSpec.clusters</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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_hosts_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>
</section>
<section id="module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client">
<span id="com-vmware-vcenter-trusted-infrastructure-trusted-clusters-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client</span></code>
module provides classes for configuring Trusted Clusters.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.</span></span><span class="sig-name descname"><span class="pre">ServicesAppliedConfig</span></span><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.trusted_clusters_client.ServicesAppliedConfig" 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">ServicesAppliedConfig</span></code> class provides information about the
aggregate health of the applied Trust Authority Component configurations on
the Trusted Clusters. The desired state of the Trust Authority Component
configurations is stored within vCenter, while the applied configuration is
stored on the hosts in the cluster and is a copy of the desired state. The
<code class="docutils literal notranslate"><span class="pre">ServicesAppliedConfig</span></code> class is available for all clusters, not only
Trusted Clusters. When an applied Trust Authority Component configuration
is found outside of a Trusted Cluster it is considered an
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.ERROR" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ServicesAppliedConfig.Health.ERROR</span></code></a>. The <code class="docutils literal notranslate"><span class="pre">ServicesAppliedConfig</span></code>
class is able to make the applied Trust Authority Component configuration
consistent with the desired state when individual host configurations have
diverged from the desired state. This class was added in vSphere API
7.0.1.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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Health</span></span><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.trusted_clusters_client.ServicesAppliedConfig.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">ServicesAppliedConfig.Health</span></code> class is an indicator for the
consistency of all applied Trust Authority Component configurations in a
cluster with respect to the desired state. This enumeration was added in
vSphere API 7.0.1.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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Some applied Trust Authority Component configurations have diverged from
the desired state. This class attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.NONE">
<span class="sig-name descname"><span class="pre">NONE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.NONE" title="Permalink to this definition"></a></dt>
<dd><p>The consistency of some applied configurations is unknown. This class
attribute was added in vSphere API 7.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.OK">
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='OK')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.OK" title="Permalink to this definition"></a></dt>
<dd><p>All the applied Trust Authority Component configurations are consistent
with the desired state. This class attribute was added in vSphere API
7.0.1.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Info">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">Info</span></span><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.trusted_clusters_client.ServicesAppliedConfig.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">ServicesAppliedConfig.Info</span></code> class contains detailed information
about the health of the applied Trust Authority Component configurations in
a cluster. This class was added in vSphere API 7.0.1.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.trusted_clusters_client.ServicesAppliedConfig.Health" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServicesAppliedConfig.Health</span></code></a>) – The health value which indicates whether the configuration applied
to the cluster differs from the desired state. This attribute was
added in vSphere API 7.0.1.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>) – Details regarding the health. When the
<code class="docutils literal notranslate"><span class="pre">ServicesAppliedConfig.Health</span></code> is not
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.OK" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ServicesAppliedConfig.Health.OK</span></code></a>, this member will provide a
detailed description of the issues present. This attribute was
added in vSphere API 7.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.delete_task">
<span class="sig-name descname"><span class="pre">delete_task</span></span><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.trusted_clusters_client.ServicesAppliedConfig.delete_task" title="Permalink to this definition"></a></dt>
<dd><p>Delete all Trust Authority Components configuration that has been
applied to the given cluster. This method has no affect on the desired
state, it only removes applied Trust Authority Component configurations
from any Trusted Hosts within the given cluster. This method was added
in vSphere API 7.0.1.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>) – The ID of the cluster against which the operation will be executed.
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">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>
if there is a generic error.</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 no cluster corresponding to the given ID is found within this
vCenter.</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.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if there are ongoing mutating operations.</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>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.get_task">
<span class="sig-name descname"><span class="pre">get_task</span></span><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.trusted_clusters_client.ServicesAppliedConfig.get_task" title="Permalink to this definition"></a></dt>
<dd><p>Returns detailed information about the health of the applied Trust
Authority Component configurations in the given cluster. This method
was added in vSphere API 7.0.1.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>) – The ID of the cluster against which the operation will be executed.
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>
if there is a generic 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 no cluster corresponding to the given ID is found within this
vCenter.</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.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if there are ongoing mutating operations.</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>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.update_task">
<span class="sig-name descname"><span class="pre">update_task</span></span><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.trusted_clusters_client.ServicesAppliedConfig.update_task" title="Permalink to this definition"></a></dt>
<dd><p>Update all applied Trust Authority Component configuration on the given
cluster to be consistent with the desired state. This method has no
affect on the desired state, apart from it being used as a reference
point for the remediation. If the cluster is not a Trusted Cluster, the
method will remove all Trust Authority Component configuration from the
Trusted Hosts in the cluster, if such hosts are found. This method was
added in vSphere API 7.0.1.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>) – The ID of the cluster against which the operation will be executed.
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">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>
if there is a generic error.</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 no cluster corresponding to the given ID is found within this
vCenter.</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.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if there are ongoing mutating operations.</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 class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.trusted_clusters_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>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.vcenter.system_config.features.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.system_config.features package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.vcenter.trusted_infrastructure.hosts.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.trusted_infrastructure.hosts package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, 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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink