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
0c2294f46c
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.vcenter.trusted_infrastructure.hosts.html

435 lines
42 KiB
HTML
Raw 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 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.hosts.hardware package" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html" />
<link rel="prev" title="com.vmware.vcenter.trusted_infrastructure package" href="com.vmware.vcenter.trusted_infrastructure.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 active">com.vmware.vcenter.trusted_infrastructure.hosts package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.trusted_infrastructure.hosts.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">
<span id="com-vmware-vcenter-trusted-infrastructure-hosts-package"></span><h1>com.vmware.vcenter.trusted_infrastructure.hosts package<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.hosts" title="Permalink to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html">com.vmware.vcenter.trusted_infrastructure.hosts.hardware package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.FilterSpec"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.FilterSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Info"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.PolicyPcrSpec"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.PolicyPcrSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.RESOURCE_TYPE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Summary"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Summary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Type</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type.ECC_NIST_P_256"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Type.ECC_NIST_P_256</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.Type.RSA_2048"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.Type.RSA_2048</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.UnsealSpec"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.UnsealSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.get"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.get()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.list"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EndorsementKeys.unseal"><code class="docutils literal notranslate"><span class="pre">EndorsementKeys.unseal()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog"><code class="docutils literal notranslate"><span class="pre">EventLog</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Info"><code class="docutils literal notranslate"><span class="pre">EventLog.Info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type"><code class="docutils literal notranslate"><span class="pre">EventLog.Type</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.Type.EFI_TCG2_EVENT_LOG_FORMAT_TCG_2"><code class="docutils literal notranslate"><span class="pre">EventLog.Type.EFI_TCG2_EVENT_LOG_FORMAT_TCG_2</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.EventLog.get"><code class="docutils literal notranslate"><span class="pre">EventLog.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm"><code class="docutils literal notranslate"><span class="pre">HashAlgorithm</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA256"><code class="docutils literal notranslate"><span class="pre">HashAlgorithm.SHA256</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA384"><code class="docutils literal notranslate"><span class="pre">HashAlgorithm.SHA384</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SHA512"><code class="docutils literal notranslate"><span class="pre">HashAlgorithm.SHA512</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.HashAlgorithm.SM3_256"><code class="docutils literal notranslate"><span class="pre">HashAlgorithm.SM3_256</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank"><code class="docutils literal notranslate"><span class="pre">PcrBank</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html#com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<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_client">
<span id="com-vmware-vcenter-trusted-infrastructure-hosts-hardware-client-module"></span><h2>com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client module<a class="headerlink" href="#module-com.vmware.vcenter.trusted_infrastructure.hosts.hardware_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_client</span></code> module
provides classes to manage trusted hardware.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_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_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_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>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm">
<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_client.</span></span><span class="sig-name descname"><span class="pre">Tpm</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_client.Tpm" 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">Tpm</span></code> interface provides methods to get available Trusted Platform
Module (TPM) information 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_client.Tpm.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">major_versions</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">active</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_client.Tpm.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">Tpm.FilterSpec</span></code> class contains attributes used to filter the results
when listing configured TPMs. 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>major_versions</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">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The TPM major version number. This attribute was added in vSphere
API 8.0.0.1.
if None or empty, the result will not be filtered by version
number.</p></li>
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The TPM status. This attribute was added in vSphere API 8.0.0.1.
if None, the result will not be filtered by status.</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_client.Tpm.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">major_version</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">minor_version</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">active</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</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">model</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">firmware_version</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_client.Tpm.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">Tpm.Info</span></code> class contains information that describes a TPM device.
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>major_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The TPM major version number. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>minor_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The TPM minor version number. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – <p>The TPM status.</p>
<p>Inactive TPMs cannot be used for sealing or attestation.. This
attribute was added in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>manufacturer</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 manufacturer. This attribute was added in vSphere API
8.0.0.1.
if None, manufacturer is not available.</p></li>
<li><p><strong>model</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 model. This attribute was added in vSphere API 8.0.0.1.
if None, model is not available.</p></li>
<li><p><strong>firmware_version</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 firmware version. This attribute was added in vSphere API
8.0.0.1.
if None, firmware version is not available.</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.html#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">com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank</span></code></a>) – The list of the PCR banks of the TPM device. This attribute was
added in vSphere API 8.0.0.1.</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_client.Tpm.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'</span></em><a class="headerlink" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for TPM. 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_client.Tpm.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">tpm</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">major_version</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">minor_version</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">active</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_client.Tpm.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">Tpm.Summary</span></code> class contains information that summarizes a TPM. 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>tpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique identifier for the TPM instance. 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</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</span></code>.</p></li>
<li><p><strong>major_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The TPM major version number. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>minor_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The TPM minor version number. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>active</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – <p>The TPM status.</p>
<p>Inactive TPMs cannot be used for sealing or attestation.. This
attribute was added in vSphere API 8.0.0.1.</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_client.Tpm.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_client.Tpm.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the TPM details 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>
</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_client.Tpm.Info" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tpm.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The TPM 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 any 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 the 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>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.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">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_client.Tpm.list" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of configured TPMs 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>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tpm.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_client.Tpm.FilterSpec" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tpm.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_client.Tpm.list" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.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_client.Tpm.Summary" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tpm.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 TPMs.</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 any 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 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>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.vcenter.trusted_infrastructure.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.trusted_infrastructure package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.vcenter.trusted_infrastructure.hosts.hardware.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.trusted_infrastructure.hosts.hardware 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