1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00

Upgrade NSX SDKs to VMC 1.11 release

Signed-Off-By: Gordon Good <ggood@vmware.com>
This commit is contained in:
Gordon Good 2020-06-05 15:48:31 -07:00
parent 49cbaa5a2a
commit 623e002985
361 changed files with 25825 additions and 41772 deletions

View File

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 36467192cd5c5a246c3933df30d6b561
config: d6baa172800c1b1db8503d138969777d
tags: 645f666f9bcd5a90fca523b33c5a78b7

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -10,5 +10,6 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.app_discovery.sessions

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.cluster.nodes.network

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.cluster.nodes

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.dhcp.servers

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.directory.domains

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.fabric.nodes.network

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.fabric.compute_collections
com.vmware.nsx.fabric.nodes

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.firewall.sections

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.idfw.compute_collections
com.vmware.nsx.idfw.transport_nodes

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.intelligence.nodes

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.loadbalancer.services

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.logical_routers.routing.bgp

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.logical_routers.nat
com.vmware.nsx.logical_routers.routing

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.node.aaa.providers

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.node.aaa
com.vmware.nsx.node.network

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.pbr.sections

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.aaa
com.vmware.nsx.app_discovery

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.serviceinsertion.services

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.serviceinsertion.services.service_instances

View File

@ -10,5 +10,6 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.transport_nodes.network

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx.vpn.ipsec
com.vmware.nsx.vpn.l2vpn

View File

@ -10,6 +10,7 @@ Subpackages
-----------
.. toctree::
:maxdepth: 10
com.vmware.nsx

View File

@ -1,5 +1,5 @@
.. NSX-T SDK documentation master file, created by
sphinx-quickstart on Mon Jan 6 16:59:30 2020.
sphinx-quickstart on Thu May 14 22:42:56 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

View File

@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

View File

