mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 20:09:58 -05:00
297 lines
12 KiB
HTML
297 lines
12 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>vmware.vapi.vsphere package — vSphere Automation SDK for Python. 6.8.7 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="prev" title="vmware.vapi.security.client package" href="vmware.vapi.security.client.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.8.7
|
|||
|
|
</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">Docs</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="vmware.html">vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="vmware.vapi.html">vmware.vapi package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>vmware.vapi.vsphere package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/vmware.vapi.vsphere.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.vsphere">
|
|||
|
|
<span id="vmware-vapi-vsphere-package"></span><h1>vmware.vapi.vsphere package<a class="headerlink" href="#module-vmware.vapi.vsphere" 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.vsphere.client">
|
|||
|
|
<span id="vmware-vapi-vsphere-client-module"></span><h2>vmware.vapi.vsphere.client module<a class="headerlink" href="#module-vmware.vapi.vsphere.client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>vSphere Client</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="vmware.vapi.vsphere.client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">vmware.vapi.vsphere.client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vsphere.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>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="vmware.vapi.vsphere.client.VsphereClient">
|
|||
|
|
<em class="property">class </em><code class="descclassname">vmware.vapi.vsphere.client.</code><code class="descname">VsphereClient</code><span class="sig-paren">(</span><em>session</em>, <em>server</em>, <em>username</em>, <em>password</em>, <em>bearer_token</em>, <em>hok_token</em>, <em>private_key</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vsphere.client.VsphereClient" 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.ApiClient</span></code></p>
|
|||
|
|
<p>vSphere Client class that provides access to stubs for all services in the
|
|||
|
|
vSphere API</p>
|
|||
|
|
<p>Initialize VsphereClient by creating a parent stub factory instance
|
|||
|
|
of all vSphere components.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests HTTP session instance. If not specified,</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<p>then one is automatically created and used
|
|||
|
|
:type server: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
|||
|
|
:param server: vCenter host name or IP address
|
|||
|
|
:type username: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
|||
|
|
:param username: Name of the user
|
|||
|
|
:type password: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
|||
|
|
:param password: Password of the user
|
|||
|
|
:type bearer_token: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
|||
|
|
:param bearer_token: SAML Bearer Token
|
|||
|
|
:type hok_token: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
|||
|
|
:param hok_token: SAML Hok Token
|
|||
|
|
:type private_key: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
|
|||
|
|
:param private_key: Absolute file path of the private key of the user</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="vmware.vapi.vsphere.client.create_vsphere_client">
|
|||
|
|
<code class="descclassname">vmware.vapi.vsphere.client.</code><code class="descname">create_vsphere_client</code><span class="sig-paren">(</span><em>server</em>, <em>username=None</em>, <em>password=None</em>, <em>bearer_token=None</em>, <em>hok_token=None</em>, <em>private_key=None</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vsphere.client.create_vsphere_client" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Helper method to create an instance of the vSphere API client.
|
|||
|
|
Please provide one of the following options to authenticate:</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div><ul class="simple">
|
|||
|
|
<li><p>username and password,</p></li>
|
|||
|
|
<li><p>bearer_token,</p></li>
|
|||
|
|
<li><p>hok_token and private_key</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></blockquote>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>server</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – vCenter host name or IP address</p></li>
|
|||
|
|
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the user</p></li>
|
|||
|
|
<li><p><strong>password</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Password of the user</p></li>
|
|||
|
|
<li><p><strong>bearer_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Bearer Token</p></li>
|
|||
|
|
<li><p><strong>hok_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – SAML Hok Token</p></li>
|
|||
|
|
<li><p><strong>private_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Absolute file path of the private key of the user</p></li>
|
|||
|
|
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Requests HTTP session instance. If not specified, then one
|
|||
|
|
is automatically created and used</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</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">vmware.vapi.vmc.client.VsphereClient</span></code></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Vsphere Client instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="vmware.vapi.security.client.html" class="btn btn-neutral float-left" title="vmware.vapi.security.client 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>
|