Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
Code
gh-pages
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html

837 lines
76 KiB
HTML
Raw Permalink Normal View History

Updated VC docs for v8.0.3.0 (#424) Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com> Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
2024-07-03 08:14:27 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.trusted_infrastructure.hosts.hardware package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package" href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html" />
<link rel="prev" title="com.vmware.vcenter.trusted_infrastructure.hosts package" href="com.vmware.vcenter.trusted_infrastructure.hosts.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.esx_client">com.vmware.esx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.snapservice_client">com.vmware.snapservice_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.trusted_infrastructure.html">com.vmware.vcenter.trusted_infrastructure package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.trusted_infrastructure.hosts.html">com.vmware.vcenter.trusted_infrastructure.hosts package</a></li>
<li class="breadcrumb-item active">com.vmware.vcenter.trusted_infrastructure.hosts.hardware package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.trusted_infrastructure.hosts.hardware.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware">
<span id="com-vmware-vcenter-trusted-infrastructure-hosts-hardware-package"></span><h1>com.vmware.vcenter.trusted_infrastructure.hosts.hardware package<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware" title="Permalink to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client">
<span id="com-vmware-vcenter-trusted-infrastructure-hosts-hardware-tpm-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client</span></code>
module provides classes to manage Trusted Platform Modules (TPMs).</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.</span></span><span class="sig-name descname"><span class="pre">EndorsementKeys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EndorsementKeys</span></code> interface provides methods to get the Trusted
Platform Module (TPM) Endorsement Key (EK) on a host. This class was added
in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EndorsementKeys.FilterSpec</span></code> class contains attributes used to filter
the results when listing the endorsement key. This class was added in
vSphere API 8.0.0.1.</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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>types</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.hosts.hardware.tpm_client.EndorsementKeys.Type" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.Type</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Type of the endorsement key. This attribute was added in vSphere
API 8.0.0.1.
if None or empty, the result will not be filtered by <code class="docutils literal notranslate"><span class="pre">types</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_area</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualified_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">manufacturer_certificate_uri</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">manufacturer_certificates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Info</span></code> class contains information that describes a
TPM endorsement key. This class was added in vSphere API 8.0.0.1.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.Type</span></code></a>) – The TPM endorsement key type. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>public_area</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The TPM endorsement key public area.</p>
<p>The public area is a TPM2B_PUBLIC structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 12.2.5
TPM2B_PUBLIC. This attribute was added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The TPM endorsement key name.</p>
<p>The name is a TPM2B_NAME structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 10.5.3
TPM2B_NAME. This attribute was added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>qualified_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The TPM endorsement key qualified name.</p>
<p>The qualified name is a TPM2B_NAME structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 10.5.3
TPM2B_NAME. This attribute was added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>public_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The TPM public endorsement key in PEM format. This attribute was
added in vSphere API 8.0.0.1.
if None, the PEM format public key could not be determined.</p></li>
<li><p><strong>certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The TPM endorsement key certificate in PEM format. This attribute
was added in vSphere API 8.0.0.1.
if None, the certificate cannot be retrieved from the TPM.</p></li>
<li><p><strong>manufacturer_certificate_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The TPM endorsement key issuer URL extracted from the TPM
endorsement key certificate. This attribute was added in vSphere
API 8.0.0.1.
if None, the URI cannot be retrieved from the endorsement key
certificate.</p></li>
<li><p><strong>manufacturer_certificates</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The TPM manufacturer’s endorsement key certificate chain.</p>
<p>Endorsement key certificates are signed by the TPM manufacturer.
When available, the <code class="docutils literal notranslate"><span class="pre">manufacturerCertificates</span></code> attribute will
contain the TPM manufacturer’s endorsement key certificate chain..
This attribute was added in vSphere API 8.0.0.1.
if None, the certificate chain is not available.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.PolicyPcrSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PolicyPcrSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pcr_digest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.PolicyPcrSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EndorsementKeys.PolicyPcrSpec</span></code> class contains information that can
be used to construct a PCR policy session for unsealing a secret using the
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.unseal" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.unseal"><code class="xref py py-func docutils literal notranslate"><span class="pre">EndorsementKeys.unseal()</span></code></a> operation. This class was added in vSphere
API 8.0.0.1.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pcrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The PCRs to which the data is sealed.</p>
<p>The PCR selection is a TPML_PCR_SELECTION structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 10.9.7
TPML_PCR_SELECTION. This attribute was added in vSphere API
8.0.0.1.</p>
</p></li>
<li><p><strong>pcr_digest</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The digest of the PCRs selected in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">EndorsementKeys.PolicyPcrSpec.pcrs</span></code>.</p>
<p>The digest is a TPM2B_DIGEST structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 10.4.2
TPM2B_DIGEST. This attribute was added in vSphere API 8.0.0.1.
If None, then the PCR digest is calculated by the service based on
the current PCR state.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey'</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for TPM endorsement Key. This class attribute was added in
vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Summary</span></code> class contains information that describes a
TPM endorsement key. This class was added in vSphere API 8.0.0.1.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique identifier for the TPM endorsement key. This attribute was
added in vSphere API 8.0.0.1.
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.hosts.hardware.tpm.EndorsementKey</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.hosts.hardware.tpm.EndorsementKey</span></code>.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.Type</span></code></a>) – The TPM endorsement key type. This attribute was added in vSphere
API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Type</span></code> class defines the endorsement key type based
on key algorithms. This enumeration was added in vSphere API 8.0.0.1.</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="bora/vspherevmodl2/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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type.ECC_NIST_P_256">
<span class="sig-name descname"><span class="pre">ECC_NIST_P_256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='ECC_NIST_P_256')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type.ECC_NIST_P_256" title="Permalink to this definition"></a></dt>
<dd><p>The ECC NISTP-256 bit key. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type.RSA_2048">
<span class="sig-name descname"><span class="pre">RSA_2048</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='RSA_2048')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type.RSA_2048" title="Permalink to this definition"></a></dt>
<dd><p>The RSA 2048 bit key. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.UnsealSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UnsealSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">public_area</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">private_area</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy_pcr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.UnsealSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EndorsementKeys.UnsealSpec</span></code> class contains information that
describes the structures required to unseal a secret. This class was added
in vSphere API 8.0.0.1.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>public_area</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The public area which corresponding to the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">EndorsementKeys.UnsealSpec.private_area</span></code> secret that is
being unsealed.</p>
<p>The public area is a TPM2B_PUBLIC structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 12.2.5
TPM2B_PUBLIC</p>
<p>This public area is used as the “objectPublic” input to the
TPM2_Import command.</p>
<p>Trusted Platform Module Library Part 3: Commands, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 13.3
TPM2_Import. This attribute was added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>private_area</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>A private area that contains a secret to be unsealed.</p>
<p>The private area is symmetrically encrypted with the seed value
derived from <code class="xref py py-attr docutils literal notranslate"><span class="pre">EndorsementKeys.UnsealSpec.seed</span></code>.</p>
<p>The private area is a TPM2B_PRIVATE structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 12.3.7
TPM2B_PRIVATE</p>
<p>This private area is used as the “duplicate” input to the
TPM2_Import command.</p>
<p>Trusted Platform Module Library Part 3: Commands, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 13.3
TPM2_Import. This attribute was added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>seed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>A seed value that is encrypted by the TPM endorsement key.</p>
<p>The seed will be decrypted with the endorsement key and then will
be used as a symmetric key to decrypt
<code class="xref py py-attr docutils literal notranslate"><span class="pre">EndorsementKeys.UnsealSpec.private_area</span></code>. This ensures that
only a TPM with the expected endorsement key can unseal the secret.</p>
<p>The seed value is a TPM2B_ENCRYPTED_SECRET structure.</p>
<p>Trusted Platform Module Library Part 2: Structures, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 11.4.3
TPM2B_ENCRYPTED_SECRET</p>
<p>This seed is used as the “inSymSeed” input to the TPM2_Import
command.</p>
<p>Trusted Platform Module Library Part 3: Commands, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 13.3
TPM2_Import. This attribute was added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>policy_pcr</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.PolicyPcrSpec" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.PolicyPcrSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.PolicyPcrSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>PCR policy required to unseal the secret.</p>
<p>Used as input to the TPM2_PolicyPCR command on a session that is
created for issuing the TPM2_Unseal command.</p>
<p>Trusted Platform Module Library Part 3: Commands, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 23.7
TPM2_PolicyPCR. This attribute was added in vSphere API 8.0.0.1.
If None, then a zeroed authorization policy is used for the
TPM2_Unseal session.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the TPM endorsement key details on a host.</p>
<p>The information returned is derived from executing the TPM2_ReadPublic
command on the endorsement key object handle.</p>
<p>Trusted Platform Module Library Part 3: Commands, Family “2.0”, Level
00 Revision 01.59, November 8, 2019, Section 12.4 TPM2_ReadPublic. This
method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>tpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the TPM identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm</span></code>.</p></li>
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the endorsement key identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Info" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The endorsement key info.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></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 arguments are invalid.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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 endorsement key, or the TPM device, or the host is not
found.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if too many requests are in progress.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></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 the caller is not authorized.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">Host.Tpm.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.list" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of configured endorsement keys on a host. This method was
added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>tpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the TPM identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm</span></code>.</p></li>
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – a filter for the returned list.
if None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.FilterSpec</span></code></a> with attributes None.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.list" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.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.hosts.hardware.tpm_client.EndorsementKeys.Summary" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A list of configured endorsement keys.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></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 arguments are invalid.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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 TPM device, or the host is not found.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if too many requests are in progress.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></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 the caller is not authorized.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">Host.Tpm.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.unseal">
<span class="sig-name descname"><span class="pre">unseal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.unseal" title="Permalink to this definition"></a></dt>
<dd><p>Unseal a secret that is bound to an endorsement key.</p>
<p>Provided with duplicate key data, load the key as a child of the
specified endorsement key using the TPM2_Import command and then unseal
the secret data using the TPM2_Unseal command.</p>
<p>The duplicate key must include only outer wrapping; inner wrapping is
not supported. The duplicate key cannot have a complex authorization
policy (e.g. including command selection, locality, etc). Only PCR
policy authorization is supported at this time.</p>
<p>Trusted Platform Module Library Part 1: Architecture, Family “2.0”,
Level 00 Revision 01.59, November 8, 2019, Section 23.3 Duplication</p>
<p>Trusted Platform Module Library Part 3: Commands, Family “2.0”, Level
00 Revision 01.59, November 8, 2019, Section 13.3 TPM2_Import</p>
<p>Trusted Platform Module Library Part 3: Commands, Family “2.0”, Level
00 Revision 01.59, November 8, 2019, Section 12.7 TPM2_Unseal. This
method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>tpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the TPM identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm</span></code>.</p></li>
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the endorsement key identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm.EndorsementKey</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.UnsealSpec" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.UnsealSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndorsementKeys.UnsealSpec</span></code></a>) – the unseal spec.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The unsealed secret.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></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 arguments are invalid.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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 endorsement key or TPM is not found.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if too many requests are in progress.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></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 the caller is not authorized.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">Host.Tpm.Unseal</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.</span></span><span class="sig-name descname"><span class="pre">EventLog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EventLog</span></code> interface provides methods to get the Trusted Platform
Module (TPM) event log on a host. This class was added in vSphere API
8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">truncated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">banks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EventLog.Info</span></code> class contains information that describes an event
log. This class was added in vSphere API 8.0.0.1.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventLog.Type</span></code></a>) – Type of the event log. This attribute was added in vSphere API
8.0.0.1.</p></li>
<li><p><strong>data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Event log data in the format described by
<code class="xref py py-attr docutils literal notranslate"><span class="pre">EventLog.Info.type</span></code>. This attribute was added in vSphere API
8.0.0.1.
This attribute is currently required. It may be optional in a
future version.</p></li>
<li><p><strong>truncated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – <p>Indicates if the event log is truncated.</p>
<p>An event log is truncated when there was insufficient memory to
store one or more event entries.. This attribute was added in
vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>banks</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank"><code class="xref py py-class docutils literal notranslate"><span class="pre">PcrBank</span></code></a>) – The resulting PCR banks from event log replay. This attribute was
added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EventLog.Type</span></code> class lists the event log types. This enumeration was
added in vSphere API 8.0.0.1.</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="bora/vspherevmodl2/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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type.EFI_TCG2_EVENT_LOG_FORMAT_TCG_2">
<span class="sig-name descname"><span class="pre">EFI_TCG2_EVENT_LOG_FORMAT_TCG_2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Type(string='EFI_TCG2_EVENT_LOG_FORMAT_TCG_2')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type.EFI_TCG2_EVENT_LOG_FORMAT_TCG_2" title="Permalink to this definition"></a></dt>
<dd><p>TCG EFI Protocol Specification, Family “2.0”, Level 00 Revision 00.13,
March 30, 2016, Section 5.2 Crypto Agile Log Entry Format. This class
attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpm</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the event log associated with the TPM device. This method was
added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the host.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>tpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the TPM identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Info" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventLog.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The event information.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></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 argument is invalid.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></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 event log is not found, or tpm is not found or host is not
found.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if too many requests are in progress.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></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 the caller is not authorized.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
requires <code class="docutils literal notranslate"><span class="pre">Host.Tpm.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.</span></span><span class="sig-name descname"><span class="pre">HashAlgorithm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HashAlgorithm</span></code> class defines the possible hash algorithms. This
enumeration was added in vSphere API 8.0.0.1.</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="bora/vspherevmodl2/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<span class="colon">:</span></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 <a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HashAlgorithm</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA256">
<span class="sig-name descname"><span class="pre">SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">HashAlgorithm(string='SHA256')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA256" title="Permalink to this definition"></a></dt>
<dd><p>The SHA 256 hash algorithm. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA384">
<span class="sig-name descname"><span class="pre">SHA384</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">HashAlgorithm(string='SHA384')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA384" title="Permalink to this definition"></a></dt>
<dd><p>The SHA 384 hash algorithm. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA512">
<span class="sig-name descname"><span class="pre">SHA512</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">HashAlgorithm(string='SHA512')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA512" title="Permalink to this definition"></a></dt>
<dd><p>The SHA 512 hash algorithm. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SM3_256">
<span class="sig-name descname"><span class="pre">SM3_256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">HashAlgorithm(string='SM3_256')</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SM3_256" title="Permalink to this definition"></a></dt>
<dd><p>The SM3 hash algorithm. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.</span></span><span class="sig-name descname"><span class="pre">PcrBank</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pcrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PcrBank</span></code> class contains information that describes digest
information of a PCR bank. This class was added in vSphere API 8.0.0.1.</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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>algorithm</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm"><code class="xref py py-class docutils literal notranslate"><span class="pre">HashAlgorithm</span></code></a>) – The hash algorithm that is used by TPM to calculate the PCR values.
This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>pcrs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The index of PCR and corresponding TPM digest value. This attribute
was added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.vcenter.trusted_infrastructure.hosts.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.trusted_infrastructure.hosts package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink