Merge pull request #155 from ggoodvmw/gh-pages
Update NSX documentation to M7
@ -1,4 +1,4 @@
|
|||||||
# Sphinx build info version 1
|
# 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.
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
config: c9aeb5aba9e4bb947d842096903b7786
|
config: 5f9f68a640f7ec9b1ce8da26f77cf9b9
|
||||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
.. NSX-T SDK documentation master file, created by
|
.. NSX-T SDK documentation master file, created by
|
||||||
sphinx-quickstart on Wed Nov 28 19:01:54 2018.
|
sphinx-quickstart on Tue May 28 11:26:47 2019.
|
||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 673 B |
@ -4,7 +4,7 @@
|
|||||||
*
|
*
|
||||||
* Sphinx stylesheet -- basic theme.
|
* Sphinx stylesheet -- basic theme.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@ -231,6 +231,16 @@ a.headerlink {
|
|||||||
visibility: hidden;
|
visibility: hidden;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
a.brackets:before,
|
||||||
|
span.brackets > a:before{
|
||||||
|
content: "[";
|
||||||
|
}
|
||||||
|
|
||||||
|
a.brackets:after,
|
||||||
|
span.brackets > a:after {
|
||||||
|
content: "]";
|
||||||
|
}
|
||||||
|
|
||||||
h1:hover > a.headerlink,
|
h1:hover > a.headerlink,
|
||||||
h2:hover > a.headerlink,
|
h2:hover > a.headerlink,
|
||||||
h3:hover > a.headerlink,
|
h3:hover > a.headerlink,
|
||||||
@ -391,6 +401,16 @@ table.citation td {
|
|||||||
border-bottom: none;
|
border-bottom: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
th > p:first-child,
|
||||||
|
td > p:first-child {
|
||||||
|
margin-top: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
th > p:last-child,
|
||||||
|
td > p:last-child {
|
||||||
|
margin-bottom: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
/* -- figures --------------------------------------------------------------- */
|
/* -- figures --------------------------------------------------------------- */
|
||||||
|
|
||||||
div.figure {
|
div.figure {
|
||||||
@ -460,11 +480,57 @@ ol.upperroman {
|
|||||||
list-style: upper-roman;
|
list-style: upper-roman;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
li > p:first-child {
|
||||||
|
margin-top: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
li > p:last-child {
|
||||||
|
margin-bottom: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dt,
|
||||||
|
dl.citation > dt {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dd,
|
||||||
|
dl.citation > dd {
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dd:after,
|
||||||
|
dl.citation > dd:after {
|
||||||
|
content: "";
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dt {
|
||||||
|
flex-basis: 20%;
|
||||||
|
font-weight: bold;
|
||||||
|
word-break: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dt:after {
|
||||||
|
content: ":";
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dd {
|
||||||
|
flex-basis: 70%;
|
||||||
|
padding-left: 1em;
|
||||||
|
margin-left: 0em;
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
dl {
|
dl {
|
||||||
margin-bottom: 15px;
|
margin-bottom: 15px;
|
||||||
}
|
}
|
||||||
|
|
||||||
dd p {
|
dd > p:first-child {
|
||||||
margin-top: 0px;
|
margin-top: 0px;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -537,6 +603,12 @@ dl.glossary dt {
|
|||||||
font-style: oblique;
|
font-style: oblique;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.classifier:before {
|
||||||
|
font-style: normal;
|
||||||
|
margin: 0.5em;
|
||||||
|
content: ":";
|
||||||
|
}
|
||||||
|
|
||||||
abbr, acronym {
|
abbr, acronym {
|
||||||
border-bottom: dotted 1px;
|
border-bottom: dotted 1px;
|
||||||
cursor: help;
|
cursor: help;
|
||||||
|
Before Width: | Height: | Size: 756 B |
Before Width: | Height: | Size: 829 B |
Before Width: | Height: | Size: 641 B |
@ -1 +1 @@
|
|||||||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
*
|
*
|
||||||
* Sphinx JavaScript utilities for all documentation.
|
* Sphinx JavaScript utilities for all documentation.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
|
|||||||
node.nextSibling));
|
node.nextSibling));
|
||||||
node.nodeValue = val.substr(0, pos);
|
node.nodeValue = val.substr(0, pos);
|
||||||
if (isInSVG) {
|
if (isInSVG) {
|
||||||
var bbox = span.getBBox();
|
|
||||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||||
rect.x.baseVal.value = bbox.x;
|
var bbox = node.parentElement.getBBox();
|
||||||
|
rect.x.baseVal.value = bbox.x;
|
||||||
rect.y.baseVal.value = bbox.y;
|
rect.y.baseVal.value = bbox.y;
|
||||||
rect.width.baseVal.value = bbox.width;
|
rect.width.baseVal.value = bbox.width;
|
||||||
rect.height.baseVal.value = bbox.height;
|
rect.height.baseVal.value = bbox.height;
|
||||||
rect.setAttribute('class', className);
|
rect.setAttribute('class', className);
|
||||||
var parentOfText = node.parentNode.parentNode;
|
|
||||||
addItems.push({
|
addItems.push({
|
||||||
"parent": node.parentNode,
|
"parent": node.parentNode,
|
||||||
"target": rect});
|
"target": rect});
|
||||||
|
@ -1,296 +1,10 @@
|
|||||||
var DOCUMENTATION_OPTIONS = {
|
var DOCUMENTATION_OPTIONS = {
|
||||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||||
VERSION: '2.3.0.0.2',
|
VERSION: '2.3.0.0.3',
|
||||||
LANGUAGE: 'en',
|
LANGUAGE: 'en',
|
||||||
COLLAPSE_INDEX: false,
|
COLLAPSE_INDEX: false,
|
||||||
FILE_SUFFIX: '.html',
|
FILE_SUFFIX: '.html',
|
||||||
HAS_SOURCE: true,
|
HAS_SOURCE: true,
|
||||||
SOURCELINK_SUFFIX: '.txt',
|
SOURCELINK_SUFFIX: '.txt',
|
||||||
NAVIGATION_WITH_KEYS: false,
|
NAVIGATION_WITH_KEYS: false
|
||||||
SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]
|
};
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
|
||||||
/**
|
|
||||||
* Porter Stemmer
|
|
||||||
*/
|
|
||||||
var Stemmer = function() {
|
|
||||||
|
|
||||||
var step2list = {
|
|
||||||
ational: 'ate',
|
|
||||||
tional: 'tion',
|
|
||||||
enci: 'ence',
|
|
||||||
anci: 'ance',
|
|
||||||
izer: 'ize',
|
|
||||||
bli: 'ble',
|
|
||||||
alli: 'al',
|
|
||||||
entli: 'ent',
|
|
||||||
eli: 'e',
|
|
||||||
ousli: 'ous',
|
|
||||||
ization: 'ize',
|
|
||||||
ation: 'ate',
|
|
||||||
ator: 'ate',
|
|
||||||
alism: 'al',
|
|
||||||
iveness: 'ive',
|
|
||||||
fulness: 'ful',
|
|
||||||
ousness: 'ous',
|
|
||||||
aliti: 'al',
|
|
||||||
iviti: 'ive',
|
|
||||||
biliti: 'ble',
|
|
||||||
logi: 'log'
|
|
||||||
};
|
|
||||||
|
|
||||||
var step3list = {
|
|
||||||
icate: 'ic',
|
|
||||||
ative: '',
|
|
||||||
alize: 'al',
|
|
||||||
iciti: 'ic',
|
|
||||||
ical: 'ic',
|
|
||||||
ful: '',
|
|
||||||
ness: ''
|
|
||||||
};
|
|
||||||
|
|
||||||
var c = "[^aeiou]"; // consonant
|
|
||||||
var v = "[aeiouy]"; // vowel
|
|
||||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
|
||||||
var V = v + "[aeiou]*"; // vowel sequence
|
|
||||||
|
|
||||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
|
||||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
|
||||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
|
||||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
|
||||||
|
|
||||||
this.stemWord = function (w) {
|
|
||||||
var stem;
|
|
||||||
var suffix;
|
|
||||||
var firstch;
|
|
||||||
var origword = w;
|
|
||||||
|
|
||||||
if (w.length < 3)
|
|
||||||
return w;
|
|
||||||
|
|
||||||
var re;
|
|
||||||
var re2;
|
|
||||||
var re3;
|
|
||||||
var re4;
|
|
||||||
|
|
||||||
firstch = w.substr(0,1);
|
|
||||||
if (firstch == "y")
|
|
||||||
w = firstch.toUpperCase() + w.substr(1);
|
|
||||||
|
|
||||||
// Step 1a
|
|
||||||
re = /^(.+?)(ss|i)es$/;
|
|
||||||
re2 = /^(.+?)([^s])s$/;
|
|
||||||
|
|
||||||
if (re.test(w))
|
|
||||||
w = w.replace(re,"$1$2");
|
|
||||||
else if (re2.test(w))
|
|
||||||
w = w.replace(re2,"$1$2");
|
|
||||||
|
|
||||||
// Step 1b
|
|
||||||
re = /^(.+?)eed$/;
|
|
||||||
re2 = /^(.+?)(ed|ing)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
re = new RegExp(mgr0);
|
|
||||||
if (re.test(fp[1])) {
|
|
||||||
re = /.$/;
|
|
||||||
w = w.replace(re,"");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (re2.test(w)) {
|
|
||||||
var fp = re2.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re2 = new RegExp(s_v);
|
|
||||||
if (re2.test(stem)) {
|
|
||||||
w = stem;
|
|
||||||
re2 = /(at|bl|iz)$/;
|
|
||||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
|
||||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
|
||||||
if (re2.test(w))
|
|
||||||
w = w + "e";
|
|
||||||
else if (re3.test(w)) {
|
|
||||||
re = /.$/;
|
|
||||||
w = w.replace(re,"");
|
|
||||||
}
|
|
||||||
else if (re4.test(w))
|
|
||||||
w = w + "e";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 1c
|
|
||||||
re = /^(.+?)y$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re = new RegExp(s_v);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem + "i";
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 2
|
|
||||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
suffix = fp[2];
|
|
||||||
re = new RegExp(mgr0);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem + step2list[suffix];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 3
|
|
||||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
suffix = fp[2];
|
|
||||||
re = new RegExp(mgr0);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem + step3list[suffix];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 4
|
|
||||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
|
||||||
re2 = /^(.+?)(s|t)(ion)$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re = new RegExp(mgr1);
|
|
||||||
if (re.test(stem))
|
|
||||||
w = stem;
|
|
||||||
}
|
|
||||||
else if (re2.test(w)) {
|
|
||||||
var fp = re2.exec(w);
|
|
||||||
stem = fp[1] + fp[2];
|
|
||||||
re2 = new RegExp(mgr1);
|
|
||||||
if (re2.test(stem))
|
|
||||||
w = stem;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 5
|
|
||||||
re = /^(.+?)e$/;
|
|
||||||
if (re.test(w)) {
|
|
||||||
var fp = re.exec(w);
|
|
||||||
stem = fp[1];
|
|
||||||
re = new RegExp(mgr1);
|
|
||||||
re2 = new RegExp(meq1);
|
|
||||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
|
||||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
|
||||||
w = stem;
|
|
||||||
}
|
|
||||||
re = /ll$/;
|
|
||||||
re2 = new RegExp(mgr1);
|
|
||||||
if (re.test(w) && re2.test(w)) {
|
|
||||||
re = /.$/;
|
|
||||||
w = w.replace(re,"");
|
|
||||||
}
|
|
||||||
|
|
||||||
// and turn initial Y back to y
|
|
||||||
if (firstch == "y")
|
|
||||||
w = firstch.toLowerCase() + w.substr(1);
|
|
||||||
return w;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
var splitChars = (function() {
|
|
||||||
var result = {};
|
|
||||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
|
||||||
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
|
||||||
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
|
||||||
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
|
||||||
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
|
||||||
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
|
||||||
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
|
||||||
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
|
||||||
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
|
||||||
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
|
||||||
var i, j, start, end;
|
|
||||||
for (i = 0; i < singles.length; i++) {
|
|
||||||
result[singles[i]] = true;
|
|
||||||
}
|
|
||||||
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
|
||||||
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
|
||||||
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
|
||||||
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
|
||||||
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
|
||||||
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
|
||||||
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
|
||||||
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
|
||||||
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
|
||||||
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
|
||||||
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
|
||||||
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
|
||||||
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
|
||||||
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
|
||||||
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
|
||||||
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
|
||||||
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
|
||||||
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
|
||||||
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
|
||||||
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
|
||||||
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
|
||||||
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
|
||||||
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
|
||||||
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
|
||||||
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
|
||||||
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
|
||||||
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
|
||||||
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
|
||||||
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
|
||||||
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
|
||||||
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
|
||||||
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
|
||||||
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
|
||||||
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
|
||||||
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
|
||||||
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
|
||||||
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
|
||||||
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
|
||||||
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
|
||||||
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
|
||||||
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
|
||||||
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
|
||||||
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
|
||||||
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
|
||||||
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
|
||||||
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
|
||||||
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
|
||||||
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
|
||||||
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
|
||||||
for (i = 0; i < ranges.length; i++) {
|
|
||||||
start = ranges[i][0];
|
|
||||||
end = ranges[i][1];
|
|
||||||
for (j = start; j <= end; j++) {
|
|
||||||
result[j] = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
})();
|
|
||||||
|
|
||||||
function splitQuery(query) {
|
|
||||||
var result = [];
|
|
||||||
var start = -1;
|
|
||||||
for (var i = 0; i < query.length; i++) {
|
|
||||||
if (splitChars[query.charCodeAt(i)]) {
|
|
||||||
if (start !== -1) {
|
|
||||||
result.push(query.slice(start, i));
|
|
||||||
start = -1;
|
|
||||||
}
|
|
||||||
} else if (start === -1) {
|
|
||||||
start = i;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (start !== -1) {
|
|
||||||
result.push(query.slice(start));
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
Before Width: | Height: | Size: 222 B |
Before Width: | Height: | Size: 202 B |
@ -1,3 +1,3 @@
|
|||||||
/* sphinx_rtd_theme version 0.4.2 | MIT license */
|
/* sphinx_rtd_theme version 0.4.3 | MIT license */
|
||||||
/* Built 20181005 13:10 */
|
/* Built 20190212 16:02 */
|
||||||
require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(e){var i=this;void 0===e&&(e=!0),i.isRunning||(i.isRunning=!0,jQuery(function(n){i.init(n),i.reset(),i.win.on("hashchange",i.reset),e&&i.win.on("scroll",function(){i.linkScroll||i.winScroll||(i.winScroll=!0,requestAnimationFrame(function(){i.onScroll()}))}),i.win.on("resize",function(){i.winResize||(i.winResize=!0,requestAnimationFrame(function(){i.onResize()}))}),i.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(i){i(document);var t=this;this.navBar=i("div.wy-side-scroll:first"),this.win=i(window),i(document).on("click","[data-toggle='wy-nav-top']",function(){i("[data-toggle='wy-nav-shift']").toggleClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var n=i(this);i("[data-toggle='wy-nav-shift']").removeClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift"),t.toggleCurrent(n),t.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){i("[data-toggle='rst-versions']").toggleClass("shift-up")}),i("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),i("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),i("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i('<span class="toctree-expand"></span>'),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0<i.length&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"))}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e<n.length&&!window.requestAnimationFrame;++e)window.requestAnimationFrame=window[n[e]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[n[e]+"CancelAnimationFrame"]||window[n[e]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(n,e){var i=(new Date).getTime(),t=Math.max(0,16-(i-r)),o=window.setTimeout(function(){n(i+t)},t);return r=i+t,o}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);
|
require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(e){var i=this;void 0===e&&(e=!0),i.isRunning||(i.isRunning=!0,jQuery(function(n){i.init(n),i.reset(),i.win.on("hashchange",i.reset),e&&i.win.on("scroll",function(){i.linkScroll||i.winScroll||(i.winScroll=!0,requestAnimationFrame(function(){i.onScroll()}))}),i.win.on("resize",function(){i.winResize||(i.winResize=!0,requestAnimationFrame(function(){i.onResize()}))}),i.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(i){i(document);var t=this;this.navBar=i("div.wy-side-scroll:first"),this.win=i(window),i(document).on("click","[data-toggle='wy-nav-top']",function(){i("[data-toggle='wy-nav-shift']").toggleClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var n=i(this);i("[data-toggle='wy-nav-shift']").removeClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift"),t.toggleCurrent(n),t.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){i("[data-toggle='rst-versions']").toggleClass("shift-up")}),i("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),i("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),i("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i('<span class="toctree-expand"></span>'),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0<i.length&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"),i[0].scrollIntoView())}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e<n.length&&!window.requestAnimationFrame;++e)window.requestAnimationFrame=window[n[e]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[n[e]+"CancelAnimationFrame"]||window[n[e]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(n,e){var i=(new Date).getTime(),t=Math.max(0,16-(i-r)),o=window.setTimeout(function(){n(i+t)},t);return r=i+t,o}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);
|
@ -1,15 +1,16 @@
|
|||||||
var DOCUMENTATION_OPTIONS = {
|
/*
|
||||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
* language_data.js
|
||||||
VERSION: '2.3.0.0.2',
|
* ~~~~~~~~~~~~~~~~
|
||||||
LANGUAGE: 'en',
|
*
|
||||||
COLLAPSE_INDEX: false,
|
* This script contains the language-specific data used by searchtools.js,
|
||||||
FILE_SUFFIX: '.html',
|
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||||
HAS_SOURCE: true,
|
*
|
||||||
SOURCELINK_SUFFIX: '.txt',
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
NAVIGATION_WITH_KEYS: false,
|
* :license: BSD, see LICENSE for details.
|
||||||
SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]
|
*
|
||||||
};
|
*/
|
||||||
|
|
||||||
|
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||||
|
|
||||||
|
|
||||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
/* Non-minified version JS is _stemmer.js if file is provided */
|
@ -4,7 +4,7 @@
|
|||||||
*
|
*
|
||||||
* Sphinx JavaScript utilities for the full-text search.
|
* Sphinx JavaScript utilities for the full-text search.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@ -36,8 +36,10 @@ if (!Scorer) {
|
|||||||
|
|
||||||
// query found in title
|
// query found in title
|
||||||
title: 15,
|
title: 15,
|
||||||
|
partialTitle: 7,
|
||||||
// query found in terms
|
// query found in terms
|
||||||
term: 5
|
term: 5,
|
||||||
|
partialTerm: 2
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -56,6 +58,14 @@ var Search = {
|
|||||||
_queued_query : null,
|
_queued_query : null,
|
||||||
_pulse_status : -1,
|
_pulse_status : -1,
|
||||||
|
|
||||||
|
htmlToText : function(htmlString) {
|
||||||
|
var htmlElement = document.createElement('span');
|
||||||
|
htmlElement.innerHTML = htmlString;
|
||||||
|
$(htmlElement).find('.headerlink').remove();
|
||||||
|
docContent = $(htmlElement).find('[role=main]')[0];
|
||||||
|
return docContent.textContent || docContent.innerText;
|
||||||
|
},
|
||||||
|
|
||||||
init : function() {
|
init : function() {
|
||||||
var params = $.getQueryParameters();
|
var params = $.getQueryParameters();
|
||||||
if (params.q) {
|
if (params.q) {
|
||||||
@ -120,7 +130,7 @@ var Search = {
|
|||||||
this.out = $('#search-results');
|
this.out = $('#search-results');
|
||||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||||
this.dots = $('<span></span>').appendTo(this.title);
|
this.dots = $('<span></span>').appendTo(this.title);
|
||||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
|
||||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||||
|
|
||||||
$('#search-progress').text(_('Preparing search...'));
|
$('#search-progress').text(_('Preparing search...'));
|
||||||
@ -138,7 +148,6 @@ var Search = {
|
|||||||
*/
|
*/
|
||||||
query : function(query) {
|
query : function(query) {
|
||||||
var i;
|
var i;
|
||||||
var stopwords = DOCUMENTATION_OPTIONS.SEARCH_LANGUAGE_STOP_WORDS;
|
|
||||||
|
|
||||||
// stem the searchterms and add them to the correct list
|
// stem the searchterms and add them to the correct list
|
||||||
var stemmer = new Stemmer();
|
var stemmer = new Stemmer();
|
||||||
@ -260,11 +269,7 @@ var Search = {
|
|||||||
displayNextItem();
|
displayNextItem();
|
||||||
});
|
});
|
||||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
|
||||||
if (suffix === undefined) {
|
|
||||||
suffix = '.txt';
|
|
||||||
}
|
|
||||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
|
||||||
dataType: "text",
|
dataType: "text",
|
||||||
complete: function(jqxhr, textstatus) {
|
complete: function(jqxhr, textstatus) {
|
||||||
var data = jqxhr.responseText;
|
var data = jqxhr.responseText;
|
||||||
@ -386,6 +391,19 @@ var Search = {
|
|||||||
{files: terms[word], score: Scorer.term},
|
{files: terms[word], score: Scorer.term},
|
||||||
{files: titleterms[word], score: Scorer.title}
|
{files: titleterms[word], score: Scorer.title}
|
||||||
];
|
];
|
||||||
|
// add support for partial matches
|
||||||
|
if (word.length > 2) {
|
||||||
|
for (var w in terms) {
|
||||||
|
if (w.match(word) && !terms[word]) {
|
||||||
|
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (var w in titleterms) {
|
||||||
|
if (w.match(word) && !titleterms[word]) {
|
||||||
|
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// no match but word was a required one
|
// no match but word was a required one
|
||||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||||
@ -425,8 +443,12 @@ var Search = {
|
|||||||
var valid = true;
|
var valid = true;
|
||||||
|
|
||||||
// check if all requirements are matched
|
// check if all requirements are matched
|
||||||
if (fileMap[file].length != searchterms.length)
|
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||||
continue;
|
searchterms.filter(function(term){return term.length > 2}).length
|
||||||
|
if (
|
||||||
|
fileMap[file].length != searchterms.length &&
|
||||||
|
fileMap[file].length != filteredTermCount
|
||||||
|
) continue;
|
||||||
|
|
||||||
// ensure that none of the excluded terms is in the search result
|
// ensure that none of the excluded terms is in the search result
|
||||||
for (i = 0; i < excluded.length; i++) {
|
for (i = 0; i < excluded.length; i++) {
|
||||||
@ -457,7 +479,8 @@ var Search = {
|
|||||||
* words. the first one is used to find the occurrence, the
|
* words. the first one is used to find the occurrence, the
|
||||||
* latter for highlighting it.
|
* latter for highlighting it.
|
||||||
*/
|
*/
|
||||||
makeSearchSummary : function(text, keywords, hlwords) {
|
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||||
|
var text = Search.htmlToText(htmlText);
|
||||||
var textLower = text.toLowerCase();
|
var textLower = text.toLowerCase();
|
||||||
var start = 0;
|
var start = 0;
|
||||||
$.each(keywords, function() {
|
$.each(keywords, function() {
|
||||||
|
Before Width: | Height: | Size: 214 B |
Before Width: | Height: | Size: 203 B |
@ -1,808 +0,0 @@
|
|||||||
/*
|
|
||||||
* websupport.js
|
|
||||||
* ~~~~~~~~~~~~~
|
|
||||||
*
|
|
||||||
* sphinx.websupport utilities for all documentation.
|
|
||||||
*
|
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
|
||||||
* :license: BSD, see LICENSE for details.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
(function($) {
|
|
||||||
$.fn.autogrow = function() {
|
|
||||||
return this.each(function() {
|
|
||||||
var textarea = this;
|
|
||||||
|
|
||||||
$.fn.autogrow.resize(textarea);
|
|
||||||
|
|
||||||
$(textarea)
|
|
||||||
.focus(function() {
|
|
||||||
textarea.interval = setInterval(function() {
|
|
||||||
$.fn.autogrow.resize(textarea);
|
|
||||||
}, 500);
|
|
||||||
})
|
|
||||||
.blur(function() {
|
|
||||||
clearInterval(textarea.interval);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
$.fn.autogrow.resize = function(textarea) {
|
|
||||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
|
||||||
var lines = textarea.value.split('\n');
|
|
||||||
var columns = textarea.cols;
|
|
||||||
var lineCount = 0;
|
|
||||||
$.each(lines, function() {
|
|
||||||
lineCount += Math.ceil(this.length / columns) || 1;
|
|
||||||
});
|
|
||||||
var height = lineHeight * (lineCount + 1);
|
|
||||||
$(textarea).css('height', height);
|
|
||||||
};
|
|
||||||
})(jQuery);
|
|
||||||
|
|
||||||
(function($) {
|
|
||||||
var comp, by;
|
|
||||||
|
|
||||||
function init() {
|
|
||||||
initEvents();
|
|
||||||
initComparator();
|
|
||||||
}
|
|
||||||
|
|
||||||
function initEvents() {
|
|
||||||
$(document).on("click", 'a.comment-close', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hide($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.vote', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
handleVote($(this));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.reply', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
openReply($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.close-reply', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
closeReply($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.sort-option', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
handleReSort($(this));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.show-proposal', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
showProposal($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hideProposal($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
showProposeChange($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hideProposeChange($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.accept-comment', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
acceptComment($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.delete-comment', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
deleteComment($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
$(document).on("click", 'a.comment-markup', function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set comp, which is a comparator function used for sorting and
|
|
||||||
* inserting comments into the list.
|
|
||||||
*/
|
|
||||||
function setComparator() {
|
|
||||||
// If the first three letters are "asc", sort in ascending order
|
|
||||||
// and remove the prefix.
|
|
||||||
if (by.substring(0,3) == 'asc') {
|
|
||||||
var i = by.substring(3);
|
|
||||||
comp = function(a, b) { return a[i] - b[i]; };
|
|
||||||
} else {
|
|
||||||
// Otherwise sort in descending order.
|
|
||||||
comp = function(a, b) { return b[by] - a[by]; };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset link styles and format the selected sort option.
|
|
||||||
$('a.sel').attr('href', '#').removeClass('sel');
|
|
||||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a comp function. If the user has preferences stored in
|
|
||||||
* the sortBy cookie, use those, otherwise use the default.
|
|
||||||
*/
|
|
||||||
function initComparator() {
|
|
||||||
by = 'rating'; // Default to sort by rating.
|
|
||||||
// If the sortBy cookie is set, use that instead.
|
|
||||||
if (document.cookie.length > 0) {
|
|
||||||
var start = document.cookie.indexOf('sortBy=');
|
|
||||||
if (start != -1) {
|
|
||||||
start = start + 7;
|
|
||||||
var end = document.cookie.indexOf(";", start);
|
|
||||||
if (end == -1) {
|
|
||||||
end = document.cookie.length;
|
|
||||||
by = unescape(document.cookie.substring(start, end));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
setComparator();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Show a comment div.
|
|
||||||
*/
|
|
||||||
function show(id) {
|
|
||||||
$('#ao' + id).hide();
|
|
||||||
$('#ah' + id).show();
|
|
||||||
var context = $.extend({id: id}, opts);
|
|
||||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
|
||||||
popup.find('textarea[name="proposal"]').hide();
|
|
||||||
popup.find('a.by' + by).addClass('sel');
|
|
||||||
var form = popup.find('#cf' + id);
|
|
||||||
form.submit(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
addComment(form);
|
|
||||||
});
|
|
||||||
$('#s' + id).after(popup);
|
|
||||||
popup.slideDown('fast', function() {
|
|
||||||
getComments(id);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Hide a comment div.
|
|
||||||
*/
|
|
||||||
function hide(id) {
|
|
||||||
$('#ah' + id).hide();
|
|
||||||
$('#ao' + id).show();
|
|
||||||
var div = $('#sc' + id);
|
|
||||||
div.slideUp('fast', function() {
|
|
||||||
div.remove();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Perform an ajax request to get comments for a node
|
|
||||||
* and insert the comments into the comments tree.
|
|
||||||
*/
|
|
||||||
function getComments(id) {
|
|
||||||
$.ajax({
|
|
||||||
type: 'GET',
|
|
||||||
url: opts.getCommentsURL,
|
|
||||||
data: {node: id},
|
|
||||||
success: function(data, textStatus, request) {
|
|
||||||
var ul = $('#cl' + id);
|
|
||||||
var speed = 100;
|
|
||||||
$('#cf' + id)
|
|
||||||
.find('textarea[name="proposal"]')
|
|
||||||
.data('source', data.source);
|
|
||||||
|
|
||||||
if (data.comments.length === 0) {
|
|
||||||
ul.html('<li>No comments yet.</li>');
|
|
||||||
ul.data('empty', true);
|
|
||||||
} else {
|
|
||||||
// If there are comments, sort them and put them in the list.
|
|
||||||
var comments = sortComments(data.comments);
|
|
||||||
speed = data.comments.length * 100;
|
|
||||||
appendComments(comments, ul);
|
|
||||||
ul.data('empty', false);
|
|
||||||
}
|
|
||||||
$('#cn' + id).slideUp(speed + 200);
|
|
||||||
ul.slideDown(speed);
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem retrieving the comments.');
|
|
||||||
},
|
|
||||||
dataType: 'json'
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add a comment via ajax and insert the comment into the comment tree.
|
|
||||||
*/
|
|
||||||
function addComment(form) {
|
|
||||||
var node_id = form.find('input[name="node"]').val();
|
|
||||||
var parent_id = form.find('input[name="parent"]').val();
|
|
||||||
var text = form.find('textarea[name="comment"]').val();
|
|
||||||
var proposal = form.find('textarea[name="proposal"]').val();
|
|
||||||
|
|
||||||
if (text == '') {
|
|
||||||
showError('Please enter a comment.');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Disable the form that is being submitted.
|
|
||||||
form.find('textarea,input').attr('disabled', 'disabled');
|
|
||||||
|
|
||||||
// Send the comment to the server.
|
|
||||||
$.ajax({
|
|
||||||
type: "POST",
|
|
||||||
url: opts.addCommentURL,
|
|
||||||
dataType: 'json',
|
|
||||||
data: {
|
|
||||||
node: node_id,
|
|
||||||
parent: parent_id,
|
|
||||||
text: text,
|
|
||||||
proposal: proposal
|
|
||||||
},
|
|
||||||
success: function(data, textStatus, error) {
|
|
||||||
// Reset the form.
|
|
||||||
if (node_id) {
|
|
||||||
hideProposeChange(node_id);
|
|
||||||
}
|
|
||||||
form.find('textarea')
|
|
||||||
.val('')
|
|
||||||
.add(form.find('input'))
|
|
||||||
.removeAttr('disabled');
|
|
||||||
var ul = $('#cl' + (node_id || parent_id));
|
|
||||||
if (ul.data('empty')) {
|
|
||||||
$(ul).empty();
|
|
||||||
ul.data('empty', false);
|
|
||||||
}
|
|
||||||
insertComment(data.comment);
|
|
||||||
var ao = $('#ao' + node_id);
|
|
||||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
|
||||||
if (node_id) {
|
|
||||||
// if this was a "root" comment, remove the commenting box
|
|
||||||
// (the user can get it back by reopening the comment popup)
|
|
||||||
$('#ca' + node_id).slideUp();
|
|
||||||
}
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
form.find('textarea,input').removeAttr('disabled');
|
|
||||||
showError('Oops, there was a problem adding the comment.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Recursively append comments to the main comment list and children
|
|
||||||
* lists, creating the comment tree.
|
|
||||||
*/
|
|
||||||
function appendComments(comments, ul) {
|
|
||||||
$.each(comments, function() {
|
|
||||||
var div = createCommentDiv(this);
|
|
||||||
ul.append($(document.createElement('li')).html(div));
|
|
||||||
appendComments(this.children, div.find('ul.comment-children'));
|
|
||||||
// To avoid stagnating data, don't store the comments children in data.
|
|
||||||
this.children = null;
|
|
||||||
div.data('comment', this);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* After adding a new comment, it must be inserted in the correct
|
|
||||||
* location in the comment tree.
|
|
||||||
*/
|
|
||||||
function insertComment(comment) {
|
|
||||||
var div = createCommentDiv(comment);
|
|
||||||
|
|
||||||
// To avoid stagnating data, don't store the comments children in data.
|
|
||||||
comment.children = null;
|
|
||||||
div.data('comment', comment);
|
|
||||||
|
|
||||||
var ul = $('#cl' + (comment.node || comment.parent));
|
|
||||||
var siblings = getChildren(ul);
|
|
||||||
|
|
||||||
var li = $(document.createElement('li'));
|
|
||||||
li.hide();
|
|
||||||
|
|
||||||
// Determine where in the parents children list to insert this comment.
|
|
||||||
for(var i=0; i < siblings.length; i++) {
|
|
||||||
if (comp(comment, siblings[i]) <= 0) {
|
|
||||||
$('#cd' + siblings[i].id)
|
|
||||||
.parent()
|
|
||||||
.before(li.html(div));
|
|
||||||
li.slideDown('fast');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// If we get here, this comment rates lower than all the others,
|
|
||||||
// or it is the only comment in the list.
|
|
||||||
ul.append(li.html(div));
|
|
||||||
li.slideDown('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function acceptComment(id) {
|
|
||||||
$.ajax({
|
|
||||||
type: 'POST',
|
|
||||||
url: opts.acceptCommentURL,
|
|
||||||
data: {id: id},
|
|
||||||
success: function(data, textStatus, request) {
|
|
||||||
$('#cm' + id).fadeOut('fast');
|
|
||||||
$('#cd' + id).removeClass('moderate');
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem accepting the comment.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function deleteComment(id) {
|
|
||||||
$.ajax({
|
|
||||||
type: 'POST',
|
|
||||||
url: opts.deleteCommentURL,
|
|
||||||
data: {id: id},
|
|
||||||
success: function(data, textStatus, request) {
|
|
||||||
var div = $('#cd' + id);
|
|
||||||
if (data == 'delete') {
|
|
||||||
// Moderator mode: remove the comment and all children immediately
|
|
||||||
div.slideUp('fast', function() {
|
|
||||||
div.remove();
|
|
||||||
});
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// User mode: only mark the comment as deleted
|
|
||||||
div
|
|
||||||
.find('span.user-id:first')
|
|
||||||
.text('[deleted]').end()
|
|
||||||
.find('div.comment-text:first')
|
|
||||||
.text('[deleted]').end()
|
|
||||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
|
||||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
|
||||||
.remove();
|
|
||||||
var comment = div.data('comment');
|
|
||||||
comment.username = '[deleted]';
|
|
||||||
comment.text = '[deleted]';
|
|
||||||
div.data('comment', comment);
|
|
||||||
},
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem deleting the comment.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function showProposal(id) {
|
|
||||||
$('#sp' + id).hide();
|
|
||||||
$('#hp' + id).show();
|
|
||||||
$('#pr' + id).slideDown('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function hideProposal(id) {
|
|
||||||
$('#hp' + id).hide();
|
|
||||||
$('#sp' + id).show();
|
|
||||||
$('#pr' + id).slideUp('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function showProposeChange(id) {
|
|
||||||
$('#pc' + id).hide();
|
|
||||||
$('#hc' + id).show();
|
|
||||||
var textarea = $('#pt' + id);
|
|
||||||
textarea.val(textarea.data('source'));
|
|
||||||
$.fn.autogrow.resize(textarea[0]);
|
|
||||||
textarea.slideDown('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function hideProposeChange(id) {
|
|
||||||
$('#hc' + id).hide();
|
|
||||||
$('#pc' + id).show();
|
|
||||||
var textarea = $('#pt' + id);
|
|
||||||
textarea.val('').removeAttr('disabled');
|
|
||||||
textarea.slideUp('fast');
|
|
||||||
}
|
|
||||||
|
|
||||||
function toggleCommentMarkupBox(id) {
|
|
||||||
$('#mb' + id).toggle();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Handle when the user clicks on a sort by link. */
|
|
||||||
function handleReSort(link) {
|
|
||||||
var classes = link.attr('class').split(/\s+/);
|
|
||||||
for (var i=0; i<classes.length; i++) {
|
|
||||||
if (classes[i] != 'sort-option') {
|
|
||||||
by = classes[i].substring(2);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
setComparator();
|
|
||||||
// Save/update the sortBy cookie.
|
|
||||||
var expiration = new Date();
|
|
||||||
expiration.setDate(expiration.getDate() + 365);
|
|
||||||
document.cookie= 'sortBy=' + escape(by) +
|
|
||||||
';expires=' + expiration.toUTCString();
|
|
||||||
$('ul.comment-ul').each(function(index, ul) {
|
|
||||||
var comments = getChildren($(ul), true);
|
|
||||||
comments = sortComments(comments);
|
|
||||||
appendComments(comments, $(ul).empty());
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Function to process a vote when a user clicks an arrow.
|
|
||||||
*/
|
|
||||||
function handleVote(link) {
|
|
||||||
if (!opts.voting) {
|
|
||||||
showError("You'll need to login to vote.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
var id = link.attr('id');
|
|
||||||
if (!id) {
|
|
||||||
// Didn't click on one of the voting arrows.
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// If it is an unvote, the new vote value is 0,
|
|
||||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
|
||||||
var value = 0;
|
|
||||||
if (id.charAt(1) != 'u') {
|
|
||||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
|
||||||
}
|
|
||||||
// The data to be sent to the server.
|
|
||||||
var d = {
|
|
||||||
comment_id: id.substring(2),
|
|
||||||
value: value
|
|
||||||
};
|
|
||||||
|
|
||||||
// Swap the vote and unvote links.
|
|
||||||
link.hide();
|
|
||||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
|
||||||
.show();
|
|
||||||
|
|
||||||
// The div the comment is displayed in.
|
|
||||||
var div = $('div#cd' + d.comment_id);
|
|
||||||
var data = div.data('comment');
|
|
||||||
|
|
||||||
// If this is not an unvote, and the other vote arrow has
|
|
||||||
// already been pressed, unpress it.
|
|
||||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
|
||||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
|
||||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Update the comments rating in the local data.
|
|
||||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
|
||||||
data.vote = d.value;
|
|
||||||
div.data('comment', data);
|
|
||||||
|
|
||||||
// Change the rating text.
|
|
||||||
div.find('.rating:first')
|
|
||||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
|
||||||
|
|
||||||
// Send the vote information to the server.
|
|
||||||
$.ajax({
|
|
||||||
type: "POST",
|
|
||||||
url: opts.processVoteURL,
|
|
||||||
data: d,
|
|
||||||
error: function(request, textStatus, error) {
|
|
||||||
showError('Oops, there was a problem casting that vote.');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Open a reply form used to reply to an existing comment.
|
|
||||||
*/
|
|
||||||
function openReply(id) {
|
|
||||||
// Swap out the reply link for the hide link
|
|
||||||
$('#rl' + id).hide();
|
|
||||||
$('#cr' + id).show();
|
|
||||||
|
|
||||||
// Add the reply li to the children ul.
|
|
||||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
|
||||||
$('#cl' + id)
|
|
||||||
.prepend(div)
|
|
||||||
// Setup the submit handler for the reply form.
|
|
||||||
.find('#rf' + id)
|
|
||||||
.submit(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
addComment($('#rf' + id));
|
|
||||||
closeReply(id);
|
|
||||||
})
|
|
||||||
.find('input[type=button]')
|
|
||||||
.click(function() {
|
|
||||||
closeReply(id);
|
|
||||||
});
|
|
||||||
div.slideDown('fast', function() {
|
|
||||||
$('#rf' + id).find('textarea').focus();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Close the reply form opened with openReply.
|
|
||||||
*/
|
|
||||||
function closeReply(id) {
|
|
||||||
// Remove the reply div from the DOM.
|
|
||||||
$('#rd' + id).slideUp('fast', function() {
|
|
||||||
$(this).remove();
|
|
||||||
});
|
|
||||||
|
|
||||||
// Swap out the hide link for the reply link
|
|
||||||
$('#cr' + id).hide();
|
|
||||||
$('#rl' + id).show();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Recursively sort a tree of comments using the comp comparator.
|
|
||||||
*/
|
|
||||||
function sortComments(comments) {
|
|
||||||
comments.sort(comp);
|
|
||||||
$.each(comments, function() {
|
|
||||||
this.children = sortComments(this.children);
|
|
||||||
});
|
|
||||||
return comments;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the children comments from a ul. If recursive is true,
|
|
||||||
* recursively include childrens' children.
|
|
||||||
*/
|
|
||||||
function getChildren(ul, recursive) {
|
|
||||||
var children = [];
|
|
||||||
ul.children().children("[id^='cd']")
|
|
||||||
.each(function() {
|
|
||||||
var comment = $(this).data('comment');
|
|
||||||
if (recursive)
|
|
||||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
|
||||||
children.push(comment);
|
|
||||||
});
|
|
||||||
return children;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Create a div to display a comment in. */
|
|
||||||
function createCommentDiv(comment) {
|
|
||||||
if (!comment.displayed && !opts.moderator) {
|
|
||||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
|
||||||
+ 'once it is has been approved by a moderator.</div>');
|
|
||||||
}
|
|
||||||
// Prettify the comment rating.
|
|
||||||
comment.pretty_rating = comment.rating + ' point' +
|
|
||||||
(comment.rating == 1 ? '' : 's');
|
|
||||||
// Make a class (for displaying not yet moderated comments differently)
|
|
||||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
|
||||||
// Create a div for this comment.
|
|
||||||
var context = $.extend({}, opts, comment);
|
|
||||||
var div = $(renderTemplate(commentTemplate, context));
|
|
||||||
|
|
||||||
// If the user has voted on this comment, highlight the correct arrow.
|
|
||||||
if (comment.vote) {
|
|
||||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
|
||||||
div.find('#' + direction + 'v' + comment.id).hide();
|
|
||||||
div.find('#' + direction + 'u' + comment.id).show();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (opts.moderator || comment.text != '[deleted]') {
|
|
||||||
div.find('a.reply').show();
|
|
||||||
if (comment.proposal_diff)
|
|
||||||
div.find('#sp' + comment.id).show();
|
|
||||||
if (opts.moderator && !comment.displayed)
|
|
||||||
div.find('#cm' + comment.id).show();
|
|
||||||
if (opts.moderator || (opts.username == comment.username))
|
|
||||||
div.find('#dc' + comment.id).show();
|
|
||||||
}
|
|
||||||
return div;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
|
||||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
|
||||||
* are not escaped.
|
|
||||||
*/
|
|
||||||
function renderTemplate(template, context) {
|
|
||||||
var esc = $(document.createElement('div'));
|
|
||||||
|
|
||||||
function handle(ph, escape) {
|
|
||||||
var cur = context;
|
|
||||||
$.each(ph.split('.'), function() {
|
|
||||||
cur = cur[this];
|
|
||||||
});
|
|
||||||
return escape ? esc.text(cur || "").html() : cur;
|
|
||||||
}
|
|
||||||
|
|
||||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
|
||||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Flash an error message briefly. */
|
|
||||||
function showError(message) {
|
|
||||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
|
||||||
.append($(document.createElement('div'))
|
|
||||||
.attr({'class': 'error-message'}).text(message))
|
|
||||||
.appendTo('body')
|
|
||||||
.fadeIn("slow")
|
|
||||||
.delay(2000)
|
|
||||||
.fadeOut("slow");
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Add a link the user uses to open the comments popup. */
|
|
||||||
$.fn.comment = function() {
|
|
||||||
return this.each(function() {
|
|
||||||
var id = $(this).attr('id').substring(1);
|
|
||||||
var count = COMMENT_METADATA[id];
|
|
||||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
|
||||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
|
||||||
var addcls = count == 0 ? ' nocomment' : '';
|
|
||||||
$(this)
|
|
||||||
.append(
|
|
||||||
$(document.createElement('a')).attr({
|
|
||||||
href: '#',
|
|
||||||
'class': 'sphinx-comment-open' + addcls,
|
|
||||||
id: 'ao' + id
|
|
||||||
})
|
|
||||||
.append($(document.createElement('img')).attr({
|
|
||||||
src: image,
|
|
||||||
alt: 'comment',
|
|
||||||
title: title
|
|
||||||
}))
|
|
||||||
.click(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
show($(this).attr('id').substring(2));
|
|
||||||
})
|
|
||||||
)
|
|
||||||
.append(
|
|
||||||
$(document.createElement('a')).attr({
|
|
||||||
href: '#',
|
|
||||||
'class': 'sphinx-comment-close hidden',
|
|
||||||
id: 'ah' + id
|
|
||||||
})
|
|
||||||
.append($(document.createElement('img')).attr({
|
|
||||||
src: opts.closeCommentImage,
|
|
||||||
alt: 'close',
|
|
||||||
title: 'close'
|
|
||||||
}))
|
|
||||||
.click(function(event) {
|
|
||||||
event.preventDefault();
|
|
||||||
hide($(this).attr('id').substring(2));
|
|
||||||
})
|
|
||||||
);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
var opts = {
|
|
||||||
processVoteURL: '/_process_vote',
|
|
||||||
addCommentURL: '/_add_comment',
|
|
||||||
getCommentsURL: '/_get_comments',
|
|
||||||
acceptCommentURL: '/_accept_comment',
|
|
||||||
deleteCommentURL: '/_delete_comment',
|
|
||||||
commentImage: '/static/_static/comment.png',
|
|
||||||
closeCommentImage: '/static/_static/comment-close.png',
|
|
||||||
loadingImage: '/static/_static/ajax-loader.gif',
|
|
||||||
commentBrightImage: '/static/_static/comment-bright.png',
|
|
||||||
upArrow: '/static/_static/up.png',
|
|
||||||
downArrow: '/static/_static/down.png',
|
|
||||||
upArrowPressed: '/static/_static/up-pressed.png',
|
|
||||||
downArrowPressed: '/static/_static/down-pressed.png',
|
|
||||||
voting: false,
|
|
||||||
moderator: false
|
|
||||||
};
|
|
||||||
|
|
||||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
|
||||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
|
||||||
}
|
|
||||||
|
|
||||||
var popupTemplate = '\
|
|
||||||
<div class="sphinx-comments" id="sc<%id%>">\
|
|
||||||
<p class="sort-options">\
|
|
||||||
Sort by:\
|
|
||||||
<a href="#" class="sort-option byrating">best rated</a>\
|
|
||||||
<a href="#" class="sort-option byascage">newest</a>\
|
|
||||||
<a href="#" class="sort-option byage">oldest</a>\
|
|
||||||
</p>\
|
|
||||||
<div class="comment-header">Comments</div>\
|
|
||||||
<div class="comment-loading" id="cn<%id%>">\
|
|
||||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
|
||||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
|
||||||
<div id="ca<%id%>">\
|
|
||||||
<p class="add-a-comment">Add a comment\
|
|
||||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
|
||||||
<div class="comment-markup-box" id="mb<%id%>">\
|
|
||||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
|
||||||
<code>``code``</code>, \
|
|
||||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
|
||||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
|
||||||
<textarea name="comment" cols="80"></textarea>\
|
|
||||||
<p class="propose-button">\
|
|
||||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
|
||||||
Propose a change ▹\
|
|
||||||
</a>\
|
|
||||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
|
||||||
Propose a change ▿\
|
|
||||||
</a>\
|
|
||||||
</p>\
|
|
||||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
|
||||||
spellcheck="false"></textarea>\
|
|
||||||
<input type="submit" value="Add comment" />\
|
|
||||||
<input type="hidden" name="node" value="<%id%>" />\
|
|
||||||
<input type="hidden" name="parent" value="" />\
|
|
||||||
</form>\
|
|
||||||
</div>\
|
|
||||||
</div>';
|
|
||||||
|
|
||||||
var commentTemplate = '\
|
|
||||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
|
||||||
<div class="vote">\
|
|
||||||
<div class="arrow">\
|
|
||||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
|
||||||
<img src="<%upArrow%>" />\
|
|
||||||
</a>\
|
|
||||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
|
||||||
<img src="<%upArrowPressed%>" />\
|
|
||||||
</a>\
|
|
||||||
</div>\
|
|
||||||
<div class="arrow">\
|
|
||||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
|
||||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
|
||||||
</a>\
|
|
||||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
|
||||||
<img src="<%downArrowPressed%>" />\
|
|
||||||
</a>\
|
|
||||||
</div>\
|
|
||||||
</div>\
|
|
||||||
<div class="comment-content">\
|
|
||||||
<p class="tagline comment">\
|
|
||||||
<span class="user-id"><%username%></span>\
|
|
||||||
<span class="rating"><%pretty_rating%></span>\
|
|
||||||
<span class="delta"><%time.delta%></span>\
|
|
||||||
</p>\
|
|
||||||
<div class="comment-text comment"><#text#></div>\
|
|
||||||
<p class="comment-opts comment">\
|
|
||||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
|
||||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
|
||||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
|
||||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
|
||||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
|
||||||
<span id="cm<%id%>" class="moderation hidden">\
|
|
||||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
|
||||||
</span>\
|
|
||||||
</p>\
|
|
||||||
<pre class="proposal" id="pr<%id%>">\
|
|
||||||
<#proposal_diff#>\
|
|
||||||
</pre>\
|
|
||||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
|
||||||
</div>\
|
|
||||||
<div class="clearleft"></div>\
|
|
||||||
</div>\
|
|
||||||
</div>';
|
|
||||||
|
|
||||||
var replyTemplate = '\
|
|
||||||
<li>\
|
|
||||||
<div class="reply-div" id="rd<%id%>">\
|
|
||||||
<form id="rf<%id%>">\
|
|
||||||
<textarea name="comment" cols="80"></textarea>\
|
|
||||||
<input type="submit" value="Add reply" />\
|
|
||||||
<input type="button" value="Cancel" />\
|
|
||||||
<input type="hidden" name="parent" value="<%id%>" />\
|
|
||||||
<input type="hidden" name="node" value="" />\
|
|
||||||
</form>\
|
|
||||||
</div>\
|
|
||||||
</li>';
|
|
||||||
|
|
||||||
$(document).ready(function() {
|
|
||||||
init();
|
|
||||||
});
|
|
||||||
})(jQuery);
|
|
||||||
|
|
||||||
$(document).ready(function() {
|
|
||||||
// add comment anchors for all paragraphs that are commentable
|
|
||||||
$('.sphinx-has-comment').comment();
|
|
||||||
|
|
||||||
// highlight search words in search results
|
|
||||||
$("div.context").each(function() {
|
|
||||||
var params = $.getQueryParameters();
|
|
||||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
|
||||||
var result = $(this);
|
|
||||||
$.each(terms, function() {
|
|
||||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// directly open comment window if requested
|
|
||||||
var anchor = document.location.hash;
|
|
||||||
if (anchor.substring(0, 9) == '#comment-') {
|
|
||||||
$('#ao' + anchor.substring(9)).click();
|
|
||||||
document.location.hash = '#s' + anchor.substring(9);
|
|
||||||
}
|
|
||||||
});
|
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware package" href="com.vmware.html" />
|
<link rel="next" title="com.vmware package" href="com.vmware.html" />
|
||||||
<link rel="prev" title="Welcome to NSX-T SDK’s documentation!" href="index.html" />
|
<link rel="prev" title="Welcome to NSX-T SDK’s documentation!" href="index.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -511,7 +513,7 @@
|
|||||||
<a href="com.vmware.html" class="btn btn-neutral float-right" title="com.vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.html" class="btn btn-neutral float-right" title="com.vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="index.html" class="btn btn-neutral" title="Welcome to NSX-T SDK’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to NSX-T SDK’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -520,7 +522,7 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -537,25 +539,16 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
11570
nsx/nsx/com.vmware.html
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.aaa package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.aaa package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.app_discovery package" href="com.vmware.nsx.app_discovery.html" />
|
<link rel="next" title="com.vmware.nsx.app_discovery package" href="com.vmware.nsx.app_discovery.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx package" href="com.vmware.nsx.html" />
|
<link rel="prev" title="com.vmware.nsx package" href="com.vmware.nsx.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -178,65 +180,58 @@
|
|||||||
<dt id="com.vmware.nsx.aaa.vidm_client.Groups">
|
<dt id="com.vmware.nsx.aaa.vidm_client.Groups">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">Groups</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">Groups</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.aaa.vidm_client.Groups.list">
|
<dt id="com.vmware.nsx.aaa.vidm_client.Groups.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>search_string</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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="descname">list</code><span class="sig-paren">(</span><em>search_string</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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>
|
||||||
<dd><p>Get all the User Groups where vIDM display name matches the search key
|
<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
|
case insensitively. The search key is checked to be a substring of
|
||||||
display name. This is a non paginated API.</p>
|
display name. This is a non paginated API.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>search_string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Search string to search for. (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>search_string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Search string to search for. (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.VidmInfoListResult" title="com.vmware.nsx.model_client.VidmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.VidmInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.VidmInfoListResult" title="com.vmware.nsx.model_client.VidmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.VidmInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.VidmInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.VidmInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -245,14 +240,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.aaa.vidm_client.Search">
|
<dt id="com.vmware.nsx.aaa.vidm_client.Search">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">Search</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">Search</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.aaa.vidm_client.Search.create">
|
<dt id="com.vmware.nsx.aaa.vidm_client.Search.create">
|
||||||
<code class="descname">create</code><span class="sig-paren">(</span><em>search_string</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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="descname">create</code><span class="sig-paren">(</span><em>search_string</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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>
|
||||||
@ -260,51 +252,47 @@ Not Found</p>
|
|||||||
insensitively. The search key is checked to be a substring of name or
|
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
|
given name or family name of user and display name of group. This is a
|
||||||
non paginated API.</p>
|
non paginated API.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>search_string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Search string to search for. (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>search_string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Search string to search for. (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.VidmInfoListResult" title="com.vmware.nsx.model_client.VidmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.VidmInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.VidmInfoListResult" title="com.vmware.nsx.model_client.VidmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.VidmInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.VidmInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.VidmInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -314,28 +302,22 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.aaa.vidm_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.aaa.vidm_client.Users">
|
<dt id="com.vmware.nsx.aaa.vidm_client.Users">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">Users</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.aaa.vidm_client.</code><code class="descname">Users</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.aaa.vidm_client.Users.list">
|
<dt id="com.vmware.nsx.aaa.vidm_client.Users.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>search_string</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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="descname">list</code><span class="sig-paren">(</span><em>search_string</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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>
|
||||||
@ -343,51 +325,47 @@ Not Found</p>
|
|||||||
matches the search key case insensitively. The search key is checked to
|
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
|
be a substring of name or given name or family name. This is a non
|
||||||
paginated API.</p>
|
paginated API.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>search_string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Search string to search for. (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>search_string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Search string to search for. (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.VidmInfoListResult" title="com.vmware.nsx.model_client.VidmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.VidmInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.VidmInfoListResult" title="com.vmware.nsx.model_client.VidmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.VidmInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.VidmInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.VidmInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -406,7 +384,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.app_discovery.html" class="btn btn-neutral float-right" title="com.vmware.nsx.app_discovery package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.app_discovery.html" class="btn btn-neutral float-right" title="com.vmware.nsx.app_discovery package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.html" class="btn btn-neutral" title="com.vmware.nsx package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.html" class="btn btn-neutral float-left" title="com.vmware.nsx package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -415,7 +393,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -432,25 +410,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.app_discovery package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.app_discovery package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.app_discovery.sessions package" href="com.vmware.nsx.app_discovery.sessions.html" />
|
<link rel="next" title="com.vmware.nsx.app_discovery.sessions package" href="com.vmware.nsx.app_discovery.sessions.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.aaa package" href="com.vmware.nsx.aaa.html" />
|
<link rel="prev" title="com.vmware.nsx.aaa package" href="com.vmware.nsx.aaa.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -190,64 +192,57 @@
|
|||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.AppProfiles">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.AppProfiles">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">AppProfiles</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">AppProfiles</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.AppProfiles.list">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.AppProfiles.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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>
|
||||||
<dd><p>Returns the application profiles that was part of the application
|
<dd><p>Returns the application profiles that was part of the application
|
||||||
discovery session | while it was started.</p>
|
discovery session | while it was started.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppProfileListResult" title="com.vmware.nsx.model_client.AppProfileListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppProfileListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppProfileListResult" title="com.vmware.nsx.model_client.AppProfileListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppProfileListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.AppProfileListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.AppProfileListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -256,66 +251,59 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.InstalledApps">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.InstalledApps">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">InstalledApps</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">InstalledApps</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.InstalledApps.list">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.InstalledApps.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>app_profile_id=None</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>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="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>app_profile_id=None</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>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>
|
||||||
<dd><p>Returns the details of the installed apps for the app profile ID in
|
<dd><p>Returns the details of the installed apps for the app profile ID in
|
||||||
that session</p>
|
that session</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>app_profile_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
<li><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>app_profile_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
<li><p><strong>vm_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
<li><strong>vm_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppInfoListResult" title="com.vmware.nsx.model_client.AppInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppInfoListResult" title="com.vmware.nsx.model_client.AppInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.AppInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.AppInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -324,64 +312,57 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.NsGroups">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.NsGroups">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">NsGroups</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">NsGroups</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.NsGroups.list">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.NsGroups.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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>
|
||||||
<dd><p>Returns the ns groups that was part of the application discovery
|
<dd><p>Returns the ns groups that was part of the application discovery
|
||||||
session | while it was started</p>
|
session | while it was started</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NSGroupMetaInfoListResult" title="com.vmware.nsx.model_client.NSGroupMetaInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NSGroupMetaInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NSGroupMetaInfoListResult" title="com.vmware.nsx.model_client.NSGroupMetaInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NSGroupMetaInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NSGroupMetaInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NSGroupMetaInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -390,58 +371,51 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.ReClassify">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.ReClassify">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">ReClassify</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">ReClassify</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.ReClassify.create">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.ReClassify.create">
|
||||||
<code class="descname">create</code><span class="sig-paren">(</span><em>session_id</em>, <em>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="descname">create</code><span class="sig-paren">(</span><em>session_id</em>, <em>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>
|
||||||
<dd><p>Re-classify completed application discovery session against input
|
<dd><p>Re-classify completed application discovery session against input
|
||||||
AppProfiles. If no AppProfiles are specified then we use the previous
|
AppProfiles. If no AppProfiles are specified then we use the previous
|
||||||
AppProfiles of that session.</p>
|
AppProfiles of that session.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>session_reclassification_parameter</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.SessionReclassificationParameter" title="com.vmware.nsx.model_client.SessionReclassificationParameter"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.SessionReclassificationParameter</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>session_reclassification_parameter</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.SessionReclassificationParameter" title="com.vmware.nsx.model_client.SessionReclassificationParameter"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.SessionReclassificationParameter</span></code></a>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppDiscoverySessionResultSummary" title="com.vmware.nsx.model_client.AppDiscoverySessionResultSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppDiscoverySessionResultSummary</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppDiscoverySessionResultSummary" title="com.vmware.nsx.model_client.AppDiscoverySessionResultSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppDiscoverySessionResultSummary</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.AppDiscoverySessionResultSummary</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.AppDiscoverySessionResultSummary</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -451,59 +425,57 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.Summary">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.Summary">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">Summary</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.app_discovery.sessions_client.</code><code class="descname">Summary</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.app_discovery.sessions_client.Summary.get">
|
<dt id="com.vmware.nsx.app_discovery.sessions_client.Summary.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>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="descname">get</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Returns the summary of the application discovery session</p>
|
<dd><p>Returns the summary of the application discovery session</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppDiscoverySessionResultSummary" title="com.vmware.nsx.model_client.AppDiscoverySessionResultSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppDiscoverySessionResultSummary</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppDiscoverySessionResultSummary" title="com.vmware.nsx.model_client.AppDiscoverySessionResultSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppDiscoverySessionResultSummary</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.AppDiscoverySessionResultSummary</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.AppDiscoverySessionResultSummary</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -522,7 +494,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.app_discovery.sessions.html" class="btn btn-neutral float-right" title="com.vmware.nsx.app_discovery.sessions package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.app_discovery.sessions.html" class="btn btn-neutral float-right" title="com.vmware.nsx.app_discovery.sessions package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.aaa.html" class="btn btn-neutral" title="com.vmware.nsx.aaa package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.aaa.html" class="btn btn-neutral float-left" title="com.vmware.nsx.aaa package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -531,7 +503,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -548,25 +520,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.app_discovery.sessions package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.app_discovery.sessions package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.cluster package" href="com.vmware.nsx.cluster.html" />
|
<link rel="next" title="com.vmware.nsx.cluster package" href="com.vmware.nsx.cluster.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.app_discovery package" href="com.vmware.nsx.app_discovery.html" />
|
<link rel="prev" title="com.vmware.nsx.app_discovery package" href="com.vmware.nsx.app_discovery.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -180,64 +182,57 @@
|
|||||||
<dt id="com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members">
|
<dt id="com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_client.</code><code class="descname">Members</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_client.</code><code class="descname">Members</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members.list">
|
<dt id="com.vmware.nsx.app_discovery.sessions.ns_groups_client.Members.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>ns_group_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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="descname">list</code><span class="sig-paren">(</span><em>session_id</em>, <em>ns_group_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>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>
|
||||||
<dd><p>Returns the vms in the ns-group of the application discovery session</p>
|
<dd><p>Returns the vms in the ns-group of the application discovery session</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>ns_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>ns_group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult" title="com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult" title="com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AppDiscoveryVmInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.AppDiscoveryVmInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.AppDiscoveryVmInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -247,14 +242,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.app_discovery.sessions.ns_groups_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.app_discovery.sessions.ns_groups_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -271,7 +263,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.cluster.html" class="btn btn-neutral float-right" title="com.vmware.nsx.cluster package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.cluster.html" class="btn btn-neutral float-right" title="com.vmware.nsx.cluster package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.app_discovery.html" class="btn btn-neutral" title="com.vmware.nsx.app_discovery package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.app_discovery.html" class="btn btn-neutral float-left" title="com.vmware.nsx.app_discovery package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -280,7 +272,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -297,25 +289,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.cluster.nodes package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.cluster.nodes package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.cluster.nodes.network package" href="com.vmware.nsx.cluster.nodes.network.html" />
|
<link rel="next" title="com.vmware.nsx.cluster.nodes.network package" href="com.vmware.nsx.cluster.nodes.network.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.cluster package" href="com.vmware.nsx.cluster.html" />
|
<link rel="prev" title="com.vmware.nsx.cluster package" href="com.vmware.nsx.cluster.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -192,46 +194,47 @@
|
|||||||
<dt id="com.vmware.nsx.cluster.nodes.deployments_client.Status">
|
<dt id="com.vmware.nsx.cluster.nodes.deployments_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.deployments_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.cluster.nodes.deployments_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.cluster.nodes.deployments_client.Status.get">
|
<dt id="com.vmware.nsx.cluster.nodes.deployments_client.Status.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>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="descname">get</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Returns the current deployment or undeployment status for a VM along
|
<dd><p>Returns the current deployment or undeployment status for a VM along
|
||||||
with any other relevant current information, such as error messages.</p>
|
with any other relevant current information, such as error messages.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport" title="com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport" title="com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ClusterNodeVMDeploymentStatusReport</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.ClusterNodeVMDeploymentStatusReport</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.ClusterNodeVMDeploymentStatusReport</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -241,14 +244,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.deployments_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.deployments_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.deployments_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -258,14 +258,11 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces">
|
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.network_client.</code><code class="descname">Interfaces</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.cluster.nodes.network_client.</code><code class="descname">Interfaces</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.cluster.nodes.network_client.Interfaces.GET_SOURCE_CACHED">
|
||||||
<code class="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>
|
<code class="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>
|
||||||
@ -297,45 +294,41 @@ Not Found</td>
|
|||||||
information includes MTU, broadcast and host IP addresses, link and
|
information includes MTU, broadcast and host IP addresses, link and
|
||||||
admin status, MAC address, network mask, and the IP configuration
|
admin status, MAC address, network mask, and the IP configuration
|
||||||
method (static or DHCP).</p>
|
method (static or DHCP).</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceProperties" title="com.vmware.nsx.model_client.NodeInterfaceProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceProperties</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceProperties" title="com.vmware.nsx.model_client.NodeInterfaceProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceProperties</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NodeInterfaceProperties</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeInterfaceProperties</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -345,44 +338,40 @@ Not Found</p>
|
|||||||
about each interface. Interface information includes MTU, broadcast and
|
about each interface. Interface information includes MTU, broadcast and
|
||||||
host IP addresses, link and admin status, MAC address, network mask,
|
host IP addresses, link and admin status, MAC address, network mask,
|
||||||
and the IP configuration method (static or DHCP).</p>
|
and the IP configuration method (static or DHCP).</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfacePropertiesListResult" title="com.vmware.nsx.model_client.NodeInterfacePropertiesListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfacePropertiesListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfacePropertiesListResult" title="com.vmware.nsx.model_client.NodeInterfacePropertiesListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfacePropertiesListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NodeInterfacePropertiesListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeInterfacePropertiesListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -392,14 +381,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.network_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.network_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -409,44 +395,45 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.cluster.nodes.repo_sync_client.Status">
|
<dt id="com.vmware.nsx.cluster.nodes.repo_sync_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.repo_sync_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.cluster.nodes.repo_sync_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.cluster.nodes.repo_sync_client.Status.get">
|
<dt id="com.vmware.nsx.cluster.nodes.repo_sync_client.Status.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>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="descname">get</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><table class="docutils field-list" frame="void" rules="none">
|
<dd><dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RepoSyncStatusReport" title="com.vmware.nsx.model_client.RepoSyncStatusReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RepoSyncStatusReport</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RepoSyncStatusReport" title="com.vmware.nsx.model_client.RepoSyncStatusReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RepoSyncStatusReport</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.RepoSyncStatusReport</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.RepoSyncStatusReport</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -456,14 +443,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.repo_sync_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.repo_sync_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.repo_sync_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -480,7 +464,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.cluster.nodes.network.html" class="btn btn-neutral float-right" title="com.vmware.nsx.cluster.nodes.network package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.cluster.nodes.network.html" class="btn btn-neutral float-right" title="com.vmware.nsx.cluster.nodes.network package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.cluster.html" class="btn btn-neutral" title="com.vmware.nsx.cluster package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.cluster.html" class="btn btn-neutral float-left" title="com.vmware.nsx.cluster package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -489,7 +473,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -506,25 +490,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.cluster.nodes.network package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.cluster.nodes.network package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.dhcp package" href="com.vmware.nsx.dhcp.html" />
|
<link rel="next" title="com.vmware.nsx.dhcp package" href="com.vmware.nsx.dhcp.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.cluster.nodes package" href="com.vmware.nsx.cluster.nodes.html" />
|
<link rel="prev" title="com.vmware.nsx.cluster.nodes package" href="com.vmware.nsx.cluster.nodes.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -182,14 +184,11 @@
|
|||||||
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats">
|
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>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="descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>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>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.cluster.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED">
|
||||||
<code class="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>
|
<code class="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>
|
||||||
@ -209,45 +208,41 @@
|
|||||||
transmitted (tx), and dropped packets; the number of bytes and errors
|
transmitted (tx), and dropped packets; the number of bytes and errors
|
||||||
received and transmitted on the interface; and the number of detected
|
received and transmitted on the interface; and the number of detected
|
||||||
collisions.</p>
|
collisions.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties" title="com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties" title="com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NodeInterfaceStatisticsProperties</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeInterfaceStatisticsProperties</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -257,14 +252,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.cluster.nodes.network.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.cluster.nodes.network.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -281,7 +273,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.dhcp.html" class="btn btn-neutral float-right" title="com.vmware.nsx.dhcp package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.dhcp.html" class="btn btn-neutral float-right" title="com.vmware.nsx.dhcp package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.cluster.nodes.html" class="btn btn-neutral" title="com.vmware.nsx.cluster.nodes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.cluster.nodes.html" class="btn btn-neutral float-left" title="com.vmware.nsx.cluster.nodes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -290,7 +282,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -307,25 +299,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.dns package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.dns package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.fabric package" href="com.vmware.nsx.fabric.html" />
|
<link rel="next" title="com.vmware.nsx.fabric package" href="com.vmware.nsx.fabric.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.dhcp package" href="com.vmware.nsx.dhcp.html" />
|
<link rel="prev" title="com.vmware.nsx.dhcp package" href="com.vmware.nsx.dhcp.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -178,14 +180,11 @@
|
|||||||
<dt id="com.vmware.nsx.dns.forwarders_client.Nslookup">
|
<dt id="com.vmware.nsx.dns.forwarders_client.Nslookup">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.dns.forwarders_client.</code><code class="descname">Nslookup</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dns.forwarders_client.Nslookup" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.dns.forwarders_client.</code><code class="descname">Nslookup</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dns.forwarders_client.Nslookup" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.dns.forwarders_client.Nslookup.get">
|
<dt id="com.vmware.nsx.dns.forwarders_client.Nslookup.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>forwarder_id</em>, <em>address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dns.forwarders_client.Nslookup.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>forwarder_id</em>, <em>address=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dns.forwarders_client.Nslookup.get" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -193,44 +192,40 @@
|
|||||||
address optionally using an specified DNS server. If the address is a
|
address optionally using an specified DNS server. If the address is a
|
||||||
fqdn, nslookup will resolve ip-address with it. If the address is an
|
fqdn, nslookup will resolve ip-address with it. If the address is an
|
||||||
ip-address, do a reverse lookup and answer fqdn(s).</p>
|
ip-address, do a reverse lookup and answer fqdn(s).</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>forwarder_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IP address or FQDN for nslookup (optional)</p></li>
|
||||||
<li><strong>forwarder_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – IP address or FQDN for nslookup (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.DnsAnswer" title="com.vmware.nsx.model_client.DnsAnswer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.DnsAnswer</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.DnsAnswer" title="com.vmware.nsx.model_client.DnsAnswer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.DnsAnswer</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.DnsAnswer</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.DnsAnswer</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -240,14 +235,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.dns.forwarders_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dns.forwarders_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.dns.forwarders_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.dns.forwarders_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -264,7 +256,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.fabric.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.fabric.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.dhcp.html" class="btn btn-neutral" title="com.vmware.nsx.dhcp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.dhcp.html" class="btn btn-neutral float-left" title="com.vmware.nsx.dhcp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -273,7 +265,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -290,25 +282,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.fabric.compute_collections package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.fabric.compute_collections package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.fabric.nodes package" href="com.vmware.nsx.fabric.nodes.html" />
|
<link rel="next" title="com.vmware.nsx.fabric.nodes package" href="com.vmware.nsx.fabric.nodes.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.fabric package" href="com.vmware.nsx.fabric.html" />
|
<link rel="prev" title="com.vmware.nsx.fabric package" href="com.vmware.nsx.fabric.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -180,47 +182,48 @@
|
|||||||
<dt id="com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces">
|
<dt id="com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_collections.network_client.</code><code class="descname">PhysicalInterfaces</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_collections.network_client.</code><code class="descname">PhysicalInterfaces</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces.list">
|
<dt id="com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>cc_ext_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>cc_ext_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_collections.network_client.PhysicalInterfaces.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns list of physical network interfaces for all discovered nodes in
|
<dd><p>Returns list of physical network interfaces for all discovered nodes in
|
||||||
compute collection. Interface information includes PNIC name,
|
compute collection. Interface information includes PNIC name,
|
||||||
hostswitch name it’s attached to(if any) and MAC address.</p>
|
hostswitch name it’s attached to(if any) and MAC address.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>cc_ext_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cc_ext_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult" title="com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult" title="com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ComputeCollectionNetworkInterfacesListResult</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.ComputeCollectionNetworkInterfacesListResult</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.ComputeCollectionNetworkInterfacesListResult</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -230,14 +233,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_collections.network_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_collections.network_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_collections.network_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_collections.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -254,7 +254,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.fabric.nodes.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric.nodes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.fabric.nodes.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric.nodes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.fabric.html" class="btn btn-neutral" title="com.vmware.nsx.fabric package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.fabric.html" class="btn btn-neutral float-left" title="com.vmware.nsx.fabric package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -263,7 +263,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -280,25 +280,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.fabric package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.fabric package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.fabric.compute_collections package" href="com.vmware.nsx.fabric.compute_collections.html" />
|
<link rel="next" title="com.vmware.nsx.fabric.compute_collections package" href="com.vmware.nsx.fabric.compute_collections.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.dns package" href="com.vmware.nsx.dns.html" />
|
<link rel="prev" title="com.vmware.nsx.dns package" href="com.vmware.nsx.dns.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -203,45 +205,46 @@
|
|||||||
<dt id="com.vmware.nsx.fabric.compute_managers_client.State">
|
<dt id="com.vmware.nsx.fabric.compute_managers_client.State">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_managers_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.State" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_managers_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.fabric.compute_managers_client.State.get">
|
<dt id="com.vmware.nsx.fabric.compute_managers_client.State.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>compute_manager_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.State.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>compute_manager_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.State.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get the realized state of a compute manager</p>
|
<dd><p>Get the realized state of a compute manager</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>compute_manager_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>compute_manager_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ConfigurationState" title="com.vmware.nsx.model_client.ConfigurationState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ConfigurationState</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ConfigurationState" title="com.vmware.nsx.model_client.ConfigurationState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ConfigurationState</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.ConfigurationState</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.ConfigurationState</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -250,45 +253,46 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.fabric.compute_managers_client.Status">
|
<dt id="com.vmware.nsx.fabric.compute_managers_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_managers_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_managers_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.fabric.compute_managers_client.Status.get">
|
<dt id="com.vmware.nsx.fabric.compute_managers_client.Status.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>compute_manager_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>compute_manager_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns connection and version information about a compute manager</p>
|
<dd><p>Returns connection and version information about a compute manager</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>compute_manager_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>compute_manager_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ComputeManagerStatus" title="com.vmware.nsx.model_client.ComputeManagerStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ComputeManagerStatus</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ComputeManagerStatus" title="com.vmware.nsx.model_client.ComputeManagerStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ComputeManagerStatus</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.ComputeManagerStatus</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.ComputeManagerStatus</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -298,14 +302,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_managers_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.compute_managers_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.compute_managers_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -315,46 +316,47 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.fabric.nodes_client.Capabilities">
|
<dt id="com.vmware.nsx.fabric.nodes_client.Capabilities">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">Capabilities</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Capabilities" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">Capabilities</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Capabilities" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.fabric.nodes_client.Capabilities.get">
|
<dt id="com.vmware.nsx.fabric.nodes_client.Capabilities.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Capabilities.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Capabilities.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns information about capabilities of a single fabric host node.
|
<dd><p>Returns information about capabilities of a single fabric host node.
|
||||||
Edge nodes do not have capabilities.</p>
|
Edge nodes do not have capabilities.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeCapabilitiesResult" title="com.vmware.nsx.model_client.NodeCapabilitiesResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeCapabilitiesResult</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeCapabilitiesResult" title="com.vmware.nsx.model_client.NodeCapabilitiesResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeCapabilitiesResult</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.NodeCapabilitiesResult</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeCapabilitiesResult</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -363,45 +365,46 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.fabric.nodes_client.Modules">
|
<dt id="com.vmware.nsx.fabric.nodes_client.Modules">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">Modules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Modules" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">Modules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Modules" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.fabric.nodes_client.Modules.get">
|
<dt id="com.vmware.nsx.fabric.nodes_client.Modules.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Modules.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Modules.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get the module details of a Fabric Node</p>
|
<dd><p>Get the module details of a Fabric Node</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.SoftwareModuleResult" title="com.vmware.nsx.model_client.SoftwareModuleResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.SoftwareModuleResult</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.SoftwareModuleResult" title="com.vmware.nsx.model_client.SoftwareModuleResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.SoftwareModuleResult</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.SoftwareModuleResult</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.SoftwareModuleResult</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -410,47 +413,48 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.fabric.nodes_client.State">
|
<dt id="com.vmware.nsx.fabric.nodes_client.State">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.State" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.fabric.nodes_client.State.get">
|
<dt id="com.vmware.nsx.fabric.nodes_client.State.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.State.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.State.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>For edge nodes, returns the current install state when deployment is in
|
<dd><p>For edge nodes, returns the current install state when deployment is in
|
||||||
progress, NODE_READY when deployment is complete and the failure state
|
progress, NODE_READY when deployment is complete and the failure state
|
||||||
when deployment has failed.</p>
|
when deployment has failed.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ConfigurationState" title="com.vmware.nsx.model_client.ConfigurationState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ConfigurationState</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ConfigurationState" title="com.vmware.nsx.model_client.ConfigurationState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ConfigurationState</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.ConfigurationState</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.ConfigurationState</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -459,14 +463,11 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.fabric.nodes_client.Status">
|
<dt id="com.vmware.nsx.fabric.nodes_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.fabric.nodes_client.Status.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.fabric.nodes_client.Status.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -487,44 +488,40 @@ node (host or edge). Note that the LCP connectivity status remains down
|
|||||||
until after the fabric node has been added as a transpot node and the
|
until after the fabric node has been added as a transpot node and the
|
||||||
NSX host switch has been successfully installed. See POST
|
NSX host switch has been successfully installed. See POST
|
||||||
/api/v1/transport-nodes.</p>
|
/api/v1/transport-nodes.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeStatus" title="com.vmware.nsx.model_client.NodeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeStatus</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeStatus" title="com.vmware.nsx.model_client.NodeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeStatus</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NodeStatus</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeStatus</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -532,33 +529,37 @@ Not Found</p>
|
|||||||
<code class="descname">getall</code><span class="sig-paren">(</span><em>node_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Status.getall" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">getall</code><span class="sig-paren">(</span><em>node_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.Status.getall" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns connectivity, heartbeat, and version information about all
|
<dd><p>Returns connectivity, heartbeat, and version information about all
|
||||||
fabric nodes (host or edge).</p>
|
fabric nodes (host or edge).</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>node_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of requested Nodes. (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of requested Nodes. (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeStatusListResult" title="com.vmware.nsx.model_client.NodeStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeStatusListResult</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeStatusListResult" title="com.vmware.nsx.model_client.NodeStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeStatusListResult</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.NodeStatusListResult</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeStatusListResult</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -568,14 +569,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -592,7 +590,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.fabric.compute_collections.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric.compute_collections package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.fabric.compute_collections.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric.compute_collections package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.dns.html" class="btn btn-neutral" title="com.vmware.nsx.dns package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.dns.html" class="btn btn-neutral float-left" title="com.vmware.nsx.dns package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -601,7 +599,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -618,25 +616,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.fabric.nodes package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.fabric.nodes package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.fabric.nodes.network package" href="com.vmware.nsx.fabric.nodes.network.html" />
|
<link rel="next" title="com.vmware.nsx.fabric.nodes.network package" href="com.vmware.nsx.fabric.nodes.network.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.fabric.compute_collections package" href="com.vmware.nsx.fabric.compute_collections.html" />
|
<link rel="prev" title="com.vmware.nsx.fabric.compute_collections package" href="com.vmware.nsx.fabric.compute_collections.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -192,14 +194,11 @@
|
|||||||
<dt id="com.vmware.nsx.fabric.nodes.network_client.Interfaces">
|
<dt id="com.vmware.nsx.fabric.nodes.network_client.Interfaces">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network_client.</code><code class="descname">Interfaces</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network_client.Interfaces" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network_client.</code><code class="descname">Interfaces</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.fabric.nodes.network_client.Interfaces.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.fabric.nodes.network_client.Interfaces.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network_client.Interfaces.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network_client.Interfaces.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -231,45 +230,41 @@
|
|||||||
information includes MTU, broadcast and host IP addresses, link and
|
information includes MTU, broadcast and host IP addresses, link and
|
||||||
admin status, MAC address, network mask, and the IP configuration
|
admin status, MAC address, network mask, and the IP configuration
|
||||||
method (static or DHCP).</p>
|
method (static or DHCP).</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceProperties" title="com.vmware.nsx.model_client.NodeInterfaceProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceProperties</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceProperties" title="com.vmware.nsx.model_client.NodeInterfaceProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceProperties</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NodeInterfaceProperties</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeInterfaceProperties</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -279,44 +274,40 @@ Not Found</p>
|
|||||||
about each interface. Interface information includes MTU, broadcast and
|
about each interface. Interface information includes MTU, broadcast and
|
||||||
host IP addresses, link and admin status, MAC address, network mask,
|
host IP addresses, link and admin status, MAC address, network mask,
|
||||||
and the IP configuration method (static or DHCP).</p>
|
and the IP configuration method (static or DHCP).</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfacePropertiesListResult" title="com.vmware.nsx.model_client.NodeInterfacePropertiesListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfacePropertiesListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfacePropertiesListResult" title="com.vmware.nsx.model_client.NodeInterfacePropertiesListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfacePropertiesListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NodeInterfacePropertiesListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeInterfacePropertiesListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -326,14 +317,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -350,7 +338,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.fabric.nodes.network.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric.nodes.network package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.fabric.nodes.network.html" class="btn btn-neutral float-right" title="com.vmware.nsx.fabric.nodes.network package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.fabric.compute_collections.html" class="btn btn-neutral" title="com.vmware.nsx.fabric.compute_collections package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.fabric.compute_collections.html" class="btn btn-neutral float-left" title="com.vmware.nsx.fabric.compute_collections package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -359,7 +347,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -376,25 +364,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.fabric.nodes.network package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.fabric.nodes.network package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.firewall package" href="com.vmware.nsx.firewall.html" />
|
<link rel="next" title="com.vmware.nsx.firewall package" href="com.vmware.nsx.firewall.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.fabric.nodes package" href="com.vmware.nsx.fabric.nodes.html" />
|
<link rel="prev" title="com.vmware.nsx.fabric.nodes package" href="com.vmware.nsx.fabric.nodes.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -182,14 +184,11 @@
|
|||||||
<dt id="com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats">
|
<dt id="com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network.interfaces_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network.interfaces_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network.interfaces_client.Stats.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -209,45 +208,41 @@
|
|||||||
transmitted (tx), and dropped packets; the number of bytes and errors
|
transmitted (tx), and dropped packets; the number of bytes and errors
|
||||||
received and transmitted on the interface; and the number of detected
|
received and transmitted on the interface; and the number of detected
|
||||||
collisions.</p>
|
collisions.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties" title="com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties" title="com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NodeInterfaceStatisticsProperties</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeInterfaceStatisticsProperties</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -257,14 +252,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.nodes.network.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.fabric.nodes.network.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.fabric.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -281,7 +273,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.firewall.html" class="btn btn-neutral float-right" title="com.vmware.nsx.firewall package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.firewall.html" class="btn btn-neutral float-right" title="com.vmware.nsx.firewall package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.fabric.nodes.html" class="btn btn-neutral" title="com.vmware.nsx.fabric.nodes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.fabric.nodes.html" class="btn btn-neutral float-left" title="com.vmware.nsx.fabric.nodes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -290,7 +282,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -307,25 +299,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.firewall package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.firewall package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.firewall.sections package" href="com.vmware.nsx.firewall.sections.html" />
|
<link rel="next" title="com.vmware.nsx.firewall.sections package" href="com.vmware.nsx.firewall.sections.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.fabric.nodes.network package" href="com.vmware.nsx.fabric.nodes.network.html" />
|
<link rel="prev" title="com.vmware.nsx.fabric.nodes.network package" href="com.vmware.nsx.fabric.nodes.network.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -190,57 +192,50 @@
|
|||||||
<dt id="com.vmware.nsx.firewall.rules_client.State">
|
<dt id="com.vmware.nsx.firewall.rules_client.State">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.rules_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.rules_client.State" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.rules_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.rules_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.firewall.rules_client.State.get">
|
<dt id="com.vmware.nsx.firewall.rules_client.State.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>rule_id</em>, <em>barrier_id=None</em>, <em>request_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.rules_client.State.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>rule_id</em>, <em>barrier_id=None</em>, <em>request_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.rules_client.State.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Return realized state information of a firewall rule.</p>
|
<dd><p>Return realized state information of a firewall rule.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>barrier_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>request_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Realization request ID (optional)</p></li>
|
||||||
<li><strong>barrier_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>request_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Realization request ID (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RuleState" title="com.vmware.nsx.model_client.RuleState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RuleState</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RuleState" title="com.vmware.nsx.model_client.RuleState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RuleState</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.RuleState</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.RuleState</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -250,14 +245,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.rules_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.rules_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.rules_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.rules_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -267,14 +259,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.firewall.sections_client.Rules">
|
<dt id="com.vmware.nsx.firewall.sections_client.Rules">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">Rules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">Rules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.firewall.sections_client.Rules.CREATEMULTIPLE_OPERATION_AFTER">
|
<dt id="com.vmware.nsx.firewall.sections_client.Rules.CREATEMULTIPLE_OPERATION_AFTER">
|
||||||
<code class="descname">CREATEMULTIPLE_OPERATION_AFTER</code><em class="property"> = 'insert_after'</em><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules.CREATEMULTIPLE_OPERATION_AFTER" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">CREATEMULTIPLE_OPERATION_AFTER</code><em class="property"> = 'insert_after'</em><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules.CREATEMULTIPLE_OPERATION_AFTER" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -369,48 +358,44 @@ overwriting stale content to firewall section. If a concurrent update
|
|||||||
is performed, HTTP response code 409 will be returned to the client
|
is performed, HTTP response code 409 will be returned to the client
|
||||||
operating on stale data. That client should retrieve the firewall
|
operating on stale data. That client should retrieve the firewall
|
||||||
section again and re-apply its update.</p>
|
section again and re-apply its update.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>firewall_rule</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the anchor rule or section. This is a required field
|
||||||
<li><strong>firewall_rule</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a>) – (required)</li>
|
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the anchor rule or section. This is a required field
|
|
||||||
in case operation like ‘insert_before’ and ‘insert_after’.
|
in case operation like ‘insert_before’ and ‘insert_after’.
|
||||||
(optional)</li>
|
(optional)</p></li>
|
||||||
<li><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</li>
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallRule</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallRule</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -424,48 +409,44 @@ overwriting stale contents to firewall section. If a concurrent update
|
|||||||
is performed, HTTP response code 409 will be returned to the client
|
is performed, HTTP response code 409 will be returned to the client
|
||||||
operating on stale data. That client should retrieve the firewall
|
operating on stale data. That client should retrieve the firewall
|
||||||
section again and re-apply its update.</p>
|
section again and re-apply its update.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>firewall_rule_list</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRuleList" title="com.vmware.nsx.model_client.FirewallRuleList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRuleList</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the anchor rule or section. This is a required field
|
||||||
<li><strong>firewall_rule_list</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRuleList" title="com.vmware.nsx.model_client.FirewallRuleList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRuleList</span></code></a>) – (required)</li>
|
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the anchor rule or section. This is a required field
|
|
||||||
in case operation like ‘insert_before’ and ‘insert_after’.
|
in case operation like ‘insert_before’ and ‘insert_after’.
|
||||||
(optional)</li>
|
(optional)</p></li>
|
||||||
<li><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</li>
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRuleList" title="com.vmware.nsx.model_client.FirewallRuleList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRuleList</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRuleList" title="com.vmware.nsx.model_client.FirewallRuleList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRuleList</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallRuleList</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallRuleList</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -478,143 +459,131 @@ overwriting stale contents to firewall section. If a concurrent update
|
|||||||
is performed, HTTP response code 409 will be returned to the client
|
is performed, HTTP response code 409 will be returned to the client
|
||||||
operating on stale data. That client should retrieve the firewall
|
operating on stale data. That client should retrieve the firewall
|
||||||
section again and re-apply its update.</p>
|
section again and re-apply its update.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.firewall.sections_client.Rules.get">
|
<dt id="com.vmware.nsx.firewall.sections_client.Rules.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>section_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>section_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Return existing firewall rule information in a firewall section.</p>
|
<dd><p>Return existing firewall rule information in a firewall section.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallRule</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallRule</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.firewall.sections_client.Rules.list">
|
<dt id="com.vmware.nsx.firewall.sections_client.Rules.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>section_id</em>, <em>applied_tos=None</em>, <em>cursor=None</em>, <em>destinations=None</em>, <em>filter_type=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>search_invalid_references=None</em>, <em>services=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>sources=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>section_id</em>, <em>applied_tos=None</em>, <em>cursor=None</em>, <em>destinations=None</em>, <em>filter_type=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>search_invalid_references=None</em>, <em>services=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>sources=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Rules.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Return all firewall rule(s) information for a given firewall section.</p>
|
<dd><p>Return all firewall rule(s) information for a given firewall section.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>applied_tos</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – AppliedTo’s referenced by this section or section’s Distributed
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
Service Rules . (optional)</p></li>
|
||||||
<li><strong>applied_tos</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – AppliedTo’s referenced by this section or section’s Distributed
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
Service Rules . (optional)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>destinations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Destinations referenced by this section’s Distributed Service Rules
|
||||||
by current result page) (optional)</li>
|
. (optional)</p></li>
|
||||||
<li><strong>destinations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Destinations referenced by this section’s Distributed Service Rules
|
<li><p><strong>filter_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filter type (optional, default to FILTER)</p></li>
|
||||||
. (optional)</li>
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
<li><strong>filter_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filter type (optional, default to FILTER)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>search_invalid_references</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Return invalid references in results. (optional, default to false)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSService referenced by this section’s Distributed Service Rules .
|
||||||
<li><strong>search_invalid_references</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Return invalid references in results. (optional, default to false)</li>
|
(optional)</p></li>
|
||||||
<li><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – NSService referenced by this section’s Distributed Service Rules .
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
(optional)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
<li><p><strong>sources</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Sources referenced by this section’s Distributed Service Rules .
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
(optional)</p></li>
|
||||||
<li><strong>sources</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Sources referenced by this section’s Distributed Service Rules .
|
|
||||||
(optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRuleListResult" title="com.vmware.nsx.model_client.FirewallRuleListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRuleListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRuleListResult" title="com.vmware.nsx.model_client.FirewallRuleListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRuleListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallRuleListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallRuleListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -628,49 +597,45 @@ overwriting stale contents to firewall section. If a concurrent update
|
|||||||
is performed, HTTP response code 409 will be returned to the client
|
is performed, HTTP response code 409 will be returned to the client
|
||||||
operating on stale data. That client should retrieve the firewall
|
operating on stale data. That client should retrieve the firewall
|
||||||
section again and re-apply its update.</p>
|
section again and re-apply its update.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>firewall_rule</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the anchor rule or section. This is a required field
|
||||||
<li><strong>firewall_rule</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a>) – (required)</li>
|
|
||||||
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the anchor rule or section. This is a required field
|
|
||||||
in case operation like ‘insert_before’ and ‘insert_after’.
|
in case operation like ‘insert_before’ and ‘insert_after’.
|
||||||
(optional)</li>
|
(optional)</p></li>
|
||||||
<li><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</li>
|
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</p></li>
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallRule</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallRule</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -683,45 +648,41 @@ to prevent overwriting stale contents to firewall section. If a
|
|||||||
concurrent update is performed, HTTP response code 409 will be returned
|
concurrent update is performed, HTTP response code 409 will be returned
|
||||||
to the client operating on stale data. That client should retrieve the
|
to the client operating on stale data. That client should retrieve the
|
||||||
firewall section again and re-apply its update.</p>
|
firewall section again and re-apply its update.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>firewall_rule</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>firewall_rule</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallRule" title="com.vmware.nsx.model_client.FirewallRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallRule</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallRule</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallRule</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -730,57 +691,50 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.firewall.sections_client.State">
|
<dt id="com.vmware.nsx.firewall.sections_client.State">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.State" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">State</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.firewall.sections_client.State.get">
|
<dt id="com.vmware.nsx.firewall.sections_client.State.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>section_id</em>, <em>barrier_id=None</em>, <em>request_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.State.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>section_id</em>, <em>barrier_id=None</em>, <em>request_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.State.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Return realized state information of a firewall section.</p>
|
<dd><p>Return realized state information of a firewall section.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>barrier_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>request_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Realization request ID (optional)</p></li>
|
||||||
<li><strong>barrier_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>request_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Realization request ID (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallSectionState" title="com.vmware.nsx.model_client.FirewallSectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallSectionState</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallSectionState" title="com.vmware.nsx.model_client.FirewallSectionState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallSectionState</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallSectionState</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallSectionState</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -790,28 +744,22 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.firewall.sections_client.Summary">
|
<dt id="com.vmware.nsx.firewall.sections_client.Summary">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">Summary</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Summary" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections_client.</code><code class="descname">Summary</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.firewall.sections_client.Summary.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.firewall.sections_client.Summary.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Summary.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Summary.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -829,33 +777,37 @@ Not Found</p>
|
|||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Summary.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections_client.Summary.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>List the summary of number of sections and number of rules for each
|
<dd><p>List the summary of number of sections and number of rules for each
|
||||||
firewall category (L2DFW, L3DFW).</p>
|
firewall category (L2DFW, L3DFW).</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallSectionsSummaryList" title="com.vmware.nsx.model_client.FirewallSectionsSummaryList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallSectionsSummaryList</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallSectionsSummaryList" title="com.vmware.nsx.model_client.FirewallSectionsSummaryList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallSectionsSummaryList</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.FirewallSectionsSummaryList</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallSectionsSummaryList</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -874,7 +826,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.firewall.sections.html" class="btn btn-neutral float-right" title="com.vmware.nsx.firewall.sections package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.firewall.sections.html" class="btn btn-neutral float-right" title="com.vmware.nsx.firewall.sections package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.fabric.nodes.network.html" class="btn btn-neutral" title="com.vmware.nsx.fabric.nodes.network package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.fabric.nodes.network.html" class="btn btn-neutral float-left" title="com.vmware.nsx.fabric.nodes.network package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -883,7 +835,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -900,25 +852,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.firewall.sections package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.firewall.sections package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.lldp package" href="com.vmware.nsx.lldp.html" />
|
<link rel="next" title="com.vmware.nsx.lldp package" href="com.vmware.nsx.lldp.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.firewall package" href="com.vmware.nsx.firewall.html" />
|
<link rel="prev" title="com.vmware.nsx.firewall package" href="com.vmware.nsx.firewall.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -180,14 +182,11 @@
|
|||||||
<dt id="com.vmware.nsx.firewall.sections.rules_client.Stats">
|
<dt id="com.vmware.nsx.firewall.sections.rules_client.Stats">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections.rules_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections.rules_client.Stats" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections.rules_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections.rules_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.firewall.sections.rules_client.Stats.GET_0_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.firewall.sections.rules_client.Stats.GET_0_SOURCE_CACHED">
|
||||||
<code class="descname">GET_0_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.firewall.sections.rules_client.Stats.GET_0_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_0_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.firewall.sections.rules_client.Stats.GET_0_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -225,44 +224,40 @@ statistics like maximum popularity index, maximum session count and
|
|||||||
total session count are computed with lower frequency compared to
|
total session count are computed with lower frequency compared to
|
||||||
individual generic rule statistics, hence they may have a computation
|
individual generic rule statistics, hence they may have a computation
|
||||||
delay up to 15 minutes to reflect in response to this API.</p>
|
delay up to 15 minutes to reflect in response to this API.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallStatsList" title="com.vmware.nsx.model_client.FirewallStatsList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallStatsList</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallStatsList" title="com.vmware.nsx.model_client.FirewallStatsList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallStatsList</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallStatsList</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallStatsList</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -278,45 +273,41 @@ statistics like maximum popularity index, maximum session count and
|
|||||||
total session count are computed with lower frequency compared to
|
total session count are computed with lower frequency compared to
|
||||||
individual generic rule statistics, hence they may have a computation
|
individual generic rule statistics, hence they may have a computation
|
||||||
delay up to 15 minutes to reflect in response to this API.</p>
|
delay up to 15 minutes to reflect in response to this API.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>section_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallStats" title="com.vmware.nsx.model_client.FirewallStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallStats</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.FirewallStats" title="com.vmware.nsx.model_client.FirewallStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.FirewallStats</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.FirewallStats</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.FirewallStats</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -326,14 +317,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections.rules_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections.rules_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.firewall.sections.rules_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.firewall.sections.rules_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -350,7 +338,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.lldp.html" class="btn btn-neutral float-right" title="com.vmware.nsx.lldp package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.lldp.html" class="btn btn-neutral float-right" title="com.vmware.nsx.lldp package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.firewall.html" class="btn btn-neutral" title="com.vmware.nsx.firewall package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.firewall.html" class="btn btn-neutral float-left" title="com.vmware.nsx.firewall package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -359,7 +347,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -376,25 +364,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.lldp package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.lldp package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.loadbalancer package" href="com.vmware.nsx.loadbalancer.html" />
|
<link rel="next" title="com.vmware.nsx.loadbalancer package" href="com.vmware.nsx.loadbalancer.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.firewall.sections package" href="com.vmware.nsx.firewall.sections.html" />
|
<link rel="prev" title="com.vmware.nsx.firewall.sections package" href="com.vmware.nsx.firewall.sections.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -178,89 +180,86 @@
|
|||||||
<dt id="com.vmware.nsx.lldp.transport_nodes_client.Interfaces">
|
<dt id="com.vmware.nsx.lldp.transport_nodes_client.Interfaces">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.lldp.transport_nodes_client.</code><code class="descname">Interfaces</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_nodes_client.Interfaces" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.lldp.transport_nodes_client.</code><code class="descname">Interfaces</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_nodes_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.lldp.transport_nodes_client.Interfaces.get">
|
<dt id="com.vmware.nsx.lldp.transport_nodes_client.Interfaces.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em>, <em>interface_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_nodes_client.Interfaces.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em>, <em>interface_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_nodes_client.Interfaces.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Read LLDP Neighbor Properties</p>
|
<dd><p>Read LLDP Neighbor Properties</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of transport node (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Interface name to read (required)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of transport node (required)</li>
|
|
||||||
<li><strong>interface_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Interface name to read (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InterfaceNeighborProperties" title="com.vmware.nsx.model_client.InterfaceNeighborProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InterfaceNeighborProperties</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InterfaceNeighborProperties" title="com.vmware.nsx.model_client.InterfaceNeighborProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InterfaceNeighborProperties</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.InterfaceNeighborProperties</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.InterfaceNeighborProperties</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.lldp.transport_nodes_client.Interfaces.list">
|
<dt id="com.vmware.nsx.lldp.transport_nodes_client.Interfaces.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_nodes_client.Interfaces.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>node_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_nodes_client.Interfaces.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>List LLDP Neighbor Properties</p>
|
<dd><p>List LLDP Neighbor Properties</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of transport node (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of transport node (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult" title="com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult" title="com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InterfaceNeighborPropertyListResult</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.InterfaceNeighborPropertyListResult</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.InterfaceNeighborPropertyListResult</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -270,14 +269,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.lldp.transport_nodes_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_nodes_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.lldp.transport_nodes_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.lldp.transport_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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -294,7 +290,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.loadbalancer.html" class="btn btn-neutral float-right" title="com.vmware.nsx.loadbalancer package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.loadbalancer.html" class="btn btn-neutral float-right" title="com.vmware.nsx.loadbalancer package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.firewall.sections.html" class="btn btn-neutral" title="com.vmware.nsx.firewall.sections package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.firewall.sections.html" class="btn btn-neutral float-left" title="com.vmware.nsx.firewall.sections package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -303,7 +299,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -320,25 +316,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.loadbalancer package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.loadbalancer package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.loadbalancer.services package" href="com.vmware.nsx.loadbalancer.services.html" />
|
<link rel="next" title="com.vmware.nsx.loadbalancer.services package" href="com.vmware.nsx.loadbalancer.services.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.lldp package" href="com.vmware.nsx.lldp.html" />
|
<link rel="prev" title="com.vmware.nsx.lldp package" href="com.vmware.nsx.lldp.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -191,14 +193,11 @@
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.DebugInfo">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.DebugInfo">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">DebugInfo</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.DebugInfo" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">DebugInfo</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.DebugInfo" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.DebugInfo.get">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.DebugInfo.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.DebugInfo.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.DebugInfo.get" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -207,33 +206,37 @@ troubleshooting. 1) Load balancer service 2) Load balancer associated
|
|||||||
virtual servers 3) Load balancer associated pools 4) Load balancer
|
virtual servers 3) Load balancer associated pools 4) Load balancer
|
||||||
associated profiles such as persistence, SSL, application. 5) Load
|
associated profiles such as persistence, SSL, application. 5) Load
|
||||||
balancer associated monitors 6) Load balancer associated rules</p>
|
balancer associated monitors 6) Load balancer associated rules</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceDebugInfo" title="com.vmware.nsx.model_client.LbServiceDebugInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceDebugInfo</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceDebugInfo" title="com.vmware.nsx.model_client.LbServiceDebugInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceDebugInfo</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.LbServiceDebugInfo</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbServiceDebugInfo</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -242,14 +245,11 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Statistics">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Statistics">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Statistics" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Statistics.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Statistics.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -266,44 +266,40 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Statistics.get">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Statistics.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the statistics of the given load balancer service.</p>
|
<dd><p>Returns the statistics of the given load balancer service.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceStatistics" title="com.vmware.nsx.model_client.LbServiceStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceStatistics</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceStatistics" title="com.vmware.nsx.model_client.LbServiceStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceStatistics</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbServiceStatistics</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbServiceStatistics</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -312,14 +308,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Status">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Status.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Status.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -336,44 +329,40 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Status.get">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Status.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the status of the given load balancer service.</p>
|
<dd><p>Returns the status of the given load balancer service.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceStatus" title="com.vmware.nsx.model_client.LbServiceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceStatus</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceStatus" title="com.vmware.nsx.model_client.LbServiceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceStatus</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbServiceStatus</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbServiceStatus</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -383,60 +372,58 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Usage">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Usage">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">Usage</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Usage" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services_client.</code><code class="descname">Usage</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Usage" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services_client.Usage.get">
|
<dt id="com.vmware.nsx.loadbalancer.services_client.Usage.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Usage.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services_client.Usage.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>API to fetch the capacity and current usage of the given load balancer
|
<dd><p>API to fetch the capacity and current usage of the given load balancer
|
||||||
service.</p>
|
service.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceUsage" title="com.vmware.nsx.model_client.LbServiceUsage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceUsage</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbServiceUsage" title="com.vmware.nsx.model_client.LbServiceUsage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbServiceUsage</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.LbServiceUsage</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbServiceUsage</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -448,62 +435,55 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols">
|
<dt id="com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.ssl_client.</code><code class="descname">CiphersAndProtocols</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.ssl_client.</code><code class="descname">CiphersAndProtocols</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols.list">
|
<dt id="com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.ssl_client.CiphersAndProtocols.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Retrieve a list of supported SSL ciphers and protocols.</p>
|
<dd><p>Retrieve a list of supported SSL ciphers and protocols.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult" title="com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult" title="com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbSslCipherAndProtocolListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbSslCipherAndProtocolListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbSslCipherAndProtocolListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -513,14 +493,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.ssl_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.ssl_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.ssl_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.ssl_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -537,7 +514,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.loadbalancer.services.html" class="btn btn-neutral float-right" title="com.vmware.nsx.loadbalancer.services package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.loadbalancer.services.html" class="btn btn-neutral float-right" title="com.vmware.nsx.loadbalancer.services package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.lldp.html" class="btn btn-neutral" title="com.vmware.nsx.lldp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.lldp.html" class="btn btn-neutral float-left" title="com.vmware.nsx.lldp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -546,7 +523,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -563,25 +540,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.loadbalancer.services package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.loadbalancer.services package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.logical_router_ports package" href="com.vmware.nsx.logical_router_ports.html" />
|
<link rel="next" title="com.vmware.nsx.logical_router_ports package" href="com.vmware.nsx.logical_router_ports.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.loadbalancer package" href="com.vmware.nsx.loadbalancer.html" />
|
<link rel="prev" title="com.vmware.nsx.loadbalancer package" href="com.vmware.nsx.loadbalancer.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -180,14 +182,11 @@
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Statistics">
|
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Statistics">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.pools_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Statistics" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.pools_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Statistics.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Statistics.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -217,45 +216,41 @@
|
|||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>pool_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>pool_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the statistics of the given load balancer pool by given load
|
<dd><p>Returns the statistics of the given load balancer pool by given load
|
||||||
balancer serives id and load balancer pool id.</p>
|
balancer serives id and load balancer pool id.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatistics" title="com.vmware.nsx.model_client.LbPoolStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatistics</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatistics" title="com.vmware.nsx.model_client.LbPoolStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatistics</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbPoolStatistics</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbPoolStatistics</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -263,44 +258,40 @@ Not Found</p>
|
|||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Statistics.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Statistics.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the statistics list of load balancer pools in given load
|
<dd><p>Returns the statistics list of load balancer pools in given load
|
||||||
balancer service.</p>
|
balancer service.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatisticsListResult" title="com.vmware.nsx.model_client.LbPoolStatisticsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatisticsListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatisticsListResult" title="com.vmware.nsx.model_client.LbPoolStatisticsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatisticsListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbPoolStatisticsListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbPoolStatisticsListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -309,14 +300,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Status">
|
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.pools_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.pools_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Status.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.loadbalancer.services.pools_client.Status.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -346,45 +334,41 @@ Not Found</p>
|
|||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>pool_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>pool_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the status of the given load balancer pool by given load
|
<dd><p>Returns the status of the given load balancer pool by given load
|
||||||
balancer serives id and load balancer pool id.</p>
|
balancer serives id and load balancer pool id.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatus" title="com.vmware.nsx.model_client.LbPoolStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatus</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatus" title="com.vmware.nsx.model_client.LbPoolStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatus</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbPoolStatus</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbPoolStatus</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -392,44 +376,40 @@ Not Found</p>
|
|||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the status list of load balancer pools in given load balancer
|
<dd><p>Returns the status list of load balancer pools in given load balancer
|
||||||
service.</p>
|
service.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatusListResult" title="com.vmware.nsx.model_client.LbPoolStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatusListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbPoolStatusListResult" title="com.vmware.nsx.model_client.LbPoolStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbPoolStatusListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbPoolStatusListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbPoolStatusListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -439,14 +419,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.pools_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.pools_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.pools_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -456,14 +433,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics">
|
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.virtual_servers_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.virtual_servers_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -493,45 +467,41 @@ Not Found</p>
|
|||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>virtual_server_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>virtual_server_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the statistics of the load balancer virtual server by given
|
<dd><p>Returns the statistics of the load balancer virtual server by given
|
||||||
load balancer serives id and load balancer virtual server id.</p>
|
load balancer serives id and load balancer virtual server id.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>virtual_server_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>virtual_server_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatistics" title="com.vmware.nsx.model_client.LbVirtualServerStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatistics</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatistics" title="com.vmware.nsx.model_client.LbVirtualServerStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatistics</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbVirtualServerStatistics</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbVirtualServerStatistics</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -539,44 +509,40 @@ Not Found</p>
|
|||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Statistics.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the statistics list of virtual servers in given load balancer
|
<dd><p>Returns the statistics list of virtual servers in given load balancer
|
||||||
service.</p>
|
service.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult" title="com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult" title="com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatisticsListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbVirtualServerStatisticsListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbVirtualServerStatisticsListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -585,14 +551,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status">
|
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.virtual_servers_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.virtual_servers_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -622,45 +585,41 @@ Not Found</p>
|
|||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>virtual_server_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>virtual_server_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the status of the virtual server by given load balancer serives
|
<dd><p>Returns the status of the virtual server by given load balancer serives
|
||||||
id and load balancer virtual server id.</p>
|
id and load balancer virtual server id.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>virtual_server_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>virtual_server_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatus" title="com.vmware.nsx.model_client.LbVirtualServerStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatus</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatus" title="com.vmware.nsx.model_client.LbVirtualServerStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatus</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbVirtualServerStatus</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbVirtualServerStatus</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -668,44 +627,40 @@ Not Found</p>
|
|||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the status list of virtual servers in given load balancer
|
<dd><p>Returns the status list of virtual servers in given load balancer
|
||||||
service.</p>
|
service.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatusListResult" title="com.vmware.nsx.model_client.LbVirtualServerStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatusListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LbVirtualServerStatusListResult" title="com.vmware.nsx.model_client.LbVirtualServerStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LbVirtualServerStatusListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LbVirtualServerStatusListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LbVirtualServerStatusListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -715,14 +670,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.virtual_servers_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_servers_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.loadbalancer.services.virtual_servers_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.loadbalancer.services.virtual_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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -739,7 +691,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.logical_router_ports.html" class="btn btn-neutral float-right" title="com.vmware.nsx.logical_router_ports package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.logical_router_ports.html" class="btn btn-neutral float-right" title="com.vmware.nsx.logical_router_ports package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.loadbalancer.html" class="btn btn-neutral" title="com.vmware.nsx.loadbalancer package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.loadbalancer.html" class="btn btn-neutral float-left" title="com.vmware.nsx.loadbalancer package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -748,7 +700,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -765,25 +717,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.logical_router_ports package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.logical_router_ports package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.logical_routers package" href="com.vmware.nsx.logical_routers.html" />
|
<link rel="next" title="com.vmware.nsx.logical_routers package" href="com.vmware.nsx.logical_routers.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.loadbalancer.services package" href="com.vmware.nsx.loadbalancer.services.html" />
|
<link rel="prev" title="com.vmware.nsx.loadbalancer.services package" href="com.vmware.nsx.loadbalancer.services.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -179,28 +181,22 @@
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_router_ports.statistics_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_router_ports.statistics_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.logical_router_ports.statistics_client.Summary">
|
<dt id="com.vmware.nsx.logical_router_ports.statistics_client.Summary">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_router_ports.statistics_client.</code><code class="descname">Summary</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_client.Summary" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_router_ports.statistics_client.</code><code class="descname">Summary</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.logical_router_ports.statistics_client.Summary.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.logical_router_ports.statistics_client.Summary.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_client.Summary.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_client.Summary.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -217,46 +213,42 @@
|
|||||||
<dt id="com.vmware.nsx.logical_router_ports.statistics_client.Summary.get">
|
<dt id="com.vmware.nsx.logical_router_ports.statistics_client.Summary.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>logical_router_port_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_client.Summary.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>logical_router_port_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_router_ports.statistics_client.Summary.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the summation of statistics from all nodes for the Specified
|
<dd><p>Returns the summation of statistics from all nodes for the Specified
|
||||||
Logical Router Port. The query parameter "source=realtime" is
|
Logical Router Port. The query parameter “source=realtime” is not
|
||||||
not supported.</p>
|
supported.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>logical_router_port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>logical_router_port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary" title="com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary" title="com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.LogicalRouterPortStatisticsSummary</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.LogicalRouterPortStatisticsSummary</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.LogicalRouterPortStatisticsSummary</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -275,7 +267,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.logical_routers.html" class="btn btn-neutral float-right" title="com.vmware.nsx.logical_routers package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.logical_routers.html" class="btn btn-neutral float-right" title="com.vmware.nsx.logical_routers package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.loadbalancer.services.html" class="btn btn-neutral" title="com.vmware.nsx.loadbalancer.services package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.loadbalancer.services.html" class="btn btn-neutral float-left" title="com.vmware.nsx.loadbalancer.services package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -284,7 +276,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -301,25 +293,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.logical_routers.nat package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.logical_routers.nat package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.logical_routers.routing package" href="com.vmware.nsx.logical_routers.routing.html" />
|
<link rel="next" title="com.vmware.nsx.logical_routers.routing package" href="com.vmware.nsx.logical_routers.routing.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.logical_routers package" href="com.vmware.nsx.logical_routers.html" />
|
<link rel="prev" title="com.vmware.nsx.logical_routers package" href="com.vmware.nsx.logical_routers.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -180,14 +182,11 @@
|
|||||||
<dt id="com.vmware.nsx.logical_routers.nat.rules_client.Statistics">
|
<dt id="com.vmware.nsx.logical_routers.nat.rules_client.Statistics">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.nat.rules_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_client.Statistics" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.nat.rules_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.logical_routers.nat.rules_client.Statistics.GETPERLOGICALROUTER_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.logical_routers.nat.rules_client.Statistics.GETPERLOGICALROUTER_SOURCE_CACHED">
|
||||||
<code class="descname">GETPERLOGICALROUTER_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_client.Statistics.GETPERLOGICALROUTER_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GETPERLOGICALROUTER_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_client.Statistics.GETPERLOGICALROUTER_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -218,92 +217,84 @@
|
|||||||
<dd><p>Returns the summation of statistics for all rules from all nodes for
|
<dd><p>Returns the summation of statistics for all rules from all nodes for
|
||||||
the Specified Logical Router. Also gives the per transport node
|
the Specified Logical Router. Also gives the per transport node
|
||||||
statistics for provided logical router. The query parameter
|
statistics for provided logical router. The query parameter
|
||||||
"source=realtime" is not supported.</p>
|
“source=realtime” is not supported.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter" title="com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter" title="com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NatStatisticsPerLogicalRouter</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NatStatisticsPerLogicalRouter</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NatStatisticsPerLogicalRouter</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.logical_routers.nat.rules_client.Statistics.getperrule">
|
<dt id="com.vmware.nsx.logical_routers.nat.rules_client.Statistics.getperrule">
|
||||||
<code class="descname">getperrule</code><span class="sig-paren">(</span><em>logical_router_id</em>, <em>rule_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_client.Statistics.getperrule" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">getperrule</code><span class="sig-paren">(</span><em>logical_router_id</em>, <em>rule_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_client.Statistics.getperrule" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the summation of statistics from all nodes for the Specified
|
<dd><p>Returns the summation of statistics from all nodes for the Specified
|
||||||
Logical Router NAT Rule. Query parameter "source=realtime" is
|
Logical Router NAT Rule. Query parameter “source=realtime” is the
|
||||||
the only supported source.</p>
|
only supported source.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NatStatisticsPerRule" title="com.vmware.nsx.model_client.NatStatisticsPerRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NatStatisticsPerRule</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NatStatisticsPerRule" title="com.vmware.nsx.model_client.NatStatisticsPerRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NatStatisticsPerRule</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NatStatisticsPerRule</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NatStatisticsPerRule</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -313,14 +304,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.nat.rules_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.nat.rules_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.nat.rules_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -337,7 +325,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.logical_routers.routing.html" class="btn btn-neutral float-right" title="com.vmware.nsx.logical_routers.routing package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.logical_routers.routing.html" class="btn btn-neutral float-right" title="com.vmware.nsx.logical_routers.routing package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.logical_routers.html" class="btn btn-neutral" title="com.vmware.nsx.logical_routers package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.logical_routers.html" class="btn btn-neutral float-left" title="com.vmware.nsx.logical_routers package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -346,7 +334,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -363,25 +351,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.logical_routers.routing.bgp package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.logical_routers.routing.bgp package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.migration package" href="com.vmware.nsx.migration.html" />
|
<link rel="next" title="com.vmware.nsx.migration package" href="com.vmware.nsx.migration.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.logical_routers.routing package" href="com.vmware.nsx.logical_routers.routing.html" />
|
<link rel="prev" title="com.vmware.nsx.logical_routers.routing package" href="com.vmware.nsx.logical_routers.routing.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -178,18 +180,121 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section" id="module-com.vmware.nsx.logical_routers.routing.bgp.neighbors_client">
|
<div class="section" id="module-com.vmware.nsx.logical_routers.routing.bgp.neighbors_client">
|
||||||
<span id="com-vmware-nsx-logical-routers-routing-bgp-neighbors-client-module"></span><h2>com.vmware.nsx.logical_routers.routing.bgp.neighbors_client module<a class="headerlink" href="#module-com.vmware.nsx.logical_routers.routing.bgp.neighbors_client" title="Permalink to this headline">¶</a></h2>
|
<span id="com-vmware-nsx-logical-routers-routing-bgp-neighbors-client-module"></span><h2>com.vmware.nsx.logical_routers.routing.bgp.neighbors_client module<a class="headerlink" href="#module-com.vmware.nsx.logical_routers.routing.bgp.neighbors_client" title="Permalink to this headline">¶</a></h2>
|
||||||
|
<dl class="class">
|
||||||
|
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.AdvertisedRoutes">
|
||||||
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><code class="descname">AdvertisedRoutes</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.AdvertisedRoutes" 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">
|
||||||
|
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.AdvertisedRoutes.get">
|
||||||
|
<code class="descname">get</code><span class="sig-paren">(</span><em>logical_router_id</em>, <em>neighbor_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.AdvertisedRoutes.get" title="Permalink to this definition">¶</a></dt>
|
||||||
|
<dd><p>Returns routes advertised by BGP neighbor from all edge transport nodes
|
||||||
|
on which this neighbor is currently enabled. It always returns realtime
|
||||||
|
response.</p>
|
||||||
|
<dl class="field-list simple">
|
||||||
|
<dt class="field-odd">Parameters</dt>
|
||||||
|
<dd class="field-odd"><ul class="simple">
|
||||||
|
<li><p><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
|
<li><p><strong>neighbor_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
|
</ul>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Return type</dt>
|
||||||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.BgpNeighborRouteDetails" title="com.vmware.nsx.model_client.BgpNeighborRouteDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.BgpNeighborRouteDetails</span></code></a></p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-odd">Returns</dt>
|
||||||
|
<dd class="field-odd"><p>com.vmware.nsx.model.BgpNeighborRouteDetails</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
|
Service Unavailable</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-odd">Raise</dt>
|
||||||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
|
Bad Request, Precondition Failed</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
|
Internal Server Error</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-odd">Raise</dt>
|
||||||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
|
Forbidden</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="class">
|
||||||
|
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Routes">
|
||||||
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><code class="descname">Routes</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Routes" 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">
|
||||||
|
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Routes.get">
|
||||||
|
<code class="descname">get</code><span class="sig-paren">(</span><em>logical_router_id</em>, <em>neighbor_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Routes.get" title="Permalink to this definition">¶</a></dt>
|
||||||
|
<dd><p>Returns routes learned by BGP neighbor from all edge transport nodes on
|
||||||
|
which this neighbor is currently enabled. It always returns realtime
|
||||||
|
response.</p>
|
||||||
|
<dl class="field-list simple">
|
||||||
|
<dt class="field-odd">Parameters</dt>
|
||||||
|
<dd class="field-odd"><ul class="simple">
|
||||||
|
<li><p><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
|
<li><p><strong>neighbor_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
|
</ul>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Return type</dt>
|
||||||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.BgpNeighborRouteDetails" title="com.vmware.nsx.model_client.BgpNeighborRouteDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.BgpNeighborRouteDetails</span></code></a></p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-odd">Returns</dt>
|
||||||
|
<dd class="field-odd"><p>com.vmware.nsx.model.BgpNeighborRouteDetails</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
|
Service Unavailable</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-odd">Raise</dt>
|
||||||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
|
Bad Request, Precondition Failed</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
|
Internal Server Error</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-odd">Raise</dt>
|
||||||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
|
Forbidden</p>
|
||||||
|
</dd>
|
||||||
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status">
|
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.LIST_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.LIST_SOURCE_CACHED">
|
||||||
<code class="descname">LIST_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.LIST_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">LIST_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.LIST_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -205,53 +310,49 @@
|
|||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list">
|
<dt id="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>logical_router_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>source=None</em>, <em>transport_node_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>logical_router_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>source=None</em>, <em>transport_node_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><table class="docutils field-list" frame="void" rules="none">
|
<dd><dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>logical_router_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
<li><p><strong>transport_node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Transport node id (optional)</p></li>
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
<li><strong>transport_node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Transport node id (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.BgpNeighborsStatusListResult" title="com.vmware.nsx.model_client.BgpNeighborsStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.BgpNeighborsStatusListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.BgpNeighborsStatusListResult" title="com.vmware.nsx.model_client.BgpNeighborsStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.BgpNeighborsStatusListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.BgpNeighborsStatusListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.BgpNeighborsStatusListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -261,14 +362,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -285,7 +383,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.migration.html" class="btn btn-neutral float-right" title="com.vmware.nsx.migration package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.migration.html" class="btn btn-neutral float-right" title="com.vmware.nsx.migration package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.logical_routers.routing.html" class="btn btn-neutral" title="com.vmware.nsx.logical_routers.routing package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.logical_routers.routing.html" class="btn btn-neutral float-left" title="com.vmware.nsx.logical_routers.routing package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -294,7 +392,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -311,25 +409,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.migration package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.migration package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.node package" href="com.vmware.nsx.node.html" />
|
<link rel="next" title="com.vmware.nsx.node package" href="com.vmware.nsx.node.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.logical_routers.routing.bgp package" href="com.vmware.nsx.logical_routers.routing.bgp.html" />
|
<link rel="prev" title="com.vmware.nsx.logical_routers.routing.bgp package" href="com.vmware.nsx.logical_routers.routing.bgp.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -179,59 +181,57 @@
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.bundles_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.bundles_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.bundles_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.bundles_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.migration.bundles_client.UploadStatus">
|
<dt id="com.vmware.nsx.migration.bundles_client.UploadStatus">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.bundles_client.</code><code class="descname">UploadStatus</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.bundles_client.UploadStatus" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.bundles_client.</code><code class="descname">UploadStatus</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.bundles_client.UploadStatus" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.migration.bundles_client.UploadStatus.get">
|
<dt id="com.vmware.nsx.migration.bundles_client.UploadStatus.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>bundle_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.bundles_client.UploadStatus.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>bundle_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.bundles_client.UploadStatus.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get uploaded migration bundle upload status</p>
|
<dd><p>Get uploaded migration bundle upload status</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>bundle_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bundle_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationBundleUploadStatus" title="com.vmware.nsx.model_client.MigrationBundleUploadStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationBundleUploadStatus</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationBundleUploadStatus" title="com.vmware.nsx.model_client.MigrationBundleUploadStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationBundleUploadStatus</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.MigrationBundleUploadStatus</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationBundleUploadStatus</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -243,68 +243,61 @@ Not Found</td>
|
|||||||
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo">
|
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">AggregateInfo</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">AggregateInfo</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo.list">
|
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>component_type=None</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>summary=None</em>, <em>sync=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>component_type=None</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em>, <em>summary=None</em>, <em>sync=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.AggregateInfo.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Return aggregate information of all migration unit groups</p>
|
<dd><p>Return aggregate information of all migration unit groups</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component type based on which migration unit groups to be filtered
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
(optional)</p></li>
|
||||||
<li><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component type based on which migration unit groups to be filtered
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
(optional)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
by current result page) (optional)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
<li><p><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether to return summary (optional, default to
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
false)</p></li>
|
||||||
<li><strong>summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag indicating whether to return summary (optional, default to
|
<li><p><strong>sync</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Synchronize before returning migration unit groups (optional,
|
||||||
false)</li>
|
default to false)</p></li>
|
||||||
<li><strong>sync</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Synchronize before returning migration unit groups (optional,
|
|
||||||
default to false)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult" title="com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult" title="com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitGroupAggregateInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.MigrationUnitGroupAggregateInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationUnitGroupAggregateInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -313,51 +306,44 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit">
|
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">MigrationUnit</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">MigrationUnit</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit.reorder">
|
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit.reorder">
|
||||||
<code class="descname">reorder</code><span class="sig-paren">(</span><em>group_id</em>, <em>migration_unit_id</em>, <em>reorder_migration_request</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit.reorder" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">reorder</code><span class="sig-paren">(</span><em>group_id</em>, <em>migration_unit_id</em>, <em>reorder_migration_request</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.MigrationUnit.reorder" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Reorder an migration unit within the migration unit group</p>
|
<dd><p>Reorder an migration unit within the migration unit group</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>migration_unit_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>reorder_migration_request</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ReorderMigrationRequest" title="com.vmware.nsx.model_client.ReorderMigrationRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ReorderMigrationRequest</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>migration_unit_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>reorder_migration_request</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.ReorderMigrationRequest" title="com.vmware.nsx.model_client.ReorderMigrationRequest"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.ReorderMigrationRequest</span></code></a>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -366,65 +352,58 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.Status">
|
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.Status.list">
|
<dt id="com.vmware.nsx.migration.migration_unit_groups_client.Status.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>group_id</em>, <em>cursor=None</em>, <em>has_errors=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>group_id</em>, <em>cursor=None</em>, <em>has_errors=None</em>, <em>included_fields=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.Status.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get migration status for group</p>
|
<dd><p>Get migration status for group</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
<li><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>has_errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether to return only migration units with errors
|
||||||
by current result page) (optional)</li>
|
(optional, default to false)</p></li>
|
||||||
<li><strong>has_errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether to return only migration units with errors
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
(optional, default to false)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
result (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
fewer) (optional, default to 1000)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitStatusListResult" title="com.vmware.nsx.model_client.MigrationUnitStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitStatusListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitStatusListResult" title="com.vmware.nsx.model_client.MigrationUnitStatusListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitStatusListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.MigrationUnitStatusListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationUnitStatusListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -434,14 +413,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_groups_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_unit_groups_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_unit_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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -451,14 +427,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo">
|
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_units_client.</code><code class="descname">AggregateInfo</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_units_client.</code><code class="descname">AggregateInfo</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_ALL">
|
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_ALL">
|
||||||
<code class="descname">LIST_SELECTION_STATUS_ALL</code><em class="property"> = 'ALL'</em><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_ALL" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">LIST_SELECTION_STATUS_ALL</code><em class="property"> = 'ALL'</em><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.LIST_SELECTION_STATUS_ALL" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -481,59 +454,55 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.list">
|
<dt id="com.vmware.nsx.migration.migration_units_client.AggregateInfo.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>component_type=None</em>, <em>cursor=None</em>, <em>group_id=None</em>, <em>has_errors=None</em>, <em>included_fields=None</em>, <em>metadata=None</em>, <em>page_size=None</em>, <em>selection_status=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>component_type=None</em>, <em>cursor=None</em>, <em>group_id=None</em>, <em>has_errors=None</em>, <em>included_fields=None</em>, <em>metadata=None</em>, <em>page_size=None</em>, <em>selection_status=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.AggregateInfo.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get migration units aggregate-info</p>
|
<dd><p>Get migration units aggregate-info</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component type based on which migration units to be filtered
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
(optional)</p></li>
|
||||||
<li><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Component type based on which migration units to be filtered
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
||||||
(optional)</li>
|
by current result page) (optional)</p></li>
|
||||||
<li><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of group based on which migration units to be filtered
|
||||||
by current result page) (optional)</li>
|
(optional)</p></li>
|
||||||
<li><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of group based on which migration units to be filtered
|
<li><p><strong>has_errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether to return only migration units with errors
|
||||||
(optional)</li>
|
(optional, default to false)</p></li>
|
||||||
<li><strong>has_errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether to return only migration units with errors
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
||||||
(optional, default to false)</li>
|
result (optional)</p></li>
|
||||||
<li><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Metadata about migration unit to filter on (optional)</p></li>
|
||||||
result (optional)</li>
|
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
||||||
<li><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Metadata about migration unit to filter on (optional)</li>
|
fewer) (optional, default to 1000)</p></li>
|
||||||
<li><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
|
<li><p><strong>selection_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether to return only selected, only deselected
|
||||||
fewer) (optional, default to 1000)</li>
|
or both type of migration units (optional, default to ALL)</p></li>
|
||||||
<li><strong>selection_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether to return only selected, only deselected
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
||||||
or both type of migration units (optional, default to ALL)</li>
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
||||||
<li><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</li>
|
|
||||||
<li><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult" title="com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult" title="com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationUnitAggregateInfoListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.MigrationUnitAggregateInfoListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationUnitAggregateInfoListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -543,14 +512,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_units_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.migration_units_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.migration_units_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -560,89 +526,86 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.migration.plan_client.Settings">
|
<dt id="com.vmware.nsx.migration.plan_client.Settings">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.plan_client.</code><code class="descname">Settings</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.plan_client.</code><code class="descname">Settings</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.migration.plan_client.Settings.get">
|
<dt id="com.vmware.nsx.migration.plan_client.Settings.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>component_type</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>component_type</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get the migration plan settings for the component.</p>
|
<dd><p>Get the migration plan settings for the component.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.MigrationPlanSettings</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationPlanSettings</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.migration.plan_client.Settings.update">
|
<dt id="com.vmware.nsx.migration.plan_client.Settings.update">
|
||||||
<code class="descname">update</code><span class="sig-paren">(</span><em>component_type</em>, <em>migration_plan_settings</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings.update" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">update</code><span class="sig-paren">(</span><em>component_type</em>, <em>migration_plan_settings</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.Settings.update" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Update the migration plan settings for the component.</p>
|
<dd><p>Update the migration plan settings for the component.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>migration_plan_settings</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>component_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>migration_plan_settings</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.MigrationPlanSettings" title="com.vmware.nsx.model_client.MigrationPlanSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.MigrationPlanSettings</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.MigrationPlanSettings</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.MigrationPlanSettings</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -652,14 +615,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.plan_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.migration.plan_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.migration.plan_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -676,7 +636,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.node.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.node.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.logical_routers.routing.bgp.html" class="btn btn-neutral" title="com.vmware.nsx.logical_routers.routing.bgp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.logical_routers.routing.bgp.html" class="btn btn-neutral float-left" title="com.vmware.nsx.logical_routers.routing.bgp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -685,7 +645,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -702,25 +662,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.node.aaa package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.node.aaa package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.node.aaa.providers package" href="com.vmware.nsx.node.aaa.providers.html" />
|
<link rel="next" title="com.vmware.nsx.node.aaa.providers package" href="com.vmware.nsx.node.aaa.providers.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.node package" href="com.vmware.nsx.node.html" />
|
<link rel="prev" title="com.vmware.nsx.node package" href="com.vmware.nsx.node.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -193,90 +195,91 @@
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="class">
|
<dl class="class">
|
||||||
<dt id="com.vmware.nsx.node.aaa.providers_client.Vidm">
|
<dt id="com.vmware.nsx.node.aaa.providers_client.Vidm">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers_client.</code><code class="descname">Vidm</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.Vidm" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers_client.</code><code class="descname">Vidm</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.Vidm" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.node.aaa.providers_client.Vidm.get">
|
<dt id="com.vmware.nsx.node.aaa.providers_client.Vidm.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.Vidm.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.Vidm.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Read AAA provider vIDM properties</p>
|
<dd><p>Read AAA provider vIDM properties</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Return type</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmProperties" title="com.vmware.nsx.model_client.NodeAuthProviderVidmProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmProperties</span></code></a></p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmProperties" title="com.vmware.nsx.model_client.NodeAuthProviderVidmProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmProperties</span></code></a></td>
|
<dt class="field-even">Returns</dt>
|
||||||
</tr>
|
<dd class="field-even"><p>com.vmware.nsx.model.NodeAuthProviderVidmProperties</p>
|
||||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.NodeAuthProviderVidmProperties</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</td>
|
Service Unavailable</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Bad Request, Precondition Failed</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
</tr>
|
Bad Request, Precondition Failed</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
</dd>
|
||||||
Internal Server Error</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
Internal Server Error</p>
|
||||||
Forbidden</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Not Found</td>
|
Forbidden</p>
|
||||||
</tr>
|
</dd>
|
||||||
</tbody>
|
<dt class="field-odd">Raise</dt>
|
||||||
</table>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.node.aaa.providers_client.Vidm.update">
|
<dt id="com.vmware.nsx.node.aaa.providers_client.Vidm.update">
|
||||||
<code class="descname">update</code><span class="sig-paren">(</span><em>node_auth_provider_vidm_properties</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.Vidm.update" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">update</code><span class="sig-paren">(</span><em>node_auth_provider_vidm_properties</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers_client.Vidm.update" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Update AAA provider vIDM properties</p>
|
<dd><p>Update AAA provider vIDM properties</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>node_auth_provider_vidm_properties</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmProperties" title="com.vmware.nsx.model_client.NodeAuthProviderVidmProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmProperties</span></code></a>) – (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node_auth_provider_vidm_properties</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmProperties" title="com.vmware.nsx.model_client.NodeAuthProviderVidmProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmProperties</span></code></a>) – (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmProperties" title="com.vmware.nsx.model_client.NodeAuthProviderVidmProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmProperties</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmProperties" title="com.vmware.nsx.model_client.NodeAuthProviderVidmProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmProperties</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.NodeAuthProviderVidmProperties</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeAuthProviderVidmProperties</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -295,7 +298,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.node.aaa.providers.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node.aaa.providers package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.node.aaa.providers.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node.aaa.providers package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.node.html" class="btn btn-neutral" title="com.vmware.nsx.node package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.node.html" class="btn btn-neutral float-left" title="com.vmware.nsx.node package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -304,7 +307,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -321,25 +324,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.node.aaa.providers package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.node.aaa.providers package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.node.network package" href="com.vmware.nsx.node.network.html" />
|
<link rel="next" title="com.vmware.nsx.node.network package" href="com.vmware.nsx.node.network.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.node.aaa package" href="com.vmware.nsx.node.aaa.html" />
|
<link rel="prev" title="com.vmware.nsx.node.aaa package" href="com.vmware.nsx.node.aaa.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -182,43 +184,43 @@
|
|||||||
<dt id="com.vmware.nsx.node.aaa.providers.vidm_client.Status">
|
<dt id="com.vmware.nsx.node.aaa.providers.vidm_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers.vidm_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers.vidm_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers.vidm_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers.vidm_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.node.aaa.providers.vidm_client.Status.get">
|
<dt id="com.vmware.nsx.node.aaa.providers.vidm_client.Status.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers.vidm_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers.vidm_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Read AAA provider vIDM status</p>
|
<dd><p>Read AAA provider vIDM status</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Return type</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmStatus" title="com.vmware.nsx.model_client.NodeAuthProviderVidmStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmStatus</span></code></a></p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeAuthProviderVidmStatus" title="com.vmware.nsx.model_client.NodeAuthProviderVidmStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeAuthProviderVidmStatus</span></code></a></td>
|
<dt class="field-even">Returns</dt>
|
||||||
</tr>
|
<dd class="field-even"><p>com.vmware.nsx.model.NodeAuthProviderVidmStatus</p>
|
||||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.NodeAuthProviderVidmStatus</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</td>
|
Service Unavailable</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Bad Request, Precondition Failed</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
</tr>
|
Bad Request, Precondition Failed</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
</dd>
|
||||||
Internal Server Error</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
Internal Server Error</p>
|
||||||
Forbidden</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Not Found</td>
|
Forbidden</p>
|
||||||
</tr>
|
</dd>
|
||||||
</tbody>
|
<dt class="field-odd">Raise</dt>
|
||||||
</table>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -228,14 +230,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers.vidm_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers.vidm_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.aaa.providers.vidm_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.aaa.providers.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -252,7 +251,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.node.network.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node.network package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.node.network.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node.network package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.node.aaa.html" class="btn btn-neutral" title="com.vmware.nsx.node.aaa package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.node.aaa.html" class="btn btn-neutral float-left" title="com.vmware.nsx.node.aaa package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -261,7 +260,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -278,25 +277,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.node.network package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.node.network package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.node.services package" href="com.vmware.nsx.node.services.html" />
|
<link rel="next" title="com.vmware.nsx.node.services package" href="com.vmware.nsx.node.services.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.node.aaa.providers package" href="com.vmware.nsx.node.aaa.providers.html" />
|
<link rel="prev" title="com.vmware.nsx.node.aaa.providers package" href="com.vmware.nsx.node.aaa.providers.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -180,14 +182,11 @@
|
|||||||
<dt id="com.vmware.nsx.node.network.interfaces_client.Stats">
|
<dt id="com.vmware.nsx.node.network.interfaces_client.Stats">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.network.interfaces_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.network.interfaces_client.Stats" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.network.interfaces_client.</code><code class="descname">Stats</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.node.network.interfaces_client.Stats.get">
|
<dt id="com.vmware.nsx.node.network.interfaces_client.Stats.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>interface_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.network.interfaces_client.Stats.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>interface_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.network.interfaces_client.Stats.get" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -195,33 +194,37 @@
|
|||||||
transmitted (tx), and dropped packets; the number of bytes and errors
|
transmitted (tx), and dropped packets; the number of bytes and errors
|
||||||
received and transmitted on the interface; and the number of detected
|
received and transmitted on the interface; and the number of detected
|
||||||
collisions.</p>
|
collisions.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of interface to read (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of interface to read (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties" title="com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties" title="com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NodeInterfaceStatisticsProperties</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.NodeInterfaceStatisticsProperties</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NodeInterfaceStatisticsProperties</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -231,14 +234,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.network.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.network.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.node.network.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.node.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -255,7 +255,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.node.services.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node.services package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.node.services.html" class="btn btn-neutral float-right" title="com.vmware.nsx.node.services package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.node.aaa.providers.html" class="btn btn-neutral" title="com.vmware.nsx.node.aaa.providers package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.node.aaa.providers.html" class="btn btn-neutral float-left" title="com.vmware.nsx.node.aaa.providers package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -264,7 +264,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -281,25 +281,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.pools package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.pools package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.serviceinsertion package" href="com.vmware.nsx.serviceinsertion.html" />
|
<link rel="next" title="com.vmware.nsx.serviceinsertion package" href="com.vmware.nsx.serviceinsertion.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.node.services package" href="com.vmware.nsx.node.services.html" />
|
<link rel="prev" title="com.vmware.nsx.node.services package" href="com.vmware.nsx.node.services.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -178,46 +180,47 @@
|
|||||||
<dt id="com.vmware.nsx.pools.ip_pools_client.Allocations">
|
<dt id="com.vmware.nsx.pools.ip_pools_client.Allocations">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.pools.ip_pools_client.</code><code class="descname">Allocations</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.pools.ip_pools_client.Allocations" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.pools.ip_pools_client.</code><code class="descname">Allocations</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.pools.ip_pools_client.Allocations" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.pools.ip_pools_client.Allocations.list">
|
<dt id="com.vmware.nsx.pools.ip_pools_client.Allocations.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>pool_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.pools.ip_pools_client.Allocations.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>pool_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.pools.ip_pools_client.Allocations.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns information about which addresses have been allocated from a
|
<dd><p>Returns information about which addresses have been allocated from a
|
||||||
specified IP address pool.</p>
|
specified IP address pool.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IP pool ID (required)</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pool_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IP pool ID (required)</td>
|
<dt class="field-even">Return type</dt>
|
||||||
</tr>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AllocationIpAddressListResult" title="com.vmware.nsx.model_client.AllocationIpAddressListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AllocationIpAddressListResult</span></code></a></p>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.AllocationIpAddressListResult" title="com.vmware.nsx.model_client.AllocationIpAddressListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.AllocationIpAddressListResult</span></code></a></td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.nsx.model.AllocationIpAddressListResult</td>
|
<dd class="field-odd"><p>com.vmware.nsx.model.AllocationIpAddressListResult</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dt class="field-even">Raise</dt>
|
||||||
Service Unavailable</td>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
</tr>
|
Service Unavailable</p>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
</dd>
|
||||||
Bad Request, Precondition Failed</td>
|
<dt class="field-odd">Raise</dt>
|
||||||
</tr>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
Bad Request, Precondition Failed</p>
|
||||||
Internal Server Error</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Forbidden</td>
|
Internal Server Error</p>
|
||||||
</tr>
|
</dd>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dt class="field-odd">Raise</dt>
|
||||||
Not Found</td>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
</tr>
|
Forbidden</p>
|
||||||
</tbody>
|
</dd>
|
||||||
</table>
|
<dt class="field-even">Raise</dt>
|
||||||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
|
Not Found</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -227,14 +230,11 @@ Not Found</td>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.pools.ip_pools_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.pools.ip_pools_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.pools.ip_pools_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.pools.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -251,7 +251,7 @@ Not Found</td>
|
|||||||
<a href="com.vmware.nsx.serviceinsertion.html" class="btn btn-neutral float-right" title="com.vmware.nsx.serviceinsertion package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.serviceinsertion.html" class="btn btn-neutral float-right" title="com.vmware.nsx.serviceinsertion package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.node.services.html" class="btn btn-neutral" title="com.vmware.nsx.node.services package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.node.services.html" class="btn btn-neutral float-left" title="com.vmware.nsx.node.services package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -260,7 +260,7 @@ Not Found</td>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -277,25 +277,16 @@ Not Found</td>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.serviceinsertion.services package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.serviceinsertion.services package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.serviceinsertion.services.service_instances package" href="com.vmware.nsx.serviceinsertion.services.service_instances.html" />
|
<link rel="next" title="com.vmware.nsx.serviceinsertion.services.service_instances package" href="com.vmware.nsx.serviceinsertion.services.service_instances.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.serviceinsertion package" href="com.vmware.nsx.serviceinsertion.html" />
|
<link rel="prev" title="com.vmware.nsx.serviceinsertion package" href="com.vmware.nsx.serviceinsertion.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -198,59 +200,52 @@
|
|||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances_client.</code><code class="descname">InstanceEndpoints</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances_client.</code><code class="descname">InstanceEndpoints</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.create">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.create">
|
||||||
<code class="descname">create</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_endpoint</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.create" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">create</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_endpoint</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.create" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Adds a new instance endpoint. It belongs to one service instance and is
|
<dd><p>Adds a new instance endpoint. It belongs to one service instance and is
|
||||||
attached to one service attachment. It represents a redirection target
|
attached to one service attachment. It represents a redirection target
|
||||||
for a Rule.</p>
|
for a Rule.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>instance_endpoint</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpoint" title="com.vmware.nsx.model_client.InstanceEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpoint</span></code></a>) – (required)</p></li>
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>instance_endpoint</strong> (<a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpoint" title="com.vmware.nsx.model_client.InstanceEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpoint</span></code></a>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpoint" title="com.vmware.nsx.model_client.InstanceEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpoint</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpoint" title="com.vmware.nsx.model_client.InstanceEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpoint</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.InstanceEndpoint</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.InstanceEndpoint</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -259,128 +254,116 @@ Not Found</p>
|
|||||||
<dd><p>Delete instance endpoint information for a given instace endpoint.
|
<dd><p>Delete instance endpoint information for a given instace endpoint.
|
||||||
Please make sure to delete all the Service Insertion Rules, which refer
|
Please make sure to delete all the Service Insertion Rules, which refer
|
||||||
to this Endpoint as ‘redirect_tos’ target.</p>
|
to this Endpoint as ‘redirect_tos’ target.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>instance_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>instance_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.get">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_endpoint</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_endpoint</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns detailed Endpoint information for a given InstanceEndpoint.</p>
|
<dd><p>Returns detailed Endpoint information for a given InstanceEndpoint.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>instance_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>instance_endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpoint" title="com.vmware.nsx.model_client.InstanceEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpoint</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpoint" title="com.vmware.nsx.model_client.InstanceEndpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpoint</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.InstanceEndpoint</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.InstanceEndpoint</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.list">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.list">
|
||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceEndpoints.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>List all InstanceEndpoints of a service instance.</p>
|
<dd><p>List all InstanceEndpoints of a service instance.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpointListResult" title="com.vmware.nsx.model_client.InstanceEndpointListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpointListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceEndpointListResult" title="com.vmware.nsx.model_client.InstanceEndpointListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceEndpointListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.InstanceEndpointListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.InstanceEndpointListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -389,52 +372,45 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances_client.</code><code class="descname">InstanceRuntimes</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances_client.</code><code class="descname">InstanceRuntimes</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes.delete">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes.delete">
|
||||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes.delete" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes.delete" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Undeploy one service VM as standalone or two service VMs as HA.
|
<dd><p>Undeploy one service VM as standalone or two service VMs as HA.
|
||||||
Associated deployment information and instance runtime will also be
|
Associated deployment information and instance runtime will also be
|
||||||
deleted once service VMs have been un-deployed successfully.</p>
|
deleted once service VMs have been un-deployed successfully.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -444,38 +420,34 @@ Not Found</p>
|
|||||||
one VM is active and another one is standby. During the deployment of
|
one VM is active and another one is standby. During the deployment of
|
||||||
service VMs, service will be set up based on deployment events using
|
service VMs, service will be set up based on deployment events using
|
||||||
callbacks.</p>
|
callbacks.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -483,44 +455,40 @@ Not Found</p>
|
|||||||
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes.list" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">list</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.InstanceRuntimes.list" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns list of instance runtimes of service VMs being deployed for a
|
<dd><p>Returns list of instance runtimes of service VMs being deployed for a
|
||||||
given service instance id</p>
|
given service instance id</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceRuntimeListResult" title="com.vmware.nsx.model_client.InstanceRuntimeListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceRuntimeListResult</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.InstanceRuntimeListResult" title="com.vmware.nsx.model_client.InstanceRuntimeListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.InstanceRuntimeListResult</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.InstanceRuntimeListResult</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.InstanceRuntimeListResult</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
@ -529,38 +497,34 @@ Not Found</p>
|
|||||||
<dd><p>Upgrade service VMs using newer version of OVF. In case of HA, the
|
<dd><p>Upgrade service VMs using newer version of OVF. In case of HA, the
|
||||||
stand-by service VM will be upgrade first. Once it has been upgraded,
|
stand-by service VM will be upgrade first. Once it has been upgraded,
|
||||||
it switches to be the Active one and then the other VM will be upgrade.</p>
|
it switches to be the Active one and then the other VM will be upgrade.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -570,14 +534,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -594,7 +555,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.html" class="btn btn-neutral float-right" title="com.vmware.nsx.serviceinsertion.services.service_instances package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.html" class="btn btn-neutral float-right" title="com.vmware.nsx.serviceinsertion.services.service_instances package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.serviceinsertion.html" class="btn btn-neutral" title="com.vmware.nsx.serviceinsertion package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.serviceinsertion.html" class="btn btn-neutral float-left" title="com.vmware.nsx.serviceinsertion package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -603,7 +564,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -620,25 +581,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.serviceinsertion.services.service_instances package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.serviceinsertion.services.service_instances package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" />
|
<link rel="next" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.serviceinsertion.services package" href="com.vmware.nsx.serviceinsertion.services.html" />
|
<link rel="prev" title="com.vmware.nsx.serviceinsertion.services package" href="com.vmware.nsx.serviceinsertion.services.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -198,7 +200,7 @@
|
|||||||
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" class="btn btn-neutral float-right" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" class="btn btn-neutral float-right" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.serviceinsertion.services.html" class="btn btn-neutral" title="com.vmware.nsx.serviceinsertion.services package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.serviceinsertion.services.html" class="btn btn-neutral float-left" title="com.vmware.nsx.serviceinsertion.services package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -207,7 +209,7 @@
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -224,25 +226,16 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.transport_nodes package" href="com.vmware.nsx.transport_nodes.html" />
|
<link rel="next" title="com.vmware.nsx.transport_nodes package" href="com.vmware.nsx.transport_nodes.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.serviceinsertion.services.service_instances package" href="com.vmware.nsx.serviceinsertion.services.service_instances.html" />
|
<link rel="prev" title="com.vmware.nsx.serviceinsertion.services.service_instances package" href="com.vmware.nsx.serviceinsertion.services.service_instances.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -184,14 +186,11 @@
|
|||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.</code><code class="descname">Statistics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -209,48 +208,44 @@
|
|||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_runtime_id</em>, <em>interface_index</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_runtime_id</em>, <em>interface_index</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns statistics of a specified interface via associated logical
|
<dd><p>Returns statistics of a specified interface via associated logical
|
||||||
port. If the logical port is attached to a logical router port, query
|
port. If the logical port is attached to a logical router port, query
|
||||||
parameter "source=realtime" is not supported.</p>
|
parameter “source=realtime” is not supported.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>instance_runtime_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>interface_index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>instance_runtime_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>interface_index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RuntimeInterfaceStatistics" title="com.vmware.nsx.model_client.RuntimeInterfaceStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RuntimeInterfaceStatistics</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RuntimeInterfaceStatistics" title="com.vmware.nsx.model_client.RuntimeInterfaceStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RuntimeInterfaceStatistics</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.RuntimeInterfaceStatistics</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.RuntimeInterfaceStatistics</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -259,14 +254,11 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.</code><code class="descname">Status</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -283,47 +275,43 @@ Not Found</p>
|
|||||||
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.get">
|
<dt id="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.get">
|
||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_runtime_id</em>, <em>interface_index</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em>, <em>service_instance_id</em>, <em>instance_runtime_id</em>, <em>interface_index</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns operational status of a specified interface</p>
|
<dd><p>Returns operational status of a specified interface</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>instance_runtime_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>interface_index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<li><strong>instance_runtime_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>interface_index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus" title="com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus" title="com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.RuntimeInterfaceOperationalStatus</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.RuntimeInterfaceOperationalStatus</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.RuntimeInterfaceOperationalStatus</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -333,14 +321,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.interfaces_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.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>
|
<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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -357,7 +342,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.transport_nodes.html" class="btn btn-neutral float-right" title="com.vmware.nsx.transport_nodes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.transport_nodes.html" class="btn btn-neutral float-right" title="com.vmware.nsx.transport_nodes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.html" class="btn btn-neutral" title="com.vmware.nsx.serviceinsertion.services.service_instances package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.html" class="btn btn-neutral float-left" title="com.vmware.nsx.serviceinsertion.services.service_instances package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -366,7 +351,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -383,25 +368,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
<title>com.vmware.nsx.transport_nodes package — NSX-T SDK 2.3.0.0.2 documentation</title>
|
<title>com.vmware.nsx.transport_nodes package — NSX-T SDK 2.3.0.0.3 documentation</title>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,34 +17,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="com.vmware.nsx.upgrade package" href="com.vmware.nsx.upgrade.html" />
|
<link rel="next" title="com.vmware.nsx.upgrade package" href="com.vmware.nsx.upgrade.html" />
|
||||||
<link rel="prev" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" />
|
<link rel="prev" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" />
|
||||||
|
|
||||||
|
|
||||||
<script src="_static/js/modernizr.min.js"></script>
|
|
||||||
|
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<div class="wy-grid-for-nav">
|
<div class="wy-grid-for-nav">
|
||||||
|
|
||||||
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
<div class="wy-side-scroll">
|
<div class="wy-side-scroll">
|
||||||
<div class="wy-side-nav-search">
|
<div class="wy-side-nav-search" >
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -58,7 +60,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<div class="version">
|
<div class="version">
|
||||||
2.3.0.0.2
|
2.3.0.0.3
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -178,14 +180,11 @@
|
|||||||
<dt id="com.vmware.nsx.transport_nodes.statistics_client.NatRules">
|
<dt id="com.vmware.nsx.transport_nodes.statistics_client.NatRules">
|
||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.transport_nodes.statistics_client.</code><code class="descname">NatRules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.NatRules" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.transport_nodes.statistics_client.</code><code class="descname">NatRules</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.NatRules" 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>
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<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>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
<dl class="attribute">
|
<dl class="attribute">
|
||||||
<dt id="com.vmware.nsx.transport_nodes.statistics_client.NatRules.GET_SOURCE_CACHED">
|
<dt id="com.vmware.nsx.transport_nodes.statistics_client.NatRules.GET_SOURCE_CACHED">
|
||||||
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.NatRules.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">GET_SOURCE_CACHED</code><em class="property"> = 'cached'</em><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.NatRules.GET_SOURCE_CACHED" title="Permalink to this definition">¶</a></dt>
|
||||||
@ -203,46 +202,42 @@
|
|||||||
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.NatRules.get" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">get</code><span class="sig-paren">(</span><em>node_id</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.NatRules.get" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Returns the summation of statistics for all rules from all logical
|
<dd><p>Returns the summation of statistics for all rules from all logical
|
||||||
routers which are present on given transport node. Only cached
|
routers which are present on given transport node. Only cached
|
||||||
statistics are supported. The query parameter "source=realtime"
|
statistics are supported. The query parameter “source=realtime” is
|
||||||
is not supported.</p>
|
not supported.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><ul class="simple">
|
||||||
<tbody valign="top">
|
<li><p><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
<li><p><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</p></li>
|
||||||
<li><strong>node_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</li>
|
|
||||||
<li><strong>source</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Data source type. (optional)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Return type</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NatStatisticsPerTransportNode" title="com.vmware.nsx.model_client.NatStatisticsPerTransportNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NatStatisticsPerTransportNode</span></code></a></p>
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx.html#com.vmware.nsx.model_client.NatStatisticsPerTransportNode" title="com.vmware.nsx.model_client.NatStatisticsPerTransportNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx.model_client.NatStatisticsPerTransportNode</span></code></a></p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Returns</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.nsx.model.NatStatisticsPerTransportNode</p>
|
<dd class="field-odd"><p>com.vmware.nsx.model.NatStatisticsPerTransportNode</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
||||||
Service Unavailable</p>
|
Service Unavailable</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
||||||
Bad Request, Precondition Failed</p>
|
Bad Request, Precondition Failed</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
||||||
Internal Server Error</p>
|
Internal Server Error</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-odd">Raise</dt>
|
||||||
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
||||||
Forbidden</p>
|
Forbidden</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
<dt class="field-even">Raise</dt>
|
||||||
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
||||||
Not Found</p>
|
Not Found</p>
|
||||||
</td>
|
</dd>
|
||||||
</tr>
|
</dl>
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
@ -252,14 +247,11 @@ Not Found</p>
|
|||||||
<em class="property">class </em><code class="descclassname">com.vmware.nsx.transport_nodes.statistics_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx.transport_nodes.statistics_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx.transport_nodes.statistics_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
<dd><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>
|
<p>Initialize StubFactoryBase</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<dl class="field-list simple">
|
||||||
<col class="field-name" />
|
<dt class="field-odd">Parameters</dt>
|
||||||
<col class="field-body" />
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||||
<tbody valign="top">
|
</dd>
|
||||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
|
</dl>
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -276,7 +268,7 @@ Not Found</p>
|
|||||||
<a href="com.vmware.nsx.upgrade.html" class="btn btn-neutral float-right" title="com.vmware.nsx.upgrade package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
<a href="com.vmware.nsx.upgrade.html" class="btn btn-neutral float-right" title="com.vmware.nsx.upgrade package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
|
||||||
|
|
||||||
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" class="btn btn-neutral" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
<a href="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes.html" class="btn btn-neutral float-left" title="com.vmware.nsx.serviceinsertion.services.service_instances.instance_runtimes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -285,7 +277,7 @@ Not Found</p>
|
|||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>
|
<p>
|
||||||
© Copyright 2018, VMware, Inc.
|
© Copyright 2019, VMware, Inc.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
@ -302,25 +294,16 @@ Not Found</p>
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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/js/theme.js"></script>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
jQuery(function () {
|
jQuery(function () {
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|