1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 20:09:58 -05:00
vsphere-automation-sdk-python/vsphere/7.0.2.0/com.vmware.vcenter.crypto_manager.html

1187 lines
97 KiB
HTML
Raw Normal View History

2021-03-17 10:57:48 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.crypto_manager package &mdash; vSphere Automation SDK for Python. 7.0.2.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.crypto_manager.hosts package" href="com.vmware.vcenter.crypto_manager.hosts.html" />
<link rel="prev" title="com.vmware.vcenter.content.registries package" href="com.vmware.vcenter.content.registries.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.2.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.oauth2_client">com.vmware.oauth2_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>
2021-03-17 10:57:48 -04:00
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li>com.vmware.vcenter.crypto_manager package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.crypto_manager.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.crypto_manager">
<span id="com-vmware-vcenter-crypto-manager-package"></span><h1>com.vmware.vcenter.crypto_manager package<a class="headerlink" href="#module-com.vmware.vcenter.crypto_manager" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html">com.vmware.vcenter.crypto_manager.hosts package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.crypto_manager.hosts.html#module-com.vmware.vcenter.crypto_manager.hosts.kms_client">com.vmware.vcenter.crypto_manager.hosts.kms_client module</a></li>
2021-03-17 10:57:48 -04:00
</ul>
</li>
</ul>
</div>
</div>
<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.crypto_manager.hosts_client">
<span id="com-vmware-vcenter-crypto-manager-hosts-client-module"></span><h2>com.vmware.vcenter.crypto_manager.hosts_client module<a class="headerlink" href="#module-com.vmware.vcenter.crypto_manager.hosts_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.hosts_client</span></code> module provides classes
for managing key providers and cryptographic keys on hosts.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.hosts_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.hosts_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.hosts_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.crypto_manager.kms_client">
<span id="com-vmware-vcenter-crypto-manager-kms-client-module"></span><h2>com.vmware.vcenter.crypto_manager.kms_client module<a class="headerlink" href="#module-com.vmware.vcenter.crypto_manager.kms_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms_client</span></code> module provides classes
for managing key providers and cryptographic keys.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.kms_client.</span></code><code class="sig-name descname"><span class="pre">Providers</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers" 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">Providers</span></code> class provides methods to create, retrieve, update,
delete, export and import providers. This class was added in vSphere API
7.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Constraints</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tpm_required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints" 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">Providers.Constraints</span></code> class contains constraints on a provider.
This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>tpm_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Determines if a provider is restricted to hosts with TPM 2.0
capability. This attribute was added in vSphere API 7.0.2.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConstraintsSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tpm_required</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec" 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">Providers.ConstraintsSpec</span></code> class contains constraints to be imposed
on a provider. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>tpm_required</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Determines if a provider is restricted to hosts with TPM 2.0
capability. This attribute was added in vSphere API 7.0.2.0.
If None, the constraint does not apply to the provider.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">native_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.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">Providers.CreateSpec</span></code> class contains attributes that describe the
desired configuration for a new provider. This class was added in vSphere
API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>Provider identifier.</p>
<p>A unique string provided by the client.. This attribute was added
in vSphere API 7.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p>
</p></li>
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConstraintsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The constraints on the provider. This attribute was added in
vSphere API 7.0.2.0.
If None there are no constraints on the provider.</p></li>
<li><p><strong>native_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Native provider create spec. This attribute was added in vSphere
API 7.0.2.0.
This attribute is required when creating a
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a> provider.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ExportResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult" 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">Providers.ExportResult</span></code> class contains result of
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.export" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.export"><code class="xref py py-func docutils literal notranslate"><span class="pre">Providers.export()</span></code></a> operation. This class was added in vSphere API
7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ExportType</span></code></a>) Type of provider export result. This attribute was added in vSphere
API 7.0.2.0.</p></li>
<li><p><strong>location</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Location" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Location</span></code></a>) Location of the exported configuration. This attribute was added in
vSphere API 7.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.ExportType.LOCATION</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ExportSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportSpec" 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">Providers.ExportSpec</span></code> class contains attributes that are needed to
export a provider. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Provider identifier. This attribute was added in vSphere API
7.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
<li><p><strong>password</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>) Password used to encrypt the exported configuration. This attribute
was added in vSphere API 7.0.2.0.
If None or empty, the configuration will not be encrypted.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ExportType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.ExportType</span></code> class identifies the type of result that is
returned when a provider is exported. This enumeration was added in vSphere
API 7.0.2.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ExportType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION">
<code class="sig-name descname"><span class="pre">LOCATION</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ExportType(string='LOCATION')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportType.LOCATION" title="Permalink to this definition"></a></dt>
<dd><p>Result returned as a URL from which the provider configuration can be
downloaded. This class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FilterSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">providers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code> class contains attributes used to filter the
results when listing providers. This class was added in vSphere API
7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>providers</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Provider identifiers. This attribute was added in vSphere API
7.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.
If None or empty, the result will not be filtered by provider
identifier.</p></li>
<li><p><strong>health</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Provider health status. This attribute was added in vSphere API
7.0.2.0.
If None or empty, the result will not be filtered by provider
health status.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Health</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> class describes the health status of a provider.
This enumeration was added in vSphere API 7.0.2.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Health</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>There is a critical issue that requires attention. This class attribute was
added in vSphere API 7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='NONE')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE" title="Permalink to this definition"></a></dt>
<dd><p>No health status is available. This class attribute was added in vSphere
API 7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK">
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='OK')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK" title="Permalink to this definition"></a></dt>
<dd><p>Operating normally. This class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Health(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Operating normally, but there is an issue that requires attention. This
class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ImportResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">native_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult" 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">Providers.ImportResult</span></code> class contains result of the
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider"><code class="xref py py-func docutils literal notranslate"><span class="pre">Providers.import_provider()</span></code></a> operation. This class was added in
vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Provider identifier. This attribute was added in vSphere API
7.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>native_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderInfo</span></code></a>) Native provider information. This attribute was added in vSphere
API 7.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>.</p></li>
<li><p><strong>export_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Time when the provider was exported. This attribute was added in
vSphere API 7.0.2.0.</p></li>
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Constraints</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The constraints on the provider. This attribute was added in
vSphere API 7.0.2.0.
If None, there are no constraints on the provider.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ImportSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dry_run</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportSpec" 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">Providers.ImportSpec</span></code> class contains attributes that are needed to
import a provider. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config</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>) Configuration to import. This attribute was added in vSphere API
7.0.2.0.
Currently this is required. Other import methods may be supported
in the future.</p></li>
<li><p><strong>password</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>) Password to decrypt the configuration to import. This attribute was
added in vSphere API 7.0.2.0.
If None or empty, configuration to import must be unencrypted.</p></li>
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ConstraintsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ConstraintsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Constraints to impose on the imported provider. This attribute was
added in vSphere API 7.0.2.0.
If None, the imported provider constraints will match the exported
provider constraints.</p></li>
<li><p><strong>dry_run</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Whether to perform a trial import without actuallly creating a
provider. This attribute was added in vSphere API 7.0.2.0.
If None, a new provider will be created.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">constraints</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">native_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.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">Providers.Info</span></code> class contains attributes that describe the details
of a provider. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a>) Health status of the provider. This attribute was added in vSphere
API 7.0.2.0.</p></li>
<li><p><strong>details</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) <p>Details regarding the health status of the provider.</p>
<p>When the provider <code class="docutils literal notranslate"><span class="pre">Providers.Health</span></code> is not
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.NONE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Health.NONE</span></code></a> or <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Health.OK</span></code></a>, this
attribute will provide actionable descriptions of the issues.. This
attribute was added in vSphere API 7.0.2.0.</p>
</p></li>
<li><p><strong>constraints</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Constraints"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Constraints</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) The constraints on the provider. This attribute was added in
vSphere API 7.0.2.0.
If None, there are no constraints on the provider.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>native_info</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderInfo</span></code></a>) Native provider information. This attribute was added in vSphere
API 7.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Location">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Location</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Location" 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">Providers.Location</span></code> class contains the location as well as a token
required (as a header in the HTTP GET request) to download the
configuration. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Provider configuration download URL. This attribute was added in
vSphere API 7.0.2.0.</p></li>
<li><p><strong>download_token</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Token" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Token"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Token</span></code></a>) Information about the token required in the HTTP GET request to
download the provider configuration. This attribute was added in
vSphere API 7.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NativeProviderCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_derivation_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderCreateSpec" 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">Providers.NativeProviderCreateSpec</span></code> class contains attributes that
describe the desired configuration for a <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>
provider. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Key identifier for the provider.</p>
<p>The key identifier is required to be a 128-bit UUID represented as
a hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
format.. This attribute was added in vSphere API 7.0.2.0.
If None, the key identifier will be generated automatically.</p>
</p></li>
<li><p><strong>key_derivation_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>) Key used to derive data encryption keys. Base64 encoded. This
attribute was added in vSphere API 7.0.2.0.
If None, the key derivation key will be generated automatically.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NativeProviderInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderInfo" 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">Providers.NativeProviderInfo</span></code> class contains attributes that
describe details of a native provider. This class was added in vSphere API
7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Key identifier for the provider. This attribute was added in
vSphere API 7.0.2.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">NativeProviderUpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec" 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">Providers.NativeProviderUpdateSpec</span></code> class contains attributes that
describe the desired configuration for <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a>
provider. Exporting a <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a> provider to create a
new back-up is suggested after any update. This class was added in vSphere
API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>key_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>Key identifier for the provider.</p>
<p>The key identifier is required to be a 128-bit UUID represented as
a hexadecimal string in “12345678-abcd-1234-cdef-123456789abc”
format.. This attribute was added in vSphere API 7.0.2.0.
If None, the key identifier will remain unchanged.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vcenter.crypto_manager.kms.provider'</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for a provider. This class attribute was added in vSphere API
7.0.2.0.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.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">Providers.Summary</span></code> class contains attributes that describe a
provider. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Provider identifier. This attribute was added in vSphere API
7.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Type</span></code></a>) Provider type. This attribute was added in vSphere API 7.0.2.0.</p></li>
<li><p><strong>health</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Health" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Health"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Health</span></code></a>) Health status of the provider. This attribute was added in vSphere
API 7.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Token">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Token</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expiry</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Token" 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">Providers.Token</span></code> class contains information about the token required
to be passed in the HTTP header in the HTTP GET request to download the
provider configuration. This class was added in vSphere API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) <p>A one-time, short-lived token required in “Authorization” field of
the HTTP header of the request to the url.</p>
<p>After the token expires, any attempt to download the configuration
with said token will fail.. This attribute was added in vSphere API
7.0.2.0.</p>
</p></li>
<li><p><strong>expiry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) Expiry time of the token. This attribute was added in vSphere API
7.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Type</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Providers.Type</span></code> class contains the types of providers. This
enumeration was added in vSphere API 7.0.2.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE">
<code class="sig-name descname"><span class="pre">NATIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Type(string='NATIVE')</span></em><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="Permalink to this definition"></a></dt>
<dd><p>Native provider. This class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">native_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec" 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">Providers.UpdateSpec</span></code> class contains attributes that describe the
new configuration for an existing provider. This class was added in vSphere
API 7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
2021-03-17 10:57:48 -04:00
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>native_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.NativeProviderUpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.NativeProviderUpdateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) <p>New Configuration for <a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Type.NATIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Providers.Type.NATIVE</span></code></a> provider.</p>
<p>. This attribute was added in vSphere API 7.0.2.0.
If None, provider configuration will remain unchanged.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.create" title="Permalink to this definition"></a></dt>
<dd><p>Add a new provider. This method was added in vSphere API 7.0.2.0.</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.crypto_manager.kms_client.Providers.CreateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code></a>) Provider information.</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.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 provider with the same identifier already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the spec is 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.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-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 the caller is not authorized.</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.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 creating a provider of the type is not supported.</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">Cryptographer.ManageKeyServers</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.delete" title="Permalink to this definition"></a></dt>
<dd><p>Remove a provider. This method was added in vSphere API 7.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the provider.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the provider identifier is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the provider is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<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 the caller is not authorized.</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.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 providers type does not allow deletion.</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">Cryptographer.ManageKeyServers</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.export">
<code class="sig-name descname"><span class="pre">export</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.export" title="Permalink to this definition"></a></dt>
<dd><p>Export provider configuration. This method was added in vSphere API
7.0.2.0.</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.crypto_manager.kms_client.Providers.ExportSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ExportSpec</span></code></a>) ExportSpec needed to export a provider.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ExportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ExportResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>ExportResult.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the provider identifier is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the provider with the identifier is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<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 the caller is not authorized.</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.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 providers type does not allow export.</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">Cryptographer.ManageKeyServers</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.get" title="Permalink to this definition"></a></dt>
<dd><p>Return information about a provider. This method was added in vSphere
API 7.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the provider.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.Info" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information of the provider.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the provider identifier is empty.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the provider is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<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 the caller is not authorized.</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">Cryptographer.ReadKeyServersInfo</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider">
<code class="sig-name descname"><span class="pre">import_provider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.import_provider" title="Permalink to this definition"></a></dt>
<dd><p>Import provider configuration. This method was added in vSphere API
7.0.2.0.</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.crypto_manager.kms_client.Providers.ImportSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ImportSpec</span></code></a>) ImportSpec needed to import a provider.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.ImportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.ImportResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>importResult ImportResult.</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.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 provider with the same identifier already exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the config or the password is 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.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-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 the caller is not authorized.</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">Cryptographer.ManageKeyServers</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.list" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of providers.</p>
<p>. This method was added in vSphere API 7.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Filter for the providers list.
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.FilterSpec</span></code></a> with all attributes None.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.list" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.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.crypto_manager.kms_client.Providers.Summary" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Summary of providers.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the spec 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.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the caller is not authorized.</p>
</dd>
<dt class="field-even">Raise</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">Cryptographer.ReadKeyServersInfo</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.Providers.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.update" title="Permalink to this definition"></a></dt>
<dd><p>Update an existing provider. This method was added in vSphere API
7.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>provider</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Identifier of the provider.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.crypto_manager.kms.provider</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec" title="com.vmware.vcenter.crypto_manager.kms_client.Providers.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code></a>) Provider information.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if there is a generic error.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the spec 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.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 provider is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<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 the caller is not authorized.</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.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 providers type does not allow updates.</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">Cryptographer.ManageKeyServers</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.crypto_manager.kms_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.crypto_manager.kms_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.crypto_manager.kms_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>
2021-03-17 10:57:48 -04:00
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.crypto_manager.hosts.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.crypto_manager.hosts package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vcenter.content.registries.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.content.registries package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>