mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 10:50:00 -05:00
1057 lines
83 KiB
HTML
1057 lines
83 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>com.vmware.vcenter.trusted_infrastructure.trusted_clusters package — vSphere Automation SDK for Python. 7.0.0.0 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.vcenter.vcha package" href="com.vmware.vcenter.vcha.html" />
|
||
<link rel="prev" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
7.0.0.0
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
||
|
||
<li><a href="com.vmware.vcenter.trusted_infrastructure.html">com.vmware.vcenter.trusted_infrastructure package</a> »</li>
|
||
|
||
<li>com.vmware.vcenter.trusted_infrastructure.trusted_clusters package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.vcenter.trusted_infrastructure.trusted_clusters.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters">
|
||
<span id="com-vmware-vcenter-trusted-infrastructure-trusted-clusters-package"></span><h1>com.vmware.vcenter.trusted_infrastructure.trusted_clusters package<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client">
|
||
<span id="com-vmware-vcenter-trusted-infrastructure-trusted-clusters-attestation-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client</span></code>
|
||
module provides classes for configuring Attestation Services for Trusted
|
||
Clusters.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.</code><code class="sig-name descname">Services</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services</span></code> class contains information about the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
instances a cluster uses. This class was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.CreateSpec</span></code> class contains the data necessary for adding a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
to the environment. This class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType</span></code></a>) – Source of truth for the configuration of the Attestation Service.
|
||
This attribute was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service’s unique ID. This attribute was added in vSphere API
|
||
7.0.0.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>. When
|
||
methods return a value of this class as a return value, the
|
||
attribute will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.SERVICE" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.SERVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType.SERVICE</span></code></a>.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The attestation cluster’s unique ID. This attribute was added in
|
||
vSphere API 7.0.0.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.CLUSTER" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.CLUSTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType.CLUSTER</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType">
|
||
<em class="property">class </em><code class="sig-name descname">SourceType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType</span></code> class lists options which source the
|
||
the Attestation Service to use for its configuration. This enumeration was
|
||
added in vSphere API 7.0.0.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.CLUSTER">
|
||
<code class="sig-name descname">CLUSTER</code><em class="property"> = SourceType(string='CLUSTER')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.CLUSTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The Attestation Service will be configured based on an ID of a whole
|
||
attestation cluster. This class attribute was added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.SERVICE">
|
||
<code class="sig-name descname">SERVICE</code><em class="property"> = SourceType(string='SERVICE')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec.SourceType.SERVICE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The Attestation Service will be configured based on an ID of an specific
|
||
Attestation Service. This class attribute was added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">services=None</em>, <em class="sig-param">address=None</em>, <em class="sig-param">group=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.FilterSpec</span></code> class contains the data necessary for
|
||
identifying a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>.
|
||
This class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A set of IDs by which to filter the services. This attribute was
|
||
added in vSphere API 7.0.0.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>. When
|
||
methods return a value of this class as a return value, the
|
||
attribute will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>.
|
||
If None, the services will not be filtered by ID.</p></li>
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The service’s address. This attribute was added in vSphere API
|
||
7.0.0.
|
||
If None, the services will not be filtered by address.</p></li>
|
||
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The group determines which
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
instances can accept reports issued by this
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
instance. This attribute was added in vSphere API 7.0.0.
|
||
If None, the services will not be filtered by group.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The cluster determines which Trust Authority Cluster this
|
||
<code class="docutils literal notranslate"><span class="pre">Services</span></code> belongs to. This attribute was added in vSphere API
|
||
7.0.0.
|
||
If None, the services will not be filtered by
|
||
trustAuthorityCluster.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">trusted_ca=None</em>, <em class="sig-param">group=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.Info</span></code> class contains all the stored information about a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>.
|
||
This class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>address</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
|
||
vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group ID determines which
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
instances this
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
can communicate with. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster determines which Trust Authority Cluster this
|
||
<code class="docutils literal notranslate"><span class="pre">Services</span></code> belongs to. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">service=None</em>, <em class="sig-param">address=None</em>, <em class="sig-param">group=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.Summary</span></code> class contains a summary of a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>.
|
||
This class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service’s unique identifier. This attribute was added in
|
||
vSphere API 7.0.0.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>. When
|
||
methods return a value of this class as a return value, the
|
||
attribute will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>.</p></li>
|
||
<li><p><strong>address</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group determines which
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
instances can accept reports issued by this
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
instance. This attribute was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster determines which Trust Authority Cluster this
|
||
<code class="docutils literal notranslate"><span class="pre">Services</span></code> belongs to. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.create_task">
|
||
<code class="sig-name descname">create_task</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.create_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configures the cluster to use a new
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>.
|
||
This method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.CreateSpec</span></code></a>) – Describes the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><dl class="field-list simple">
|
||
<dt class="field-odd">class</dt>
|
||
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Task instance</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
is already configured for this cluster</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
for any other error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the CreateSpec is not valid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the cluster ID is not valid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if all the hosts in the cluster do not have VMware vSphere Trust
|
||
Authority enabled license.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.delete_task">
|
||
<code class="sig-name descname">delete_task</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.delete_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Marks the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
so that it will no longer be used by the cluster. This method was added
|
||
in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the unique ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
instance unique identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if there is a generic error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
or the cluster are not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns detailed information for a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
configured for a cluster. This method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the service.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.attestation.Service</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Info" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Info for the specified
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if there is a generic error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the cluster or the service ID is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the list of all
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
configured for a cluster. This method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Only return services matching the filters.
|
||
If {\@term.unset} return all services.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.list" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Summary" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.Services.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of all
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
used by this cluster.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if there is a generic error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the cluster ID is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.attestation_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client">
|
||
<span id="com-vmware-vcenter-trusted-infrastructure-trusted-clusters-kms-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client</span></code>
|
||
module provides classes for configuring Key Provider Services for Trusted
|
||
Clusters.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.</code><code class="sig-name descname">Services</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services</span></code> class contains information about the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code> instances
|
||
a cluster uses. This class was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec">
|
||
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">service=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.CreateSpec</span></code> class contains the data necessary for adding a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code> to the
|
||
environment. This class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType</span></code></a>) – Source of truth for the configuration of the Key Provider Service.
|
||
This attribute was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service’s unique ID. This attribute was added in vSphere API
|
||
7.0.0.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.SERVICE" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.SERVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType.SERVICE</span></code></a>.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The attestation cluster’s unique ID. This attribute was added in
|
||
vSphere API 7.0.0.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.CLUSTER" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.CLUSTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType.CLUSTER</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType">
|
||
<em class="property">class </em><code class="sig-name descname">SourceType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.CreateSpec.SourceType</span></code> class lists options which source the
|
||
the Key Provider Service to use for its configuration. This enumeration was
|
||
added in vSphere API 7.0.0.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.CLUSTER">
|
||
<code class="sig-name descname">CLUSTER</code><em class="property"> = SourceType(string='CLUSTER')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.CLUSTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The Key Provider Service will be configured based on an ID of a whole
|
||
attestation cluster. This class attribute was added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.SERVICE">
|
||
<code class="sig-name descname">SERVICE</code><em class="property"> = SourceType(string='SERVICE')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec.SourceType.SERVICE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The Key Provider Service will be configured based on an ID of an specific
|
||
Key Provider Service. This class attribute was added in vSphere API 7.0.0.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.FilterSpec">
|
||
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param">services=None</em>, <em class="sig-param">address=None</em>, <em class="sig-param">group=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.FilterSpec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.FilterSpec</span></code> class contains the data necessary for
|
||
identifying a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>. This
|
||
class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A set of IDs by which to filter the services. This attribute was
|
||
added in vSphere API 7.0.0.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>.
|
||
If None, the services will not be filtered by ID.</p></li>
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The service’s address. This attribute was added in vSphere API
|
||
7.0.0.
|
||
If None, the services will not be filtered by address.</p></li>
|
||
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The group determines reports issued by which
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
instances can this
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
instance accept. This attribute was added in vSphere API 7.0.0.
|
||
If None, the services will not be filtered by group.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The cluster determines which Trust Authority Cluster this
|
||
<code class="docutils literal notranslate"><span class="pre">Services</span></code> belongs to. This attribute was added in vSphere API
|
||
7.0.0.
|
||
If None, the services will not be filtered by
|
||
trustAuthorityCluster.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Info">
|
||
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">address=None</em>, <em class="sig-param">trusted_ca=None</em>, <em class="sig-param">group=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.Info</span></code> class contains all the stored information about a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>. This
|
||
class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>address</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
<li><p><strong>trusted_ca</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.X509CertChain" title="com.vmware.vcenter.trusted_infrastructure_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.X509CertChain</span></code></a>) – The service’s TLS certificate chain. This attribute was added in
|
||
vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group determines reports issued by which
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
instances can this
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
instance accept. This attribute was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster determines which Trust Authority Cluster this
|
||
<code class="docutils literal notranslate"><span class="pre">Services</span></code> belongs to. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Summary">
|
||
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">service=None</em>, <em class="sig-param">address=None</em>, <em class="sig-param">group=None</em>, <em class="sig-param">trust_authority_cluster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Summary" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Services.Summary</span></code> class contains a summary of a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>. This
|
||
class was added in vSphere API 7.0.0.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service’s unique identifier. This attribute was added in
|
||
vSphere API 7.0.0.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>.</p></li>
|
||
<li><p><strong>address</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress" title="com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure_client.NetworkAddress</span></code></a>) – The service’s address. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The group determines reports issued by which
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.attestation_client.Services</span></code>
|
||
instances can this
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
instance accept. This attribute was added in vSphere API 7.0.0.</p></li>
|
||
<li><p><strong>trust_authority_cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster determines which Trust Authority Cluster this
|
||
<code class="docutils literal notranslate"><span class="pre">Services</span></code> belongs to. This attribute was added in vSphere API
|
||
7.0.0.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.create_task">
|
||
<code class="sig-name descname">create_task</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.create_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configures the cluster to use a new
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>. This
|
||
method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.CreateSpec</span></code></a>) – Describes the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><dl class="field-list simple">
|
||
<dt class="field-odd">class</dt>
|
||
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Task instance</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
|
||
if the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
is already configured for this cluster</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
for any other error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
||
if the CreateSpec is not valid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the cluster ID is not valid.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.UnableToAllocateResource" title="com.vmware.vapi.std.errors_client.UnableToAllocateResource"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnableToAllocateResource</span></code></a>
|
||
if all the hosts in the cluster do not have VMware vSphere Trust
|
||
Authority enabled license.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.delete_task">
|
||
<code class="sig-name descname">delete_task</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.delete_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Marks the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code> so
|
||
that it will no longer be used by the cluster. This method was added in
|
||
vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the unique ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
instance unique identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if there is a generic error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
or the cluster are not found.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns detailed information for a
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
configured for a cluster. This method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the service.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_platform.kms.Service</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Info" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Info for the specified
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if there is a generic error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the cluster or the service ID is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.list">
|
||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">cluster</em>, <em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the list of all
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
configured for a cluster. This method was added in vSphere API 7.0.0.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Only return services matching the filters.
|
||
If {\@term.unset} return all services.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.list" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Summary" title="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.Services.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Services.Summary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of all
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.kms_client.Services</span></code>
|
||
used by this cluster.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if there is a generic error.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the cluster ID is invalid.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the user can not be authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">TrustedAdmin.ReadTrustedHosts</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.View</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="com.vmware.vcenter.vcha.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vcha package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2020, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |