<spanid="com-vmware-vcenter-trusted-infrastructure-package"></span><h1>com.vmware.vcenter.trusted_infrastructure package<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-trusted-infrastructure-attestation-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.attestation_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.attestation_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Services</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.CreateSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Attestation
Service belongs to. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">services</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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:
If None, the services will not be filtered by ID.</p></li>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The 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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The cluster specifies the Trust Authority Cluster this Attestation
Service belongs to. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Attestation
Service belongs to. This attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.trusted_infrastructure.attestation.Service'</span></em><aclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The 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:
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Attestation
Service instance belongs to. This attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.CreateSpec"title="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Services.CreateSpec</span></code></a>) – The CreateSpec for the new service.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the Attestation Service instance unique identifier.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the Attestation Service instance unique identifier.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.FilterSpec"title="com.vmware.vcenter.trusted_infrastructure.attestation_client.Services.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Services.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Return only services matching the specified filters.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.attestation_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-trusted-infrastructure-kms-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.kms_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.kms_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Services</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Key Provider
Service belongs to. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">services</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="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:
If None, the services will not be filtered by ID.</p></li>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The 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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The cluster specifies the Trust Authority Cluster this Key Provider
Service belongs to. This attribute was added in vSphere API
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>trusted_ca</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Key Provider
Service belongs to. This attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vcenter.trusted_infrastructure.kms.Service'</span></em><aclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trust_authority_cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The 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:
<codeclass="docutils literal notranslate"><spanclass="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:
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The cluster specifies the Trust Authority Cluster this Key Provider
service belongs to. This attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.CreateSpec"title="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Services.CreateSpec</span></code></a>) – The CreateSpec for the new service.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the Key Provider Service instance unique identifier.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">service</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – the Key Provider Service instance unique identifier.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.Services.FilterSpec"title="com.vmware.vcenter.trusted_infrastructure.kms_client.Services.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Services.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Return only services matching the specified filters.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.kms_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ConsumerPrincipals</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">certificates</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issuer_alias</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issuer</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">principal</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>certificates</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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:
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>principal</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">principals</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issuer</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.authentication.clientprofile</span></code>. When methods
return a value of this class as a return value, the attribute will
If None, no filtration will be performed by ID.</p></li>
<li><p><strong>principals</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The 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:
<codeclass="docutils literal notranslate"><spanclass="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:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Health</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConsumerPrincipals.Health</span></code> class defines the possible health states.
This enumeration was added in vSphere API 7.0.0.0.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Health</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_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>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_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
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='OK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_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
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_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>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.authentication.clientprofile</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>principal</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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:
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>certificates</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">principal</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issuer_alias</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">issuer</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.ConsumerPrincipals.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.authentication.clientprofile</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>principal</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"title="com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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:
<li><p><strong>issuer</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.0.</p></li>
<codeclass="sig-name descname"><spanclass="pre">create_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the Trust Authority Cluster to configure.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">delete_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">profile</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the Trust Authority Cluster to configure.
The parameter must be an identifier for the resource type:
<li><p><strong>profile</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the connection profile to modify.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">profile</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the Trust Authority Cluster on which the profile is
configured.
The parameter must be an identifier for the resource type:
<li><p><strong>profile</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the profile.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the Trust Authority Cluster on which the profile is
configured.
The parameter must be an identifier for the resource type:
<li><p><strong>spec</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConsumerPrincipals.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A FilterSpec specifying the profiles to be listed.
If {\@term.unset} return all policies.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-trusted-infrastructure-trust-authority-hosts-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Attestation</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">hosts</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">clusters</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">groups</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
If None, the services will not be filtered by the hosts on which
they run.</p></li>
<li><p><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If None, the services will not be filtered by the clusters on which
they run.</p></li>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The 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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">summary_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>summary_type</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.BRIEF</span></code></a>,
<aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.NORMAL</span></code></a>, or
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The 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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.BRIEF</span></code></a>,
<aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.NORMAL</span></code></a>, or
<li><p><strong>group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.NORMAL</span></code></a>
or <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.NORMAL</span></code></a>
or <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.FULL</span></code></a>.</p></li>
<li><p><strong>trusted_ca</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Attestation.SummaryType.FULL</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SummaryType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Attestation.SummaryType"title="Permalink to this definition">¶</a></dt>
<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>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SummaryType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BRIEF</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SummaryType(string='BRIEF')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">FULL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SummaryType(string='FULL')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">NORMAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SummaryType(string='NORMAL')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">projection</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_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 <aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Attestation.FilterSpec</span></code></a>. This method was added in
vSphere API 7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>spec</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Attestation.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Return details about Attestation Services matching the filter.
If {\@term.unset} return all registered Attestation Services.</p></li>
<li><p><strong>projection</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Attestation.SummaryType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the returned summary - brief, normal, or full.
If {\@term.unset} a normal projection will be used.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Kms</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">hosts</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">clusters</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">groups</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.FilterSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
If None, the services will not be filtered by the hosts on which
they run.</p></li>
<li><p><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If None, the services will not be filtered by the clusters on which
they run.</p></li>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The 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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
7.0.0.0.</p></li>
<li><p><strong>group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">summary_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">trusted_ca</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>summary_type</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Kms.SummaryType.BRIEF</span></code></a>,
<li><p><strong>address</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The 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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Kms.SummaryType.BRIEF</span></code></a>,
<li><p><strong>group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Kms.SummaryType.NORMAL</span></code></a> or
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is one of <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Kms.SummaryType.NORMAL</span></code></a> or
<li><p><strong>trusted_ca</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">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 <codeclass="docutils literal notranslate"><spanclass="pre">summaryType</span></code> is <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Kms.SummaryType.FULL</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SummaryType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.Kms.SummaryType"title="Permalink to this definition">¶</a></dt>
<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>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SummaryType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BRIEF</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SummaryType(string='BRIEF')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">FULL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SummaryType(string='FULL')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">NORMAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SummaryType(string='NORMAL')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<ddclass="field-odd"><p>The <aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Kms.Info</span></code></a> instance which contains the information
necessary to connect to the Key Provider Service.</p>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">projection</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_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 <aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Kms.FilterSpec</span></code></a>. This method was added in vSphere API
7.0.0.0.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>spec</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Kms.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Return details about Key Provider Services matching the filter.
If {\@term.unset} return all registered Key Provider Services.</p></li>
<li><p><strong>projection</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Kms.SummaryType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The type of the returned summary - brief, normal, or full.
If {\@term.unset} a normal projection will be used.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-trusted-infrastructure-trusted-clusters-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client module<aclass="headerlink"href="#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ServicesAppliedConfig</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig"title="Permalink to this definition">¶</a></dt>
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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Health</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Health</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.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>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.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
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Health(string='OK')</span></em><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">health</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health"title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.ServicesAppliedConfig.Health"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Details regarding the health. When the
<codeclass="docutils literal notranslate"><spanclass="pre">ServicesAppliedConfig.Health</span></code> is not
<aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ServicesAppliedConfig.Health.OK</span></code></a>, this member will provide a
detailed description of the issues present. This attribute was
<codeclass="sig-name descname"><spanclass="pre">delete_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the cluster against which the operation will be executed.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the cluster against which the operation will be executed.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">update_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ID of the cluster against which the operation will be executed.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters_client.StubFactory"title="Permalink to this definition">¶</a></dt>
