mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-26 19:29:58 -05:00
271 lines
15 KiB
HTML
271 lines
15 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>vmware.vapi.lib package — vSphere Automation SDK for Python 6.6.1 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: './',
|
||
|
|
VERSION: '6.6.1',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</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>
|
||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="vmware.vapi package" href="vmware.vapi.html" />
|
||
|
|
<link rel="next" title="vmware.vapi.security package" href="vmware.vapi.security.html" />
|
||
|
|
<link rel="prev" title="vmware.vapi package" href="vmware.vapi.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.security.html" title="vmware.vapi.security package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.html" title="vmware.vapi package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="vmware.html" >vmware package</a> »</li>
|
||
|
|
<li><a href="vmware.vapi.html" accesskey="U">vmware.vapi package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="vmware-vapi-lib-package">
|
||
|
|
<h1>vmware.vapi.lib package<a class="headerlink" href="#vmware-vapi-lib-package" 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 class="simple">
|
||
|
|
</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-vmware.vapi.lib.connect">
|
||
|
|
<span id="vmware-vapi-lib-connect-module"></span><h2>vmware.vapi.lib.connect module<a class="headerlink" href="#module-vmware.vapi.lib.connect" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>vAPI Connection factory</p>
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.lib.connect.check_file_exists">
|
||
|
|
<tt class="descclassname">vmware.vapi.lib.connect.</tt><tt class="descname">check_file_exists</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#vmware.vapi.lib.connect.check_file_exists" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Check if name is a file and exists</p>
|
||
|
|
<p>:type <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>
|
||
|
|
:param file name</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.lib.connect.get_connector">
|
||
|
|
<tt class="descclassname">vmware.vapi.lib.connect.</tt><tt class="descname">get_connector</tt><big>(</big><em>rpc_provider_name</em>, <em>msg_protocol</em>, <em>ssl_context=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#vmware.vapi.lib.connect.get_connector" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a connection to the vAPI Provider using the specified arguments</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>rpc_provider_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The RPC provider to be used for the connection.
|
||
|
|
Valid values are ‘http’, ‘https’ and ‘requests’</li>
|
||
|
|
<li><strong>msg_protocol</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The message protocol to be used for the connection.
|
||
|
|
Valid values are ‘json’.</li>
|
||
|
|
<li><strong>ssl_context</strong> (<tt class="xref py py-class docutils literal"><span class="pre">OpenSSL.SSL.Context</span></tt>) – SSL context to use for SSL connections</li>
|
||
|
|
<li><strong>kwargs</strong> – Additional arguments for the RPC provider</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.lib.connect.get_requests_connector">
|
||
|
|
<tt class="descclassname">vmware.vapi.lib.connect.</tt><tt class="descname">get_requests_connector</tt><big>(</big><em>session</em>, <em>msg_protocol='json'</em>, <em>url=None</em>, <em>timeout=None</em>, <em>pool_size=8</em><big>)</big><a class="headerlink" href="#vmware.vapi.lib.connect.get_requests_connector" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a connection that uses ‘requests’ library for http(s) connections to
|
||
|
|
a vAPI Provider.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>session</strong> (<tt class="xref py py-class docutils literal"><span class="pre">requests.Session</span></tt>) – Session object</li>
|
||
|
|
<li><strong>msg_protocol</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Message protocol to be used for the connection. Valid
|
||
|
|
values are ‘json’.</li>
|
||
|
|
<li><strong>url</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – HTTP(S) URL to be used</li>
|
||
|
|
<li><strong>timeout</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Request timeout</li>
|
||
|
|
<li><strong>pool_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Connection pool size to be used</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.lib.connect.get_requests_hok_connector">
|
||
|
|
<tt class="descclassname">vmware.vapi.lib.connect.</tt><tt class="descname">get_requests_hok_connector</tt><big>(</big><em>session</em>, <em>msg_protocol='json'</em>, <em>url=None</em>, <em>timeout=None</em>, <em>pool_size=8</em><big>)</big><a class="headerlink" href="#vmware.vapi.lib.connect.get_requests_hok_connector" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a connection that uses SAML Hok based authentication using ‘requests’
|
||
|
|
library to connect to a vAPI Provider.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>session</strong> (<tt class="xref py py-class docutils literal"><span class="pre">requests.Session</span></tt>) – Session object</li>
|
||
|
|
<li><strong>msg_protocol</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Message protocol to be used for the connection. Valid
|
||
|
|
values are ‘json’.</li>
|
||
|
|
<li><strong>url</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – HTTP(S) URL to be used</li>
|
||
|
|
<li><strong>timeout</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Request timeout</li>
|
||
|
|
<li><strong>pool_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Connection pool size to be used</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.lib.connect.get_saml_hok_connector">
|
||
|
|
<tt class="descclassname">vmware.vapi.lib.connect.</tt><tt class="descname">get_saml_hok_connector</tt><big>(</big><em>rpc_provider_name</em>, <em>msg_protocol='json'</em>, <em>ssl_context=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#vmware.vapi.lib.connect.get_saml_hok_connector" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a connection that uses SAML Hok based authentication
|
||
|
|
to connect to a vAPI Provider</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>rpc_provider_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The RPC provider to be used for the connection.
|
||
|
|
Valid values are ‘http’, ‘https’ or ‘requests’</li>
|
||
|
|
<li><strong>msg_protocol</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The message protocol to be used for the connection.
|
||
|
|
Valid values are ‘json’.</li>
|
||
|
|
<li><strong>ssl_context</strong> (<tt class="xref py py-class docutils literal"><span class="pre">OpenSSL.SSL.Context</span></tt>) – SSL context to use for SSL connections</li>
|
||
|
|
<li><strong>kwargs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt>) – Additional arguments for the RPC provider</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Connection to the vAPI provider</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.lib">
|
||
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-vmware.vapi.lib" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">vmware.vapi.lib package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||
|
|
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.lib.connect">vmware.vapi.lib.connect module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.lib">Module contents</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="vmware.vapi.html"
|
||
|
|
title="previous chapter">vmware.vapi package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="vmware.vapi.security.html"
|
||
|
|
title="next chapter">vmware.vapi.security package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/vmware.vapi.lib.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.security.html" title="vmware.vapi.security package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.html" title="vmware.vapi package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> »</li>
|
||
|
|
<li><a href="vmware.html" >vmware package</a> »</li>
|
||
|
|
<li><a href="vmware.vapi.html" >vmware.vapi package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014-2017, VMware, Inc. All rights reserved.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|