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
621aa7b28d
vsphere-automation-sdk-python/vsphere/cloud/com.vmware.vcenter.certificate_management.html
Kunal Singh b34b4a2272 API Documentation for VMC M9 release 
Signed-off-by: Kunal Singh<singhk@vmware.com>
2020-01-27 14:29:56 +05:30

926 lines
68 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vcenter.certificate_management package &mdash; vSphere Automation SDK for Python. 7.0.0.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.compute package" href="com.vmware.vcenter.compute.html" />
<link rel="prev" title="com.vmware.vcenter package" href="com.vmware.vcenter.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li>com.vmware.vcenter.certificate_management package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.certificate_management.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.certificate_management">
<span id="com-vmware-vcenter-certificate-management-package"></span><h1>com.vmware.vcenter.certificate_management package<a class="headerlink" href="#module-com.vmware.vcenter.certificate_management" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.certificate_management.vcenter_client">
<span id="com-vmware-vcenter-certificate-management-vcenter-client-module"></span><h2>com.vmware.vcenter.certificate_management.vcenter_client module<a class="headerlink" href="#module-com.vmware.vcenter.certificate_management.vcenter_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management.vcenter_client</span></code> module
provides classes to manage certificates.</p>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">Tls</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tls</span></code> interface provides methods to replace Tls certificate. This
class was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">version=None</em>, <em class="sig-param">serial_number=None</em>, <em class="sig-param">signature_algorithm=None</em>, <em class="sig-param">issuer_dn=None</em>, <em class="sig-param">valid_from=None</em>, <em class="sig-param">valid_to=None</em>, <em class="sig-param">subject_dn=None</em>, <em class="sig-param">thumbprint=None</em>, <em class="sig-param">is_ca=None</em>, <em class="sig-param">path_length_constraint=None</em>, <em class="sig-param">key_usage=None</em>, <em class="sig-param">extended_key_usage=None</em>, <em class="sig-param">subject_alternative_name=None</em>, <em class="sig-param">authority_information_access_uri=None</em>, <em class="sig-param">cert=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.Info</span></code> class contains information from a TLS certificate. This
class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version (version number) value from the certificate. This attribute
was added in vSphere API 6.7.2.</p></li>
<li><p><strong>serial_number</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SerialNumber value from the certificate. This attribute was added
in vSphere API 6.7.2.</p></li>
<li><p><strong>signature_algorithm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Signature algorithm name from the certificate. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>issuer_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Issuer (issuer distinguished name) value from the certificate. This
attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>valid_from</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – validFrom specify the start date of the certificate. This attribute
was added in vSphere API 6.7.2.</p></li>
<li><p><strong>valid_to</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – validTo specify the end date of the certificate. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>subject_dn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Subject (subject distinguished name) value from the certificate.
This attribute was added in vSphere API 6.7.2.</p></li>
<li><p><strong>thumbprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Thumbprint value from the certificate. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>is_ca</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Certificate constraints isCA from the critical BasicConstraints
extension, (OID = 2.5.29.19). This attribute was added in vSphere
API 6.7.2.</p></li>
<li><p><strong>path_length_constraint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Certificate constraints path length from the critical
BasicConstraints extension, (OID = 2.5.29.19). This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>key_usage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of keyusage contained in the certificate. This attribute
was added in vSphere API 6.7.2.</p></li>
<li><p><strong>extended_key_usage</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of extended keyusage that contains details for which the
certificate can be used for. This attribute was added in vSphere
API 6.7.2.</p></li>
<li><p><strong>subject_alternative_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of subject alternative names. This attribute was added
in vSphere API 6.7.2.</p></li>
<li><p><strong>authority_information_access_uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Collection of authority information access URI. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>cert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – TLS certificate in PEM format. This attribute was added in vSphere
API 6.7.2.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec">
<em class="property">class </em><code class="sig-name descname">ReplaceSpec</code><span class="sig-paren">(</span><em class="sig-param">key_size=None</em>, <em class="sig-param">common_name=None</em>, <em class="sig-param">organization=None</em>, <em class="sig-param">organization_unit=None</em>, <em class="sig-param">locality=None</em>, <em class="sig-param">state_or_province=None</em>, <em class="sig-param">country=None</em>, <em class="sig-param">email_address=None</em>, <em class="sig-param">subject_alt_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.ReplaceSpec</span></code> class contains information to generate a Private
Key , CSR and hence VMCA signed machine SSL. This class was added in
vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key_size</strong> (<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 size of the key to be used for public and private key
generation. This attribute was added in vSphere API 6.7.2.
If None the key size will be ‘2048’.</p></li>
<li><p><strong>common_name</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 common name of the host for which certificate is generated.
This attribute was added in vSphere API 6.7.2.
If None will default to PNID of host.</p></li>
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization field in certificate subject. This attribute was added
in vSphere API 6.7.2.</p></li>
<li><p><strong>organization_unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization unit field in certificate subject. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>locality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Locality field in certificate subject. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>state_or_province</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – State field in certificate subject. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>country</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Country field in certificate subject. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>email_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Email field in Certificate extensions. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>subject_alt_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SubjectAltName is list of Dns Names and Ip addresses. This
attribute was added in vSphere API 6.7.2.
If None PNID of host will be used as IPAddress or Hostname for
certificate generation .</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec">
<em class="property">class </em><code class="sig-name descname">Spec</code><span class="sig-paren">(</span><em class="sig-param">cert=None</em>, <em class="sig-param">key=None</em>, <em class="sig-param">root_cert=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Tls.Spec</span></code> class contains information for a Certificate and Private
Key. This class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cert</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate string in PEM format. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>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>) – Private key string in PEM format. This attribute was added in
vSphere API 6.7.2.
If None the private key from the certificate store will be used. It
is required when replacing the certificate with a third party
signed certificate.</p></li>
<li><p><strong>root_cert</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>) – Third party Root CA certificate in PEM format. This attribute was
added in vSphere API 6.9.1.
If None the new third party root CA certificate will not be added
to the trust store. It is required when replacing the certificate
with a third party signed certificate if the root certificate of
the third party is not already a trusted root.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the rhttpproxy TLS certificate. This method was added in
vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.Info</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>TLS certificate.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the rhttpproxy certificate is not present in VECS store.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if failed due to generic exception.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.renew">
<code class="sig-name descname">renew</code><span class="sig-paren">(</span><em class="sig-param">duration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.renew" title="Permalink to this definition"></a></dt>
<dd><p>Renews the TLS certificate for the given duration period.</p>
<p>After this method completes, the services using the certificate will be
restarted for the new certificate to take effect.. This method was
added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>duration</strong> (<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 duration (in days) of the new TLS certificate. The duration
should be less than or equal to 730 days.
If None, the duration will be 730 days (two years).</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
If the TLS certificate is not VMCA generated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the duration period specified is invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 the system failed to renew the TLS certificate.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.replace_vmca_signed">
<code class="sig-name descname">replace_vmca_signed</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.replace_vmca_signed" title="Permalink to this definition"></a></dt>
<dd><p>Replace MACHINE SSL with VMCA signed one with the given Spec.The system
will go for restart.</p>
<p>After this method completes, the services using the certificate will be
restarted for the new certificate to take effect.. This method was
added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.ReplaceSpec</span></code></a>) – The information needed to generate VMCA signed Machine SSL</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the Spec given is not complete or invalid</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If the system failed to replace the machine ssl certificate</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.Tls.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.set" title="Permalink to this definition"></a></dt>
<dd><p>Replaces the rhttpproxy TLS certificate with the specified certificate.
This method can be used in three scenarios :</p>
<ol class="arabic simple">
<li><p>When the CSR is created and the private key is already stored, this
method can replace the certificate. The certificate but not the private
key and root certificate must be provided as input.</p></li>
<li><p>When the certificate is signed by a third party certificate
authority/VMCA and the root certificate of the third party certificate
authority/VMCA is already one of the trusted roots in the trust store,
this method can replace the certificate and private key. The
certificate and the private key but not the root certificate must be
provided as input.</p></li>
<li><p>When the certificate is signed by a third party certificate
authority and the root certificate of the third party certificate
authority is not one of the trusted roots in the trust store, this
method can replace the certificate, private key and root CA
certificate. The certificate, private key and root certificate must be
provided as input.</p></li>
</ol>
<p>After this method completes, the services using the certificate will be
restarted for the new certificate to take effect.</p>
<p>The above three scenarios are only supported from vsphere 7.0 onwards..
This method was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec" title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tls.Spec</span></code></a>) – The information needed to replace the TLS certificate.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the private key is not present in the VECS store.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
If the specified certificate thumbprint is the same as the existing
TLS certificate thumbprint.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If the system failed to replace the TLS certificate.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">TlsCsr</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr</span></code> interface provides methods to generate certificate signing
request. This class was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">csr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr.Info</span></code> class contains information for a Certificate signing
request. This class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>csr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Certificate Signing Request in PEM format. This attribute was added
in vSphere API 6.7.2.</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec">
<em class="property">class </em><code class="sig-name descname">Spec</code><span class="sig-paren">(</span><em class="sig-param">key_size=None</em>, <em class="sig-param">common_name=None</em>, <em class="sig-param">organization=None</em>, <em class="sig-param">organization_unit=None</em>, <em class="sig-param">locality=None</em>, <em class="sig-param">state_or_province=None</em>, <em class="sig-param">country=None</em>, <em class="sig-param">email_address=None</em>, <em class="sig-param">subject_alt_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TlsCsr.Spec</span></code> class contains information to generate a Private Key
and CSR. This class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key_size</strong> (<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>) – This attribute was added in vSphere API 6.7.2.
keySize will take 2048 bits if not modified.</p></li>
<li><p><strong>common_name</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>) – This attribute was added in vSphere API 6.7.2.
commonName will take PNID if not modified.</p></li>
<li><p><strong>organization</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization field in certificate subject. This attribute was added
in vSphere API 6.7.2.</p></li>
<li><p><strong>organization_unit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization unit field in certificate subject. This attribute was
added in vSphere API 6.7.2.</p></li>
<li><p><strong>locality</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Locality field in certificate subject. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>state_or_province</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – State field in certificate subject. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>country</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Country field in certificate subject. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>email_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Email field in Certificate extensions. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>subject_alt_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 6.7.2.
subjectAltName is list of Dns Names and Ip addresses</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.create" title="Permalink to this definition"></a></dt>
<dd><p>Generates a CSR with the given Spec. This method was added in vSphere
API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec" title="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsCsr.Spec</span></code></a>) – The information needed to create a CSR.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsCsr.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A Certificate Signing Request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If CSR could not be created for given spec for a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">TrustedRootChains</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains</span></code> interface provides methods to create, modify,
delete and read trusted root certificate chains. This class was added in
vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec">
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">cert_chain=None</em>, <em class="sig-param">chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.CreateSpec</span></code> class contains information to create a
trusted root certificate chain. This class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cert_chain</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain" title="com.vmware.vcenter.certificate_management_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a>) – Certificate chain in base64 encoding. This attribute was added in
vSphere API 6.7.2.</p></li>
<li><p><strong>chain</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>) – Unique identifier for this trusted root. Client can specify at
creation as long as it is unique, otherwise one will be generated.
An example of a client providing the identifier would be if this
trusted root is associated with a VC trust. In this case the
identifier would be the domain id. This attribute was added in
vSphere API 6.7.2.
A unique id will be generated if not given.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info">
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param">cert_chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.Info</span></code> class contains information for a trusted
root certificate chain. This class was added in vSphere API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cert_chain</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain" title="com.vmware.vcenter.certificate_management_client.X509CertChain"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a>) – A certificate chain in base64 encoding. This attribute was added in
vSphere API 6.7.2.</p>
</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary">
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">chain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TrustedRootChains.Summary</span></code> class contains a trusted root certificate
chain summary suitable for UI presentation. This class was added in vSphere
API 6.7.2.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for chain. This attribute was added in vSphere
API 6.7.2.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new trusted root certificate chain from the CreateSpec. This
method was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.CreateSpec</span></code></a>) – The information needed to create a trusted root certificate chain.</p>
</dd>
<dt class="field-even">Return type</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</dt>
<dd class="field-odd"><p>The unique identifier for the new trusted root chain.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 authorization is not given to caller.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a trusted root certificate chain exists with id in given spec.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">chain</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes trusted root certificate chain for a given identifier. This
method was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for a trusted root cert chain.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 authorization is not given to caller.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a trusted root certificate chain does not exist for given id.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Manage</span></code> and
<code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">chain</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve a trusted root certificate chain for a given identifier. This
method was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Unique identifier for a trusted root cert chain.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>TrustedRootChain.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 authorization is not given to caller.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a trusted root certificate chain does not exist for given id.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns summary information for each trusted root certificate chain.
This method was added in vSphere API 6.7.2.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.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.certificate_management.vcenter_client.TrustedRootChains.Summary" title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustedRootChains.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of trusted root certificate chains summaries.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization is not given to caller.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><code class="sig-name descname">VmcaRoot</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VmcaRoot</span></code> interface provides methods to replace VMware Certificate
Authority (VMCA) root certificate. This class was added in vSphere API
6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="class">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec">
<em class="property">class </em><code class="sig-name descname">CreateSpec</code><span class="sig-paren">(</span><em class="sig-param">key_size=None</em>, <em class="sig-param">common_name=None</em>, <em class="sig-param">organization=None</em>, <em class="sig-param">organization_unit=None</em>, <em class="sig-param">locality=None</em>, <em class="sig-param">state_or_province=None</em>, <em class="sig-param">country=None</em>, <em class="sig-param">email_address=None</em>, <em class="sig-param">subject_alt_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">VmcaRoot.CreateSpec</span></code> contains information. to generate a Private Key
and CSR. This class was added in vSphere API 6.9.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key_size</strong> (<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 size of the key to be used for public and private key
generation. This attribute was added in vSphere API 6.9.1.
If None the key size will be 2048.</p></li>
<li><p><strong>common_name</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 common name of the host for which certificate is generated.
This attribute was added in vSphere API 6.9.1.
If None the common name will be the primary network identifier
(PNID) of the vCenter Virtual Server Appliance (VCSA).</p></li>
<li><p><strong>organization</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>) – Organization field in certificate subject. This attribute was added
in vSphere API 6.9.1.
If None the organization will be ‘VMware’.</p></li>
<li><p><strong>organization_unit</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>) – Organization unit field in certificate subject. This attribute was
added in vSphere API 6.9.1.
If None the organization unit will be ‘VMware Engineering’.</p></li>
<li><p><strong>locality</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>) – Locality field in certificate subject. This attribute was added in
vSphere API 6.9.1.
If None the locality will be ‘Palo Alto’.</p></li>
<li><p><strong>state_or_province</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>) – State field in certificate subject. This attribute was added in
vSphere API 6.9.1.
If None the state will be ‘California’.</p></li>
<li><p><strong>country</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>) – Country field in certificate subject. This attribute was added in
vSphere API 6.9.1.
If None the country will be ‘US’.</p></li>
<li><p><strong>email_address</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>) – Email field in Certificate extensions. This attribute was added in
vSphere API 6.9.1.
If None the emailAddress will be ‘email\&#64;acme.com’.</p></li>
<li><p><strong>subject_alt_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – SubjectAltName is list of Dns Names and Ip addresses. This
attribute was added in vSphere API 6.9.1.
If None PNID of host will be used as IPAddress or Hostname for
certificate generation.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.create" title="Permalink to this definition"></a></dt>
<dd><p>Replace Root Certificate with VMCA signed one using the given Spec.</p>
<p>After this method completes, the services using the certificate will be
restarted for the new certificate to take effect.. This method was
added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec" title="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmcaRoot.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The information needed to generate VMCA signed Root Certificate.
Default values will be set for all null parameters.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If the system failed to renew the TLS certificate.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">CertificateManagement.Administer</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.compute.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.compute package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.vcenter.html" class="btn btn-neutral float-left" title="com.vmware.vcenter package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink