mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
618 lines
36 KiB
HTML
618 lines
36 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>com.vmware.vapi package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.vapi.metadata package" href="com.vmware.vapi.metadata.html" />
|
||
<link rel="prev" title="com.vmware.content.type.ovf package" href="com.vmware.content.type.ovf.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">
|
||
6.9.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 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li>com.vmware.vapi package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.vapi.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.vapi">
|
||
<span id="com-vmware-vapi-package"></span><h1>com.vmware.vapi package<a class="headerlink" href="#module-com.vmware.vapi" 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.vapi.metadata.html">com.vmware.vapi.metadata package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html">com.vmware.vapi.metadata.authentication package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html">com.vmware.vapi.metadata.metamodel package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html">com.vmware.vapi.metadata.privilege package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.authentication_client">com.vmware.vapi.metadata.authentication_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.cli_client">com.vmware.vapi.metadata.cli_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client">com.vmware.vapi.metadata.metamodel_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.interposition_client">com.vmware.vapi.std.interposition_client module</a></li>
|
||
</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.vapi.metadata_client">
|
||
<span id="com-vmware-vapi-metadata-client-module"></span><h2>com.vmware.vapi.metadata_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <a class="reference internal" href="#module-com.vmware.vapi.metadata_client" title="com.vmware.vapi.metadata_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata_client</span></code></a> module provides metadata classes.
|
||
These are classes that provide different facets of API information. Clients can
|
||
use these classes to:</p>
|
||
<ul class="simple">
|
||
<li><p>Discover APIs available in the infrastructure.</p></li>
|
||
<li><p>Fetch metadata that can be used to build presentation layers like CLI, REST,
|
||
etc.</p></li>
|
||
<li><p>Fetch authentication and authorization metadata.</p></li>
|
||
</ul>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata_client.SourceCreateSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">SourceCreateSpec</code><span class="sig-paren">(</span><em class="sig-param">description=None</em>, <em class="sig-param">type=None</em>, <em class="sig-param">filepath=None</em>, <em class="sig-param">address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceCreateSpec" 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">SourceCreateSpec</span></code> class contains the registration information for a
|
||
metadata source.</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>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language human readable description of the source.</p></li>
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source.</p></li>
|
||
<li><p><strong>filepath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute file path of the metamodel metadata file that has the
|
||
metamodel information about one component element.
|
||
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.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
|
||
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Connection information of the remote server. This should be of the
|
||
format http(s)://IP:port/namespace.</p>
|
||
<p>The remote server should contain the classes in
|
||
<a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client" title="com.vmware.vapi.metadata.metamodel_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client</span></code></a> module. It could
|
||
expose metamodel information of one or more components.
|
||
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.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata_client.SourceInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">SourceInfo</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">file_name=None</em>, <em class="sig-param">remote_addr=None</em>, <em class="sig-param">msg_protocol=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceInfo" 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>Metadata source info</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.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source</p></li>
|
||
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the metadata source file
|
||
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.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
|
||
<li><p><strong>remote_addr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Address of the remote metadata source
|
||
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.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
|
||
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used
|
||
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.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata_client.SourceType">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">SourceType</code><span class="sig-paren">(</span><em class="sig-param">string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType" 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">SourceType</span></code> class defines the types of sources for API metadata. You
|
||
specify the type of source when adding a metadata source to a metadata
|
||
service.</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 <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata_client.SourceType.FILE">
|
||
<code class="sig-name descname">FILE</code><em class="property"> = SourceType(string='FILE')</em><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the metadata source is a JSON file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata_client.SourceType.REMOTE">
|
||
<code class="sig-name descname">REMOTE</code><em class="property"> = SourceType(string='REMOTE')</em><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the metadata source is a remote server.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.metadata_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_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.vapi.std_client">
|
||
<span id="com-vmware-vapi-std-client-module"></span><h2>com.vmware.vapi.std_client module<a class="headerlink" href="#module-com.vmware.vapi.std_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client</span></code> module provides standard types that can be
|
||
used in the interface specification of any class.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">AuthenticationScheme</code><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme" 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 <a class="reference internal" href="#com.vmware.vapi.std_client.AuthenticationScheme" title="com.vmware.vapi.std_client.AuthenticationScheme"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationScheme</span></code></a> class defines constants for
|
||
authentication scheme identifiers for authentication mechanisms present in
|
||
the vAPI infrastructure shipped by VMware.</p>
|
||
<p>A third party extension can define and implements it’s own authentication
|
||
mechanism and define a constant in a different IDL file.</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="attribute">
|
||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION">
|
||
<code class="sig-name descname">NO_AUTHENTICATION</code><em class="property"> = 'com.vmware.vapi.std.security.no_authentication'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the request doesn’t need any authentication.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN">
|
||
<code class="sig-name descname">OAUTH_ACCESS_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.oauth'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the security context in a request is using OAuth2 based
|
||
authentication scheme.</p>
|
||
<p>In this scheme, the following pieces of information has to be passed in the
|
||
SecurityContext structure in the execution context of the request:</p>
|
||
<ul class="simple">
|
||
<li><p>The scheme identifier - com.vmware.vapi.std.security.oauth</p></li>
|
||
<li><p>Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization
|
||
Server after successful authentication of the end user.</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id1"><span class="problematic" id="id2">``</span></a>{</p>
|
||
</div></blockquote>
|
||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.oauth’,
|
||
‘accesstoken’: ….
|
||
}``
|
||
vAPI runtime provides convenient factory methods that takes OAuth2 access token
|
||
as input parameter and creates a security context that conforms to the above
|
||
format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN">
|
||
<code class="sig-name descname">SAML_BEARER_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.saml_bearer_token'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the security context in a request is using a SAML bearer token
|
||
based authentication scheme.</p>
|
||
<p>In this scheme, the following pieces of information has to be passed in the
|
||
SecurityContext structure in the execution context of the request:</p>
|
||
<ul class="simple">
|
||
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token</p></li>
|
||
<li><p>The token itself</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id3"><span class="problematic" id="id4">``</span></a>{</p>
|
||
</div></blockquote>
|
||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.saml_bearer_token’,
|
||
‘token’: ‘the token itself’
|
||
}`` vAPI runtime provide convenient factory methods that take SAML bearer token
|
||
and to create the security context that conforms to the above mentioned format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN">
|
||
<code class="sig-name descname">SAML_HOK_TOKEN</code><em class="property"> = 'com.vmware.vapi.std.security.saml_hok_token'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the security context in a request is using a SAML holder-of-key
|
||
token based authentication scheme.</p>
|
||
<p>In this scheme, the following pieces of information has to be passed in the
|
||
SecurityContext structure in the execution context of the request:</p>
|
||
<ul class="simple">
|
||
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_hok_token</p></li>
|
||
<li><p>Signature of the request: This includes - algorithm used for signing the
|
||
request, SAML holder of key token and signature digest</p></li>
|
||
<li><p>Request timestamp: This includes the <code class="docutils literal notranslate"><span class="pre">created</span></code> and <code class="docutils literal notranslate"><span class="pre">expires</span></code> timestamp of
|
||
the request. The timestamp should match the following format -
|
||
YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id5"><span class="problematic" id="id6">``</span></a>{</p>
|
||
</div></blockquote>
|
||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.saml_hok_token’,
|
||
‘signature’: {
|
||
‘alg’: ‘RS256’,
|
||
‘samlToken’: …,
|
||
‘value’: …,``, ‘timestamp’: { ‘created’: ‘2012-10-26T12:24:18.941Z’,
|
||
‘expires’: ‘2012-10-26T12:44:18.941Z’, } } } vAPI runtime provide convenient
|
||
factory methods that take SAML holder of key token and private key to create
|
||
the security context that conforms to the above mentioned format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID">
|
||
<code class="sig-name descname">SESSION_ID</code><em class="property"> = 'com.vmware.vapi.std.security.session_id'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the security context in a request is using a session identifier
|
||
based authentication scheme.</p>
|
||
<p>In this scheme, the following pieces of information has to be passed in the
|
||
SecurityContext structure in the execution context of the request:</p>
|
||
<ul class="simple">
|
||
<li><p>The scheme identifier - com.vmware.vapi.std.security.session_id</p></li>
|
||
<li><p>Valid session identifier - This is usually returned by a login method of a
|
||
session manager interface for a particular vAPI service of this authentication
|
||
scheme</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id7"><span class="problematic" id="id8">``</span></a>{</p>
|
||
</div></blockquote>
|
||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.session_id’,
|
||
‘sessionId’: ….,
|
||
}`` vAPI runtime provides convenient factory methods that take session
|
||
identifier as input parameter and create a security context that conforms to
|
||
the above format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD">
|
||
<code class="sig-name descname">USER_PASSWORD</code><em class="property"> = 'com.vmware.vapi.std.security.user_pass'</em><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the security context in a request is using username/password
|
||
based authentication scheme.</p>
|
||
<p>In this scheme, the following pieces of information has to be passed in the
|
||
SecurityContext structure in the execution context of the request:</p>
|
||
<ul class="simple">
|
||
<li><p>The scheme identifier - com.vmware.vapi.std.security.user_pass</p></li>
|
||
<li><p>Username</p></li>
|
||
<li><p>Password</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>Sample security context in JSON format that matches the specification: <a href="#id9"><span class="problematic" id="id10">``</span></a>{</p>
|
||
</div></blockquote>
|
||
<p>‘schemeId’: ‘com.vmware.vapi.std.security.user_pass’,
|
||
‘userName’: ….,
|
||
‘password’: …
|
||
}``
|
||
vAPI runtime provides convenient factory methods that take username and
|
||
password as input parameters and create a security context that conforms to the
|
||
above format.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.std_client.DynamicID">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">DynamicID</code><span class="sig-paren">(</span><em class="sig-param">type=None</em>, <em class="sig-param">id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.DynamicID" 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">DynamicID</span></code> class represents an identifier for a resource of an
|
||
arbitrary type.</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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The type of resource being identified (for example
|
||
<code class="docutils literal notranslate"><span class="pre">com.acme.Person</span></code>).</p>
|
||
<p>Classes that contain methods for creating and deleting resources
|
||
typically contain a class attribute specifying the resource type
|
||
for the resources being created and deleted. The API metamodel
|
||
metadata classes include a class that allows retrieving all the
|
||
known resource types.</p>
|
||
</p></li>
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier for a resource whose type is specified by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DynamicID.type</span></code>.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> must contain the actual resource type. When
|
||
methods return a value of this class as a return value, the
|
||
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> will contain the actual resource type.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.std_client.LocalizableMessage">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">LocalizableMessage</code><span class="sig-paren">(</span><em class="sig-param">id=None</em>, <em class="sig-param">default_message=None</em>, <em class="sig-param">args=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizableMessage" 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">LocalizableMessage</span></code> class represents localizable string and message
|
||
template. Classes include one or more localizable message templates in the
|
||
exceptions they report so that clients can display diagnostic messages in
|
||
the native language of the user. Classes can include localizable strings in
|
||
the data returned from methods to allow clients to display localized status
|
||
information in the native language of the user.</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Unique identifier of the localizable string or message template.</p>
|
||
<p>This identifier is typically used to retrieve a locale-specific
|
||
string or message template from a message catalog.</p>
|
||
</p></li>
|
||
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of this localizable string or message template in the
|
||
<code class="docutils literal notranslate"><span class="pre">en_US</span></code> (English) locale. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">LocalizableMessage.id</span></code> refers
|
||
to a message template, the default message will contain the
|
||
substituted arguments. This value can be used by clients that do
|
||
not need to display strings and messages in the native language of
|
||
the user. It could also be used as a fallback if a client is unable
|
||
to access the appropriate message catalog.</p></li>
|
||
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Positional arguments to be substituted into the message template.
|
||
This list will be empty if the message uses named arguments or has
|
||
no arguments.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.std_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vapi.std_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_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>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="com.vmware.vapi.metadata.html" class="btn btn-neutral float-right" title="com.vmware.vapi.metadata package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.content.type.ovf.html" class="btn btn-neutral float-left" title="com.vmware.content.type.ovf package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |