Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 02:39:59 -05:00
Code
8c9d844ce9
vsphere-automation-sdk-python/vsphere/7.0.1.0/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.html
anushah 0dbd127298 adding vSphere 7.0 U1 artifacts
2020-10-12 10:43:57 +05:30

614 lines
41 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package &mdash; vSphere Automation SDK for Python. 7.0.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms package" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html" />
<link rel="prev" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.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" alt="Documentation Home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.1.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" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.trusted_infrastructure.html">com.vmware.vcenter.trusted_infrastructure package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.html">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package</a> &raquo;</li>
<li>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os">
<span id="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-attestation-os-package"></span><h1>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os package<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os" 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.trust_authority_clusters.attestation.os.esx_client">
<span id="com-vmware-vcenter-trusted-infrastructure-trust-authority-clusters-attestation-os-esx-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client" title="Permalink to this headline"></a></h2>
<p>The
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client</span></code>
module provides the interfaces for configuring ESX host metadata.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.</code><code class="sig-name descname">BaseImages</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages" 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">BaseImages</span></code> class provides methods to manage trusted instances of
ESX software on a cluster level. This class was added in vSphere API
7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.FilterSpec">
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">health</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.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">BaseImages.FilterSpec</span></code> class contains the data necessary for
identifying a Trust Authority Host in a cluster. This class was added in
vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</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>) – Search criteria by ESX base image version numbers. This attribute
was added in vSphere API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage</span></code>.
When methods return a value of this class as a return value, the
attribute will contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage</span></code>.
version if {\&#64;term.unset} return all ESX version numbers.</p></li>
<li><p><strong>display_name</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>) – Search criteria by ESX base image version version numbers. This
attribute was added in vSphere API 7.0.0.0.
displayName if {\&#64;term.unset} return all ESX display version
numbers.</p></li>
<li><p><strong>health</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.Health</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Search criteria by health indicator. This attribute was added in
vSphere API 7.0.0.0.
health if {\&#64;term.unset} return all health indicators.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health">
<em class="property">class </em><code class="sig-name descname">Health</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImages.Health</span></code> class is indicator for the consistency of the
hosts status in the cluster. This enumeration was added in vSphere API
7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.ERROR">
<code class="sig-name descname">ERROR</code><em class="property"> = Health(string='ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Not all hosts in the cluster are in consistent state. This class attribute
was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.NONE">
<code class="sig-name descname">NONE</code><em class="property"> = Health(string='NONE')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.NONE" title="Permalink to this definition"></a></dt>
<dd><p>No status available. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.OK">
<code class="sig-name descname">OK</code><em class="property"> = Health(string='OK')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.OK" title="Permalink to this definition"></a></dt>
<dd><p>Each host in the cluster is in consistent state with the rest hosts in the
cluster. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.WARNING">
<code class="sig-name descname">WARNING</code><em class="property"> = Health(string='WARNING')</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Attestation is funtioning, however there is an issue that requires
attention. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">health</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.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">BaseImages.Info</span></code> class contains information that describes an ESX
base image. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique ESX version formatted for display. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.Health</span></code></a>) – A health indicator which indicates whether each host in the cluster
has this version of the ESX base image. This attribute was added in
vSphere API 7.0.0.0.</p></li>
<li><p><strong>details</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – <p>Details regarding the health.</p>
<p>When the <code class="docutils literal notranslate"><span class="pre">BaseImages.Health</span></code> is not <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.OK" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BaseImages.Health.OK</span></code></a>
or <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.NONE" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health.NONE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BaseImages.Health.NONE</span></code></a>, this member will provide an
actionable description of the issues present.. This attribute was
added in vSphere API 7.0.0.0.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.RESOURCE_TYPE">
<code class="sig-name descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage'</em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for ESX base image. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Summary">
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">health</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.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">BaseImages.Summary</span></code> class contains information that summarizes an
ESX base image. This class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique ESX version number. This attribute was added in vSphere
API 7.0.0.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage</span></code>.
When methods return a value of this class as a return value, the
attribute will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique ESX version formatted for display. This attribute was
added in vSphere API 7.0.0.0.</p></li>
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.Health</span></code></a>) – A health indicator which indicates whether each host in the cluster
has this version of the ESX base image. This attribute was added in
vSphere API 7.0.0.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.delete_task">
<code class="sig-name descname">delete_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">version</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.delete_task" title="Permalink to this definition"></a></dt>
<dd><p>Remove a trusted ESX base image of each ESX in the cluster. This method
was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ESX base image version.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage</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.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 version is invalid or the cluster id is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the version or cluster is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.get_task">
<code class="sig-name descname">get_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">version</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.get_task" title="Permalink to this definition"></a></dt>
<dd><p>Get the trusted ESX base version details. This method was added in
vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ESX base image version.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx.BaseImage</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 version is invalid or the cluster id is empty.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the version or cluster is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.import_from_imgdb_task">
<code class="sig-name descname">import_from_imgdb_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">imgdb</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.import_from_imgdb_task" title="Permalink to this definition"></a></dt>
<dd><p>Import ESX metadata as a new trusted base image to each host in the
cluster.</p>
<p>Import a boot_imgdb.tgz file which contains metadata that describes a
trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a
representative host.. This method was added in vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><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 on which the operation will be executed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>imgdb</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ESX metadata on a cluster level.</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 ESX metadata for the same version has already been added.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the imgdb is invalid or cluster id is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the cluster is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.list_task">
<code class="sig-name descname">list_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">spec</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.list_task" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of trusted ESX base images. This method was added in
vSphere API 7.0.0.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The id of the cluster on which the operation will be executed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.BaseImages.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImages.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The search specification.
if {\&#64;term.unset} return all information.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the cluster id is empty.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the cluster is not found.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms 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.attestation.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>
View Git Blame Copy Permalink