@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -283,10 +283,11 @@ var Documentation = {
},
initOnKeyListeners: function() {
$(document).keyup(function(event) {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');

View File

@ -1,10 +1,11 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '2.5.1.0.1',
VERSION: '2.5.1.0.5',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false

View File

@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

View File

@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@ -63,6 +63,11 @@ var Search = {
htmlElement.innerHTML = htmlString;
$(htmlElement).find('.headerlink').remove();
docContent = $(htmlElement).find('[role=main]')[0];
if(docContent === undefined) {
console.warn("Content block not found. Sphinx search tries to obtain it " +
"via '[role=main]'. Could you check your theme or template.");
return "";
}
return docContent.textContent || docContent.innerText;
},
@ -245,6 +250,8 @@ var Search = {
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
var requestUrl = "";
var linkUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
// dirhtml builder
var dirname = item[0] + '/';
@ -253,15 +260,17 @@ var Search = {
} else if (dirname == 'index/') {
dirname = '';
}
listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
}
listItem.append($('<a/>').attr('href',
linkUrl +
highlightstring + item[2]).html(item[1]));
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
@ -269,7 +278,7 @@ var Search = {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
$.ajax({url: requestUrl,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -468,14 +468,7 @@
<li class="toctree-l7"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.html">com.vmware.nsx.serviceinsertion.services package</a><ul>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.html#subpackages">Subpackages</a><ul>
<li class="toctree-l9"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.service_instances.html">com.vmware.nsx.serviceinsertion.services.service_instances package</a><ul>
<li class="toctree-l10"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.service_instances.html#subpackages">Subpackages</a><ul>
<li class="toctree-l11"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package</a><ul>
<li class="toctree-l12"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html#submodules">Submodules</a></li>
<li class="toctree-l12"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html#module-com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l10"><a class="reference internal" href="com.vmware.nsx.serviceinsertion.services.service_instances.html#subpackages">Subpackages</a></li>
</ul>
</li>
</ul>
@ -606,7 +599,7 @@
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>

File diff suppressed because it is too large Load Diff

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.aaa package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.aaa package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -176,18 +176,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.aaa.vidm_client">
<span id="com-vmware-nsx-aaa-vidm-client-module"></span><h2>com.vmware.nsx.aaa.vidm_client module<a class="headerlink" href="#module-com.vmware.nsx.aaa.vidm_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.aaa.vidm_client.Groups">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="sig-name descname">Groups</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Groups" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="sig-name descname">Groups</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Groups" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.aaa.vidm_client.Groups.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">search_string</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Groups.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">search_string</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Groups.list" title="Permalink to this definition"></a></dt>
<dd><p>Get all the User Groups where vIDM display name matches the search key
case insensitively. The search key is checked to be a substring of
display name. This is a non paginated API.</p>
@ -236,18 +236,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.aaa.vidm_client.Search">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="sig-name descname">Search</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Search" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="sig-name descname">Search</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Search" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.aaa.vidm_client.Search.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">search_string</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Search.create" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">search_string</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Search.create" title="Permalink to this definition"></a></dt>
<dd><p>Get all the users and groups from vIDM matching the search key case
insensitively. The search key is checked to be a substring of name or
given name or family name of user and display name of group. This is a
@ -297,9 +297,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.aaa.vidm_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_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.nsx.aaa.vidm_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_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">
@ -309,18 +309,18 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.aaa.vidm_client.Users">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="sig-name descname">Users</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Users" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="sig-name descname">Users</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Users" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.aaa.vidm_client.Users.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">search_string</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Users.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">search_string</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.Users.list" title="Permalink to this definition"></a></dt>
<dd><p>Get all the users from vIDM whose userName, givenName or familyName
matches the search key case insensitively. The search key is checked to
be a substring of name or given name or family name. This is a non

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.app_discovery package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.app_discovery package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -188,18 +188,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.app_discovery.sessions_client">
<span id="com-vmware-nsx-app-discovery-sessions-client-module"></span><h2>com.vmware.nsx.app_discovery.sessions_client module<a class="headerlink" href="#module-com.vmware.nsx.app_discovery.sessions_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions_client.AppProfiles">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">AppProfiles</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.AppProfiles" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">AppProfiles</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.AppProfiles" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.app_discovery.sessions_client.AppProfiles.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">session_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.AppProfiles.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.AppProfiles.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the application profiles that was part of the application
discovery session | while it was started.</p>
<dl class="field-list simple">
@ -247,18 +247,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions_client.InstalledApps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">InstalledApps</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.InstalledApps" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">InstalledApps</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.InstalledApps" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.app_discovery.sessions_client.InstalledApps.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">session_id</em>, <em class="sig-param">app_profile_id=None</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em>, <em class="sig-param">vm_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.InstalledApps.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session_id</span></em>, <em class="sig-param"><span class="n">app_profile_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vm_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.InstalledApps.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the details of the installed apps for the app profile ID in
that session</p>
<dl class="field-list simple">
@ -308,18 +308,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions_client.NsGroups">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">NsGroups</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.NsGroups" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">NsGroups</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.NsGroups" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.app_discovery.sessions_client.NsGroups.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">session_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.NsGroups.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.NsGroups.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the ns groups that was part of the application discovery
session | while it was started</p>
<dl class="field-list simple">
@ -367,18 +367,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions_client.ReClassify">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">ReClassify</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.ReClassify" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">ReClassify</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.ReClassify" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.app_discovery.sessions_client.ReClassify.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">session_id</em>, <em class="sig-param">session_reclassification_parameter</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.ReClassify.create" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session_id</span></em>, <em class="sig-param"><span class="n">session_reclassification_parameter</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.ReClassify.create" title="Permalink to this definition"></a></dt>
<dd><p>Re-classify completed application discovery session against input
AppProfiles. If no AppProfiles are specified then we use the previous
AppProfiles of that session.</p>
@ -420,9 +420,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_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.nsx.app_discovery.sessions_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_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">
@ -432,18 +432,18 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions_client.Summary">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.Summary" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.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.stub.VapiInterface</span></code></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="method">
<dl class="py method">
<dt id="com.vmware.nsx.app_discovery.sessions_client.Summary.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.Summary.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.Summary.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the summary of the application discovery session</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.app_discovery.sessions package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.app_discovery.sessions package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -178,18 +178,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.app_discovery.sessions.ns_groups_client">
<span id="com-vmware-nsx-app-discovery-sessions-ns-groups-client-module"></span><h2>com.vmware.nsx.app_discovery.sessions.ns_groups_client module<a class="headerlink" href="#module-com.vmware.nsx.app_discovery.sessions.ns_groups_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_client.</code><code class="sig-name descname">Members</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_client.</code><code class="sig-name descname">Members</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">session_id</em>, <em class="sig-param">ns_group_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session_id</span></em>, <em class="sig-param"><span class="n">ns_group_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the vms in the ns-group of the application discovery session</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -237,9 +237,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.app_discovery.sessions.ns_groups_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_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.nsx.app_discovery.sessions.ns_groups_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions.ns_groups_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">

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.cluster package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.cluster package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -198,16 +198,16 @@
</div>
<div class="section" id="module-com.vmware.nsx.cluster.backups_client">
<span id="com-vmware-nsx-cluster-backups-client-module"></span><h2>com.vmware.nsx.cluster.backups_client module<a class="headerlink" href="#module-com.vmware.nsx.cluster.backups_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.backups_client.Config">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Config" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Config" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.backups_client.Config.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Config.get" title="Permalink to this definition"></a></dt>
<dd><p>Get a configuration of a file server and timers for automated backup.
@ -242,9 +242,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.backups_client.Config.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">backup_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Config.update" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">backup_configuration</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Config.update" title="Permalink to this definition"></a></dt>
<dd><p>Configure file server and timers for automated backup. If secret fields
are omitted (password, passphrase) then use the previously set value.</p>
<dl class="field-list simple">
@ -282,16 +282,16 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.backups_client.History">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_client.</code><code class="sig-name descname">History</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.History" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_client.</code><code class="sig-name descname">History</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.History" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.backups_client.History.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.History.get" title="Permalink to this definition"></a></dt>
<dd><p>Get history of previous backup operations</p>
@ -327,16 +327,16 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.backups_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Status" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Status" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.backups_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Get status of active backup operations</p>
@ -372,9 +372,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.backups_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_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.nsx.cluster.backups_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.backups_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.backups_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">
@ -387,18 +387,18 @@ Not Found</p>
</div>
<div class="section" id="module-com.vmware.nsx.cluster.nodes_client">
<span id="com-vmware-nsx-cluster-nodes-client-module"></span><h2>com.vmware.nsx.cluster.nodes_client module<a class="headerlink" href="#module-com.vmware.nsx.cluster.nodes_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes_client.Deployments">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes_client.</code><code class="sig-name descname">Deployments</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes_client.</code><code class="sig-name descname">Deployments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes_client.Deployments.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">add_cluster_node_vm_info</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments.create" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">add_cluster_node_vm_info</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments.create" title="Permalink to this definition"></a></dt>
<dd><p>Deploys a cluster node VM as specified by the deployment config. Once
the VM is deployed and powered on, it will automatically join the
existing cluster.</p>
@ -435,9 +435,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes_client.Deployments.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">node_id</em>, <em class="sig-param">force_delete=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments.delete" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em>, <em class="sig-param"><span class="n">force_delete</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments.delete" title="Permalink to this definition"></a></dt>
<dd><p>Attempts to unregister and undeploy a specified auto-deployed cluster
node VM. If it is a member of a cluster, then the VM will be
automatically detached from the cluster before being unregistered and
@ -476,9 +476,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes_client.Deployments.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns deployment request information for a specific attempted
deployment of a cluster node VM.</p>
<dl class="field-list simple">
@ -514,7 +514,7 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes_client.Deployments.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Deployments.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns request information for every attempted deployment of a cluster
@ -551,30 +551,30 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Status" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Status" 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>
<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="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes_client.Status.GET_SOURCE_CACHED">
<code class="sig-name descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes_client.Status.get" title="com.vmware.nsx.cluster.nodes_client.Status.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Status.get()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes_client.Status.GET_SOURCE_REALTIME">
<code class="sig-name descname">GET_SOURCE_REALTIME</code><em class="property"> = 'realtime'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Status.GET_SOURCE_REALTIME" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes_client.Status.get" title="com.vmware.nsx.cluster.nodes_client.Status.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Status.get()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">node_id</em>, <em class="sig-param">source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Status.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Read aggregated runtime status of cluster node.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -612,7 +612,7 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes_client.Status.getall">
<code class="sig-name descname">getall</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_client.Status.getall" title="Permalink to this definition"></a></dt>
<dd><p>Read aggregated runtime status of all cluster nodes. Deprecated. Use
@ -649,9 +649,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes_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.nsx.cluster.nodes_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes_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">
@ -664,18 +664,18 @@ Not Found</p>
</div>
<div class="section" id="module-com.vmware.nsx.cluster.restore_client">
<span id="com-vmware-nsx-cluster-restore-client-module"></span><h2>com.vmware.nsx.cluster.restore_client module<a class="headerlink" href="#module-com.vmware.nsx.cluster.restore_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.restore_client.Backuptimestamps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">Backuptimestamps</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Backuptimestamps" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">Backuptimestamps</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Backuptimestamps" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.restore_client.Backuptimestamps.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Backuptimestamps.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Backuptimestamps.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns timestamps for all backup files that are available on the SFTP
server.</p>
<dl class="field-list simple">
@ -722,16 +722,16 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.restore_client.Config">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Config" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Config" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.restore_client.Config.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Config.get" title="Permalink to this definition"></a></dt>
<dd><p>Get configuration information for the file server used to store
@ -767,9 +767,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.restore_client.Config.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">restore_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Config.update" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">restore_configuration</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Config.update" title="Permalink to this definition"></a></dt>
<dd><p>Configure file server where the backed-up files used for the Restore
operation are available.</p>
<dl class="field-list simple">
@ -807,18 +807,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.restore_client.InstructionResources">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">InstructionResources</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.InstructionResources" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">InstructionResources</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.InstructionResources" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.restore_client.InstructionResources.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">instruction_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.InstructionResources.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">instruction_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.InstructionResources.get" title="Permalink to this definition"></a></dt>
<dd><p>For restore operations requiring user input e.g. performing an action,
accepting/rejecting an action, etc. the information to be conveyed to
users is provided in this call.</p>
@ -868,16 +868,16 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.restore_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Status" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Status" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.restore_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns status information for the specified NSX cluster restore
@ -914,9 +914,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.restore_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_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.nsx.cluster.restore_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.restore_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.restore_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">

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.cluster.nodes package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.cluster.nodes package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -190,18 +190,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.cluster.nodes.deployments_client">
<span id="com-vmware-nsx-cluster-nodes-deployments-client-module"></span><h2>com.vmware.nsx.cluster.nodes.deployments_client module<a class="headerlink" href="#module-com.vmware.nsx.cluster.nodes.deployments_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.deployments_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.deployments_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.deployments_client.Status" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.deployments_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.deployments_client.Status" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes.deployments_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.deployments_client.Status.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.deployments_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the current deployment or undeployment status for a VM along
with any other relevant current information, such as error messages.</p>
<dl class="field-list simple">
@ -239,9 +239,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.deployments_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.deployments_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.nsx.cluster.nodes.deployments_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.deployments_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.deployments_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">
@ -254,42 +254,42 @@ Not Found</p>
</div>
<div class="section" id="module-com.vmware.nsx.cluster.nodes.network_client">
<span id="com-vmware-nsx-cluster-nodes-network-client-module"></span><h2>com.vmware.nsx.cluster.nodes.network_client module<a class="headerlink" href="#module-com.vmware.nsx.cluster.nodes.network_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network_client.</code><code class="sig-name descname">Interfaces</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network_client.</code><code class="sig-name descname">Interfaces</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces" 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>
<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="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.GET_SOURCE_CACHED">
<code class="sig-name descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.GET_SOURCE_CACHED" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.get" title="com.vmware.nsx.cluster.nodes.network_client.Interfaces.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Interfaces.get()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.GET_SOURCE_REALTIME">
<code class="sig-name descname">GET_SOURCE_REALTIME</code><em class="property"> = 'realtime'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.GET_SOURCE_REALTIME" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.get" title="com.vmware.nsx.cluster.nodes.network_client.Interfaces.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Interfaces.get()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.LIST_SOURCE_CACHED">
<code class="sig-name descname">LIST_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.LIST_SOURCE_CACHED" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.list" title="com.vmware.nsx.cluster.nodes.network_client.Interfaces.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Interfaces.list()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.LIST_SOURCE_REALTIME">
<code class="sig-name descname">LIST_SOURCE_REALTIME</code><em class="property"> = 'realtime'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.LIST_SOURCE_REALTIME" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.list" title="com.vmware.nsx.cluster.nodes.network_client.Interfaces.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Interfaces.list()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">node_id</em>, <em class="sig-param">interface_id</em>, <em class="sig-param">source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em>, <em class="sig-param"><span class="n">interface_id</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns detailed information about the specified interface. Interface
information includes MTU, broadcast and host IP addresses, link and
admin status, MAC address, network mask, and the IP configuration
@ -331,9 +331,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">node_id</em>, <em class="sig-param">source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.Interfaces.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the number of interfaces on the node and detailed information
about each interface. Interface information includes MTU, broadcast and
host IP addresses, link and admin status, MAC address, network mask,
@ -376,9 +376,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.network_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network_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.nsx.cluster.nodes.network_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_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">
@ -391,18 +391,18 @@ Not Found</p>
</div>
<div class="section" id="module-com.vmware.nsx.cluster.nodes.repo_sync_client">
<span id="com-vmware-nsx-cluster-nodes-repo-sync-client-module"></span><h2>com.vmware.nsx.cluster.nodes.repo_sync_client module<a class="headerlink" href="#module-com.vmware.nsx.cluster.nodes.repo_sync_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.repo_sync_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.repo_sync_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.repo_sync_client.Status" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.repo_sync_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.repo_sync_client.Status" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes.repo_sync_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.repo_sync_client.Status.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.repo_sync_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p>
@ -438,9 +438,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.repo_sync_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.repo_sync_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.nsx.cluster.nodes.repo_sync_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.repo_sync_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.repo_sync_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">

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.cluster.nodes.network package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.cluster.nodes.network package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -180,30 +180,30 @@
</div>
<div class="section" id="module-com.vmware.nsx.cluster.nodes.network.interfaces_client">
<span id="com-vmware-nsx-cluster-nodes-network-interfaces-client-module"></span><h2>com.vmware.nsx.cluster.nodes.network.interfaces_client module<a class="headerlink" href="#module-com.vmware.nsx.cluster.nodes.network.interfaces_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_client.</code><code class="sig-name descname">Stats</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_client.</code><code class="sig-name descname">Stats</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats" 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>
<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="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED">
<code class="sig-name descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.get" title="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Stats.get()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.GET_SOURCE_REALTIME">
<code class="sig-name descname">GET_SOURCE_REALTIME</code><em class="property"> = 'realtime'</em><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.GET_SOURCE_REALTIME" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.get" title="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Stats.get()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">node_id</em>, <em class="sig-param">interface_id</em>, <em class="sig-param">source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">node_id</span></em>, <em class="sig-param"><span class="n">interface_id</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.get" title="Permalink to this definition"></a></dt>
<dd><p>On the specified interface, returns the number of received (rx),
transmitted (tx), and dropped packets; the number of bytes and errors
received and transmitted on the interface; and the number of detected
@ -247,9 +247,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_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.nsx.cluster.nodes.network.interfaces_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_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">

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.configs package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.configs package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -176,18 +176,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.configs.node_client">
<span id="com-vmware-nsx-configs-node-client-module"></span><h2>com.vmware.nsx.configs.node_client module<a class="headerlink" href="#module-com.vmware.nsx.configs.node_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.configs.node_client.Mode">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.configs.node_client.</code><code class="sig-name descname">Mode</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.configs.node_client.Mode" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.configs.node_client.</code><code class="sig-name descname">Mode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.configs.node_client.Mode" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.configs.node_client.Mode.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">switching_to_vmc_mode_parameters</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.configs.node_client.Mode.create" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">switching_to_vmc_mode_parameters</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.configs.node_client.Mode.create" title="Permalink to this definition"></a></dt>
<dd><p>Currently only a switch from “VMC_LOCAL” to “VMC” is supported.
Returns a new Node Mode, if the request successfuly changed it.</p>
<dl class="field-list simple">
@ -225,9 +225,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.configs.node_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.configs.node_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.nsx.configs.node_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.configs.node_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.configs.node_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">

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.dhcp package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.dhcp package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -189,18 +189,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.dhcp.servers_client">
<span id="com-vmware-nsx-dhcp-servers-client-module"></span><h2>com.vmware.nsx.dhcp.servers_client module<a class="headerlink" href="#module-com.vmware.nsx.dhcp.servers_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers_client.IpPools">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">IpPools</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">IpPools</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.IpPools.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">dhcp_ip_pool</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.create" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">dhcp_ip_pool</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.create" title="Permalink to this definition"></a></dt>
<dd><p>Create an ip pool for a local DHCP server</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -238,9 +238,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.IpPools.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">pool_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.delete" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">pool_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a specific ip pool of a given logical DHCP server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -272,9 +272,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.IpPools.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">pool_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">pool_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.get" title="Permalink to this definition"></a></dt>
<dd><p>Return a specific ip pool of a given logical DHCP server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -312,9 +312,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.IpPools.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.list" title="Permalink to this definition"></a></dt>
<dd><p>List the ip pools of a logical DHCP server with pagination support.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -359,9 +359,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.IpPools.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">pool_id</em>, <em class="sig-param">dhcp_ip_pool</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.update" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">pool_id</span></em>, <em class="sig-param"><span class="n">dhcp_ip_pool</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.IpPools.update" title="Permalink to this definition"></a></dt>
<dd><p>Update a specific ip pool of a given logical DHCP server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -402,30 +402,30 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers_client.Leases">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">Leases</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">Leases</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases" 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>
<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="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_CACHED">
<code class="sig-name descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_CACHED" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.dhcp.servers_client.Leases.get" title="com.vmware.nsx.dhcp.servers_client.Leases.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Leases.get()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_REALTIME">
<code class="sig-name descname">GET_SOURCE_REALTIME</code><em class="property"> = 'realtime'</em><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases.GET_SOURCE_REALTIME" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">source</span></code> of method <a class="reference internal" href="#com.vmware.nsx.dhcp.servers_client.Leases.get" title="com.vmware.nsx.dhcp.servers_client.Leases.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Leases.get()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.Leases.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">ip</em>, <em class="sig-param">mac</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases.delete" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">ip</span></em>, <em class="sig-param"><span class="n">mac</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a single DHCP lease entry specified by ip and mac. The DHCP
server matches the DHCP lease with the given ip address and the mac
address. The matched lease entry will be deleted. If no lease matches,
@ -466,9 +466,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.Leases.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">address=None</em>, <em class="sig-param">pool_id=None</em>, <em class="sig-param">source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">address</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pool_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Leases.get" title="Permalink to this definition"></a></dt>
<dd><p>Get specific leases of a given dhcp server. As a dhcp server could
manage millions of leases, the API has to limit the number of the
returned leases via two mutually-excluded request parameters, i.e.
@ -518,18 +518,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers_client.State">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.State" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.State" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.State.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">barrier_id=None</em>, <em class="sig-param">request_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.State.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">barrier_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">request_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.State.get" title="Permalink to this definition"></a></dt>
<dd><p>Return realized state information of a dhcp server. After a dhcp server
is created or updated, you can invoke this API to get the realization
information of the server.</p>
@ -572,18 +572,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers_client.StaticBindings">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">StaticBindings</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">StaticBindings</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.StaticBindings.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">dhcp_static_binding</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.create" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">dhcp_static_binding</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a static binding for a logical DHCP server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -621,9 +621,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.StaticBindings.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">binding_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.delete" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">binding_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a specific static binding of a given logical DHCP server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -655,9 +655,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.StaticBindings.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">binding_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">binding_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.get" title="Permalink to this definition"></a></dt>
<dd><p>Return a specific static binding of a given logical DHCP server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -695,9 +695,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.StaticBindings.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.list" title="Permalink to this definition"></a></dt>
<dd><p>Return a paginated list of a static bindings of a given logical DHCP
server.</p>
<dl class="field-list simple">
@ -743,9 +743,9 @@ Not Found</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.StaticBindings.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">binding_id</em>, <em class="sig-param">dhcp_static_binding</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.update" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">binding_id</span></em>, <em class="sig-param"><span class="n">dhcp_static_binding</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.StaticBindings.update" title="Permalink to this definition"></a></dt>
<dd><p>Update a specific static binding of a given local DHCP server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -786,18 +786,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers_client.Statistics">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Statistics" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Statistics" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.Statistics.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Statistics.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Statistics.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the statistics of the given dhcp server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -834,18 +834,18 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Status" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Status" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Status.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the service status of the given dhcp server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -882,9 +882,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_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.nsx.dhcp.servers_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers_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">

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.dhcp.servers package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.dhcp.servers package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -178,18 +178,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.dhcp.servers.ip_pools_client">
<span id="com-vmware-nsx-dhcp-servers-ip-pools-client-module"></span><h2>com.vmware.nsx.dhcp.servers.ip_pools_client module<a class="headerlink" href="#module-com.vmware.nsx.dhcp.servers.ip_pools_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers.ip_pools_client.State">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.ip_pools_client.</code><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.ip_pools_client.State" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.ip_pools_client.</code><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.ip_pools_client.State" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers.ip_pools_client.State.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">pool_id</em>, <em class="sig-param">barrier_id=None</em>, <em class="sig-param">request_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.ip_pools_client.State.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">pool_id</span></em>, <em class="sig-param"><span class="n">barrier_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">request_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.ip_pools_client.State.get" title="Permalink to this definition"></a></dt>
<dd><p>Return realized state information of a dhcp ip pool. After a dhcp ip
pool is created or updated, you can invoke this API to get the
realization information of the ip pool.</p>
@ -233,9 +233,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers.ip_pools_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.ip_pools_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.nsx.dhcp.servers.ip_pools_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.ip_pools_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.ip_pools_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">
@ -248,18 +248,18 @@ Not Found</p>
</div>
<div class="section" id="module-com.vmware.nsx.dhcp.servers.static_bindings_client">
<span id="com-vmware-nsx-dhcp-servers-static-bindings-client-module"></span><h2>com.vmware.nsx.dhcp.servers.static_bindings_client module<a class="headerlink" href="#module-com.vmware.nsx.dhcp.servers.static_bindings_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers.static_bindings_client.State">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.static_bindings_client.</code><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.static_bindings_client.State" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.static_bindings_client.</code><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.static_bindings_client.State" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.dhcp.servers.static_bindings_client.State.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">server_id</em>, <em class="sig-param">binding_id</em>, <em class="sig-param">barrier_id=None</em>, <em class="sig-param">request_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.static_bindings_client.State.get" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server_id</span></em>, <em class="sig-param"><span class="n">binding_id</span></em>, <em class="sig-param"><span class="n">barrier_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">request_id</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.static_bindings_client.State.get" title="Permalink to this definition"></a></dt>
<dd><p>Return realized state information of a dhcp static binding. After a
dhcp static binding is created or updated, you can invoke this API to
get the realization information of the static binding.</p>
@ -303,9 +303,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.dhcp.servers.static_bindings_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.static_bindings_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.nsx.dhcp.servers.static_bindings_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.dhcp.servers.static_bindings_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dhcp.servers.static_bindings_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">

View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx.directory.domains package &mdash; NSX-T SDK 2.5.1.0.1 documentation</title>
<title>com.vmware.nsx.directory.domains package &mdash; NSX-T SDK 2.5.1.0.5 documentation</title>
@ -21,10 +21,10 @@
<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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
@ -60,7 +60,7 @@
<div class="version">
2.5.1.0.1
2.5.1.0.5
</div>
@ -92,7 +92,7 @@
<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.nsx_client">com.vmware.nsx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_client_for_vmc">com.vmware.nsx_client_for_vmc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#com-vmware-nsx-client-for-vmc-module">com.vmware.nsx_client_for_vmc module</a></li>
</ul>
</li>
</ul>
@ -178,18 +178,18 @@
</div>
<div class="section" id="module-com.vmware.nsx.directory.domains.groups_client">
<span id="com-vmware-nsx-directory-domains-groups-client-module"></span><h2>com.vmware.nsx.directory.domains.groups_client module<a class="headerlink" href="#module-com.vmware.nsx.directory.domains.groups_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.directory.domains.groups_client.MemberGroups">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.directory.domains.groups_client.</code><code class="sig-name descname">MemberGroups</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.directory.domains.groups_client.MemberGroups" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.directory.domains.groups_client.</code><code class="sig-name descname">MemberGroups</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.directory.domains.groups_client.MemberGroups" 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>
<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="method">
<dl class="py method">
<dt id="com.vmware.nsx.directory.domains.groups_client.MemberGroups.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">domain_id</em>, <em class="sig-param">group_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.directory.domains.groups_client.MemberGroups.list" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.directory.domains.groups_client.MemberGroups.list" title="Permalink to this definition"></a></dt>
<dd><p>A member group could be either direct member of the group specified by
group_id or nested member of it. Both direct member groups and nested
member groups are returned.</p>
@ -239,9 +239,9 @@ Not Found</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="com.vmware.nsx.directory.domains.groups_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.directory.domains.groups_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.nsx.directory.domains.groups_client.StubFactory" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx.directory.domains.groups_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.directory.domains.groups_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">

Some files were not shown because too many files have changed in this diff Show More