Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 02:39:59 -05:00
Code
0735db02a9
vsphere-automation-sdk-python/vsphere/8.0.0.1/vmware.vapi.security.client.html
aagrawal3 eccc4f4dcb
Added docs for vSphere 8.0GA 
Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
2022-10-12 17:31:15 +05:30

404 lines
21 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>vmware.vapi.security.client package &mdash; vSphere Automation SDK for Python. 8.0.0.1 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="vmware.vapi.vsphere package" href="vmware.vapi.vsphere.html" />
<link rel="prev" title="vmware.vapi.security package" href="vmware.vapi.security.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.0.1
</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"><a class="reference internal" href="com.html">com package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="vmware.html">vmware package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="vmware.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="vmware.vapi.html">vmware.vapi package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="vmware.vapi.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#module-vmware.vapi.core">vmware.vapi.core module</a></li>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#module-vmware.vapi.exception">vmware.vapi.exception module</a></li>
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.html#module-vmware.vapi.message">vmware.vapi.message module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="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="vmware.html">vmware package</a> &raquo;</li>
<li><a href="vmware.vapi.html">vmware.vapi package</a> &raquo;</li>
<li><a href="vmware.vapi.security.html">vmware.vapi.security package</a> &raquo;</li>
<li>vmware.vapi.security.client package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/vmware.vapi.security.client.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-vmware.vapi.security.client">
<span id="vmware-vapi-security-client-package"></span><h1>vmware.vapi.security.client package<a class="headerlink" href="#module-vmware.vapi.security.client" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-vmware.vapi.security.client.security_context_filter">
<span id="vmware-vapi-security-client-security-context-filter-module"></span><h2>vmware.vapi.security.client.security_context_filter module<a class="headerlink" href="#module-vmware.vapi.security.client.security_context_filter" title="Permalink to this headline"></a></h2>
<p>SecurityContext API Provider filter</p>
<dl class="py class">
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">vmware.vapi.security.client.security_context_filter.</span></code><code class="sig-name descname"><span class="pre">LegacySecurityContextFilter</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">next_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">security_context</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="#vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.security.client.security_context_filter.SecurityContextFilter" title="vmware.vapi.security.client.security_context_filter.SecurityContextFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.security.client.security_context_filter.SecurityContextFilter</span></code></a></p>
<p>SecurityContextFilter in API Provider chain adds the security
context to the execution context passed in.</p>
<p>Initialize SecurityContextFilter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>next_provider</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiProvider" title="vmware.vapi.core.ApiProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ApiProvider</span></code></a>) – API Provider to invoke the requests</p></li>
<li><p><strong>security_context</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a>) – Security context</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.get_max_retries">
<code class="sig-name descname"><span class="pre">get_max_retries</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.get_max_retries" title="Permalink to this definition"></a></dt>
<dd><p>Get the max number of retries</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Number of retries</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.get_security_context">
<code class="sig-name descname"><span class="pre">get_security_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">on_error</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.get_security_context" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve the stored security context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Security context or None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.set_security_context">
<code class="sig-name descname"><span class="pre">set_security_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">security_context</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.set_security_context" title="Permalink to this definition"></a></dt>
<dd><p>Set security context</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>security_context</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a>) – Security context</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.should_retry">
<code class="sig-name descname"><span class="pre">should_retry</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error_value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.LegacySecurityContextFilter.should_retry" title="Permalink to this definition"></a></dt>
<dd><p>Returns whether the request should be retried or not based on the error.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Returns True if request should be retried based on the error
value provided else False</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">vmware.vapi.security.client.security_context_filter.</span></code><code class="sig-name descname"><span class="pre">SecurityContextFilter</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">next_provider</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="#vmware.vapi.security.client.security_context_filter.SecurityContextFilter" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.provider.filter.ApiProviderFilter</span></code></p>
<p>SecurityContextFilter in API Provider chain adds the security
context to the execution context passed in.</p>
<p>Initialize SecurityContextFilter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>next_provider</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiProvider" title="vmware.vapi.core.ApiProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ApiProvider</span></code></a>) – API Provider to invoke the requests</p>
</dd>
</dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter.get_max_retries">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_max_retries</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.SecurityContextFilter.get_max_retries" title="Permalink to this definition"></a></dt>
<dd><p>Get the max number of retries</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Number of retries</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter.get_security_context">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_security_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">on_error</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.SecurityContextFilter.get_security_context" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve security context. If this method is called after an error
occured and the request needs to be retried, then a new security context
may be created depending on the scheme.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.SecurityContext" title="vmware.vapi.core.SecurityContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Security context</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter.invoke">
<code class="sig-name descname"><span class="pre">invoke</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.SecurityContextFilter.invoke" title="Permalink to this definition"></a></dt>
<dd><p>Invoke an API request</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service identifier</p></li>
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Operation identifier</p></li>
<li><p><strong>input_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.StructValue</span></code>) – Method input parameters</p></li>
<li><p><strong>ctx</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.ExecutionContext</span></code></a>) – Execution context for this method</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.MethodResult" title="vmware.vapi.core.MethodResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.MethodResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Result of the method invocation</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="vmware.vapi.security.client.security_context_filter.SecurityContextFilter.should_retry">
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">should_retry</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error_value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.security.client.security_context_filter.SecurityContextFilter.should_retry" title="Permalink to this definition"></a></dt>
<dd><p>Returns whether the request should be retried or not based on the error.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Returns True if request should be retried based on the error
value provided else False</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="vmware.vapi.vsphere.html" class="btn btn-neutral float-right" title="vmware.vapi.vsphere package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="vmware.vapi.security.html" class="btn btn-neutral float-left" title="vmware.vapi.security 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 2022, 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>
View Git Blame Copy Permalink