<spanid="com-vmware-vcenter-certificate-management-package"></span><h1>com.vmware.vcenter.certificate_management package<aclass="headerlink"href="#module-com.vmware.vcenter.certificate_management"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-certificate-management-vcenter-client-module"></span><h2>com.vmware.vcenter.certificate_management.vcenter_client module<aclass="headerlink"href="#module-com.vmware.vcenter.certificate_management.vcenter_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><codeclass="sig-name descname">Tls</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tls</span></code> interface provides methods to replace Tls certificate. This
class was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Tls.Info</span></code> class contains information from a TLS certificate. This
class was added in vSphere API 6.7.2.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – TLS certificate in PEM format. This attribute was added in vSphere
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="sig-name descname">Spec</code><spanclass="sig-paren">(</span><emclass="sig-param">cert=None</em>, <emclass="sig-param">key=None</em>, <emclass="sig-param">root_cert=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cert</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<li><p><strong>root_cert</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">renew</code><spanclass="sig-paren">(</span><emclass="sig-param">duration=None</em><spanclass="sig-paren">)</span><aclass="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
<ddclass="field-odd"><p><strong>duration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="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>
<codeclass="sig-name descname">replace_vmca_signed</code><spanclass="sig-paren">(</span><emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec"title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.ReplaceSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tls.ReplaceSpec</span></code></a>) – The information needed to generate VMCA signed Machine SSL</p>
<codeclass="sig-name descname">set</code><spanclass="sig-paren">(</span><emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.set"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec"title="com.vmware.vcenter.certificate_management.vcenter_client.Tls.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Tls.Spec</span></code></a>) – The information needed to replace the TLS certificate.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><codeclass="sig-name descname">TlsCsr</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr"title="Permalink to this definition">¶</a></dt>
request. This class was added in vSphere API 6.7.2.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">csr=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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>
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec"title="com.vmware.vcenter.certificate_management.vcenter_client.TlsCsr.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TlsCsr.Spec</span></code></a>) – The information needed to create a CSR.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><codeclass="sig-name descname">TrustedRootChains</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">CreateSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">cert_chain=None</em>, <emclass="sig-param">chain=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cert_chain</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain"title="com.vmware.vcenter.certificate_management_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">cert_chain=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cert_chain</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.certificate_management_client.X509CertChain"title="com.vmware.vcenter.certificate_management_client.X509CertChain"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.certificate_management_client.X509CertChain</span></code></a>) – A certificate chain in base64 encoding. This attribute was added in
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">chain=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>chain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier for chain. This attribute was added in vSphere
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">spec</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec"title="com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TrustedRootChains.CreateSpec</span></code></a>) – The information needed to create a trusted root certificate chain.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">chain</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">chain</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.get"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.TrustedRootChains.list"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vcenter.certificate_management.vcenter_client.</code><codeclass="sig-name descname">VmcaRoot</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot"title="Permalink to this definition">¶</a></dt>
Authority (VMCA) root certificate. This class was added in vSphere API
6.9.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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\@acme.com’.</p></li>
<li><p><strong>subject_alt_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">spec=None</em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec"title="com.vmware.vcenter.certificate_management.vcenter_client.VmcaRoot.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VmcaRoot.CreateSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The information needed to generate VMCA signed Root Certificate.
Default values will be set for all null parameters.</p>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
