mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 10:50:00 -05:00
Updating latest python vmc docs
This commit is contained in:
amanp
parent
f0e4973681
commit
9e393216b2
@ -16,6 +16,14 @@ Subpackages
|
||||
Submodules
|
||||
----------
|
||||
|
||||
com.vmware.vmc.orgs.sddcs.addons\_client module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: com.vmware.vmc.orgs.sddcs.addons_client
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
com.vmware.vmc.orgs.sddcs.dns\_client module
|
||||
--------------------------------------------
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
.. VMware Cloud on AWS Console API documentation master file, created by
|
||||
sphinx-quickstart on Thu Jan 10 05:32:03 2019.
|
||||
sphinx-quickstart on Wed May 29 10:00:45 2019.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 673 B |
@ -4,7 +4,7 @@
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
@ -231,6 +231,16 @@ a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
@ -391,6 +401,16 @@ table.citation td {
|
||||
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 --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
@ -460,11 +480,57 @@ ol.upperroman {
|
||||
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 {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
dd > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
@ -537,6 +603,12 @@ dl.glossary dt {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0.5em;
|
||||
content: ":";
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 756 B |
Binary file not shown.
|
Before Width: | Height: | Size: 829 B |
Binary file not shown.
|
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}}
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -4,7 +4,7 @@
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var bbox = span.getBBox();
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
var parentOfText = node.parentNode.parentNode;
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '1.3.1',
|
||||
VERSION: '1.4.0',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
NAVIGATION_WITH_KEYS: false
|
||||
};
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 222 B |
Binary file not shown.
|
Before Width: | Height: | Size: 202 B |
@ -1,3 +1,3 @@
|
||||
/* sphinx_rtd_theme version 0.4.2 | MIT license */
|
||||
/* Built 20181005 13:10 */
|
||||
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"]);
|
||||
/* sphinx_rtd_theme version 0.4.3 | MIT license */
|
||||
/* 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"),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"]);
|
||||
@ -5,7 +5,7 @@
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
@ -36,8 +36,10 @@ if (!Scorer) {
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
partialTitle: 7,
|
||||
// query found in terms
|
||||
term: 5
|
||||
term: 5,
|
||||
partialTerm: 2
|
||||
};
|
||||
}
|
||||
|
||||
@ -56,6 +58,14 @@ var Search = {
|
||||
_queued_query : null,
|
||||
_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() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
@ -120,7 +130,7 @@ var Search = {
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
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);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
@ -259,11 +269,7 @@ var Search = {
|
||||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
||||
if (suffix === undefined) {
|
||||
suffix = '.txt';
|
||||
}
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
@ -385,6 +391,19 @@ var Search = {
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{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
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
@ -424,8 +443,12 @@ var Search = {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||
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
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
@ -456,7 +479,8 @@ var Search = {
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||
var text = Search.htmlToText(htmlText);
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 214 B |
Binary file not shown.
|
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);
|
||||
}
|
||||
});
|
||||
39
vmc/com.html
39
vmc/com.html
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware package" href="com.vmware.html" />
|
||||
<link rel="prev" title="Welcome to VMware Cloud on AWS Console API’s documentation!" href="index.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -220,6 +222,7 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.addons_client">com.vmware.vmc.orgs.sddcs.addons_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.dns_client">com.vmware.vmc.orgs.sddcs.dns_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networking_client">com.vmware.vmc.orgs.sddcs.networking_client module</a></li>
|
||||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networks_client">com.vmware.vmc.orgs.sddcs.networks_client module</a></li>
|
||||
@ -265,7 +268,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="index.html" class="btn btn-neutral" title="Welcome to VMware Cloud on AWS Console API’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 VMware Cloud on AWS Console API’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -291,26 +294,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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vmc package" href="com.vmware.vmc.html" />
|
||||
<link rel="prev" title="com package" href="com.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -225,6 +227,7 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.addons_client">com.vmware.vmc.orgs.sddcs.addons_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.dns_client">com.vmware.vmc.orgs.sddcs.dns_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networking_client">com.vmware.vmc.orgs.sddcs.networking_client module</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networks_client">com.vmware.vmc.orgs.sddcs.networks_client module</a></li>
|
||||
@ -260,37 +263,35 @@
|
||||
<dt id="com.vmware.vmc_client.Locale">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc_client.</code><code class="descname">Locale</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Locale" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc_client.Locale.set">
|
||||
<code class="descname">set</code><span class="sig-paren">(</span><em>vmc_locale</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Locale.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the locale for the session which is used for translating
|
||||
responses.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>vmc_locale</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a>) – The locale to be set. (required)</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.vmc.model.VmcLocale</td>
|
||||
</tr>
|
||||
<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.Unauthenticated</span></code>
|
||||
Unauthorized</td>
|
||||
</tr>
|
||||
<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>
|
||||
Forbidden</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>vmc_locale</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a>) – The locale to be set. (required)</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.VmcLocale" title="com.vmware.vmc.model_client.VmcLocale"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.VmcLocale</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.VmcLocale</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.Unauthenticated</span></code>
|
||||
Unauthorized</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>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -299,39 +300,38 @@ Forbidden</td>
|
||||
<dt id="com.vmware.vmc_client.Orgs">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc_client.</code><code class="descname">Orgs</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc_client.Orgs.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get details of organization</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">com.vmware.vmc.model.Organization</td>
|
||||
</tr>
|
||||
<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.Unauthenticated</span></code>
|
||||
Unauthorized</td>
|
||||
</tr>
|
||||
<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>
|
||||
Forbidden</td>
|
||||
</tr>
|
||||
<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>
|
||||
Organization doesn’t exist</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Organization</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.Unauthenticated</span></code>
|
||||
Unauthorized</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>
|
||||
Organization doesn’t exist</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -339,22 +339,22 @@ Organization doesn’t exist</td>
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc_client.Orgs.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return a list of all organizations the calling user (based on
|
||||
credential) is authorized on.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vmc_client.Orgs.list" title="com.vmware.vmc_client.Orgs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||||
</tr>
|
||||
<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.Unauthenticated</span></code>
|
||||
Unauthorized</td>
|
||||
</tr>
|
||||
<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>
|
||||
Forbidden</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vmc_client.Orgs.list" title="com.vmware.vmc_client.Orgs.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization" title="com.vmware.vmc.model_client.Organization"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Organization</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p></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.Unauthenticated</span></code>
|
||||
Unauthorized</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.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -364,14 +364,11 @@ Forbidden</td>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc_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.vmc_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -388,7 +385,7 @@ Forbidden</td>
|
||||
<a href="com.vmware.vmc.html" class="btn btn-neutral float-right" title="com.vmware.vmc package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.html" class="btn btn-neutral" title="com package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.html" class="btn btn-neutral float-left" title="com package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -414,26 +411,16 @@ Forbidden</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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vmc.orgs.sddcs.networks package" href="com.vmware.vmc.orgs.sddcs.networks.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs package" href="com.vmware.vmc.orgs.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -227,6 +229,172 @@
|
||||
</div>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.addons_client">
|
||||
<span id="com-vmware-vmc-orgs-sddcs-addons-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.addons_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.addons_client" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.addons_client.</code><code class="descname">Credentials</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX">
|
||||
<code class="descname">CREATE_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.create()</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX">
|
||||
<code class="descname">GET_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.get()</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.LIST_ADDON_TYPE_HCX">
|
||||
<code class="descname">LIST_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.LIST_ADDON_TYPE_HCX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.list()</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.UPDATE_ADDON_TYPE_HCX">
|
||||
<code class="descname">UPDATE_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.UPDATE_ADDON_TYPE_HCX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.update()</span></code></a>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em>, <em>credentials</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Associated a new add on credentials with the SDDC such as HCX</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Org id of the associated SDDC (required)</p></li>
|
||||
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
|
||||
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
|
||||
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a>) – Credentials creation payload (required)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</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.ConcurrentChange</span></code>
|
||||
Credentials with same name exists with in the scope of addOnType</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>
|
||||
Invalid input</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.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get credential details by name</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Org id of the associated SDDC (required)</p></li>
|
||||
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
|
||||
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – name of the credentials (required)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</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.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list">
|
||||
<code class="descname">list</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all the credentials assoicated with an addon type with in a SDDC</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Org id of the associated SDDC (required)</p></li>
|
||||
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
|
||||
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p></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.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em>, <em>name</em>, <em>credentials</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update credential details</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Org id of the associated SDDC (required)</p></li>
|
||||
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Id of the SDDC (required)</p></li>
|
||||
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add on type (required)</p></li>
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – name of the credentials (required)</p></li>
|
||||
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.UpdateCredentials" title="com.vmware.vmc.model_client.UpdateCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.UpdateCredentials</span></code></a>) – Credentials update payload (required)</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</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.InvalidRequest</span></code>
|
||||
Bad request</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>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.StubFactory">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.addons_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.vmc.orgs.sddcs.addons_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.dns_client">
|
||||
<span id="com-vmware-vmc-orgs-sddcs-dns-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.dns_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.dns_client" title="Permalink to this headline">¶</a></h2>
|
||||
@ -234,48 +402,41 @@
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Private">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.dns_client.</code><code class="descname">Private</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Private" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.dns_client.Private.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Private.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update the DNS records of management VMs to use private IP addresses</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthenticated</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Task</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.Unauthenticated</span></code>
|
||||
Unauthorized</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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>
|
||||
The sddc is not in a state that’s valid for updates or invalid body</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthorized</span></code>
|
||||
</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.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -284,48 +445,41 @@ Forbidden</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Public">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.dns_client.</code><code class="descname">Public</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Public" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.dns_client.Public.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Public.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update the DNS records of management VMs to use public IP addresses</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthenticated</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Task</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.Unauthenticated</span></code>
|
||||
Unauthorized</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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>
|
||||
The sddc is not in a state that’s valid for updates or invalid body</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthorized</span></code>
|
||||
</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.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -335,14 +489,11 @@ Forbidden</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.dns_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.vmc.orgs.sddcs.dns_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -352,44 +503,37 @@ Forbidden</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networking_client.</code><code class="descname">ConnectivityTests</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networking_client.ConnectivityTests.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve metadata for connectivity tests.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.ConnectivityValidationGroups" title="com.vmware.vmc.model_client.ConnectivityValidationGroups"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroups</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.ConnectivityValidationGroups</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthenticated</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ConnectivityValidationGroups" title="com.vmware.vmc.model_client.ConnectivityValidationGroups"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroups</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.ConnectivityValidationGroups</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.Unauthenticated</span></code>
|
||||
Unauthorized</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd 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.Unauthorized</span></code>
|
||||
</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>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -397,38 +541,34 @@ Forbidden</p>
|
||||
<code class="descname">post</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>request_info</em>, <em>action</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.post" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>ConnectivityValidationGroupResultWrapper will be available at
|
||||
task.params[‘test_result’].</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>request_info</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ConnectivityValidationGroup" title="com.vmware.vmc.model_client.ConnectivityValidationGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroup</span></code></a>) – request information (required)</li>
|
||||
<li><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If = ‘start’, start connectivity tests. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>request_info</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ConnectivityValidationGroup" title="com.vmware.vmc.model_client.ConnectivityValidationGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroup</span></code></a>) – request information (required)</p></li>
|
||||
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If = ‘start’, start connectivity tests. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Task</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthenticated</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Task</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.Unauthenticated</span></code>
|
||||
Unauthorized</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.Unauthorized</span></code>
|
||||
</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.Unauthorized</span></code>
|
||||
Forbidden</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -438,14 +578,11 @@ Forbidden</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networking_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.vmc.orgs.sddcs.networking_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -455,62 +592,55 @@ Forbidden</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Edges">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks_client.</code><code class="descname">Edges</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Edges" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks_client.Edges.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_type</em>, <em>prev_edge_id=None</em>, <em>start_index=None</em>, <em>page_size=None</em>, <em>sort_order_ascending=None</em>, <em>sort_by=None</em>, <em>filter=None</em>, <em>ld_rname=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Edges.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve information about all management and compute gateways and
|
||||
other routers (NSX Edges).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Retrieve records matching NSX Edge type (‘gatewayServices’ or
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Retrieve records matching NSX Edge type (‘gatewayServices’ or
|
||||
‘distributedRouter’). Specify gatewayServices to find management
|
||||
and compute gateways in your SDDC. (required)</li>
|
||||
<li><strong>prev_edge_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>) – Provide Edge ID as prevEdgeId to serve as reference for startIndex.
|
||||
(optional)</li>
|
||||
<li><strong>start_index</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>) – Start index for the current page. Default is 0. (optional)</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>) – Number of records per page. Default is 256. (optional)</li>
|
||||
<li><strong>sort_order_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>) – Set to true to fetch records in ascending sorted order. (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>) – Sort records using one of the column names (id, name, description,
|
||||
tenantId, size, enableFips). (optional)</li>
|
||||
<li><strong>filter</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 records matching the NSX Edge ID, name or description.
|
||||
(optional)</li>
|
||||
<li><strong>ld_rname</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>
|
||||
and compute gateways in your SDDC. (required)</p></li>
|
||||
<li><p><strong>prev_edge_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>) – Provide Edge ID as prevEdgeId to serve as reference for startIndex.
|
||||
(optional)</p></li>
|
||||
<li><p><strong>start_index</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>) – Start index for the current page. Default is 0. (optional)</p></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>) – Number of records per page. Default is 256. (optional)</p></li>
|
||||
<li><p><strong>sort_order_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>) – Set to true to fetch records in ascending sorted order. (optional)</p></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>) – Sort records using one of the column names (id, name, description,
|
||||
tenantId, size, enableFips). (optional)</p></li>
|
||||
<li><p><strong>filter</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 records matching the NSX Edge ID, name or description.
|
||||
(optional)</p></li>
|
||||
<li><p><strong>ld_rname</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>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.PagedEdgeList" title="com.vmware.vmc.model_client.PagedEdgeList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.PagedEdgeList</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.PagedEdgeList</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.PagedEdgeList" title="com.vmware.vmc.model_client.PagedEdgeList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.PagedEdgeList</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.PagedEdgeList</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -519,183 +649,160 @@ Not found. Requested object not found.</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks_client.</code><code class="descname">Logical</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks_client.Logical.create">
|
||||
<code class="descname">create</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>sddc_network</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a network in an SDDC.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>sddc_network</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>sddc_network</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>network_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete a network in an SDDC.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Logical Network Identifier (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Logical Network Identifier (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>network_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve information about a network in an SDDC.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Logical Network Identifier (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Logical Network Identifier (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.SddcNetwork</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.SddcNetwork</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.get_0">
|
||||
<code class="descname">get_0</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>page_size=None</em>, <em>start_index=None</em>, <em>prev_sddc_network_id=None</em>, <em>sort_order_ascending=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.get_0" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve all networks in an SDDC.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</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>) – Page size for pagination. (optional)</li>
|
||||
<li><strong>start_index</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>) – Start index of page. (optional)</li>
|
||||
<li><strong>prev_sddc_network_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>) – Previous logical network id. (optional)</li>
|
||||
<li><strong>sort_order_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>) – Sort order ascending. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></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>) – Page size for pagination. (optional)</p></li>
|
||||
<li><p><strong>start_index</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>) – Start index of page. (optional)</p></li>
|
||||
<li><p><strong>prev_sddc_network_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>) – Previous logical network id. (optional)</p></li>
|
||||
<li><p><strong>sort_order_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>) – Sort order ascending. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.DataPageSddcNetwork" title="com.vmware.vmc.model_client.DataPageSddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DataPageSddcNetwork</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.DataPageSddcNetwork</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DataPageSddcNetwork" title="com.vmware.vmc.model_client.DataPageSddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DataPageSddcNetwork</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.DataPageSddcNetwork</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>network_id</em>, <em>sddc_network</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Modify a network in an SDDC.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Logical Network Identifier (required)</li>
|
||||
<li><strong>sddc_network</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Logical Network Identifier (required)</p></li>
|
||||
<li><p><strong>sddc_network</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -705,14 +812,11 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks_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.vmc.orgs.sddcs.networks_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -729,7 +833,7 @@ Not found. Requested object not found.</p>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.html" class="btn btn-neutral" title="com.vmware.vmc.orgs package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -755,26 +859,16 @@ Not found. Requested object 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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.cgws package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.cgws package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vmc.orgs.sddcs.networks.edges package" href="com.vmware.vmc.orgs.sddcs.networks.edges.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs.sddcs.networks package" href="com.vmware.vmc.orgs.sddcs.networks.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -184,113 +186,98 @@
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.delete">
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete SDDC L2 VPN configuration.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>show_sensitive_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve SDDC L2 VPN configuration.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</li>
|
||||
<li><strong>show_sensitive_data</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>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</p></li>
|
||||
<li><p><strong>show_sensitive_data</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>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Nsxl2vpn</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Nsxl2vpn</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.update">
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>nsxl2vpn</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Modify SDDC L2 VPN configuration</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</li>
|
||||
<li><strong>nsxl2vpn</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compute Gateway Edge Identifier (required)</p></li>
|
||||
<li><p><strong>nsxl2vpn</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxl2vpn" title="com.vmware.vmc.model_client.Nsxl2vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxl2vpn</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -300,14 +287,11 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_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.vmc.orgs.sddcs.networks.cgws.l2vpn_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -324,7 +308,7 @@ Not found. Requested object not found.</p>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks.edges package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.html" class="btn btn-neutral" title="com.vmware.vmc.orgs.sddcs.networks package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs.networks package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -350,26 +334,16 @@ Not found. Requested object 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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.firewall package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs.sddcs.networks.edges package" href="com.vmware.vmc.orgs.sddcs.networks.edges.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,44 +188,37 @@
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_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.vmc.orgs.sddcs.networks.edges.firewall.config_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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>firewall_rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Append firewall rules for a management or compute gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>firewall_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRules" title="com.vmware.vmc.model_client.FirewallRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.FirewallRules</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>firewall_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallRules" title="com.vmware.vmc.model_client.FirewallRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.FirewallRules</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -231,32 +226,28 @@ Not found. Requested object not found.</p>
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete a specific firewall rule for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -264,38 +255,34 @@ Not found. Requested object not found.</p>
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve a specific firewall rule for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Nsxfirewallrule</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Nsxfirewallrule</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -303,33 +290,29 @@ Not found. Requested object not found.</p>
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em>, <em>nsxfirewallrule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Modify the specified firewall rule for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<li><strong>nsxfirewallrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
<li><p><strong>nsxfirewallrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule" title="com.vmware.vmc.model_client.Nsxfirewallrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxfirewallrule</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -339,14 +322,11 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_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.vmc.orgs.sddcs.networks.edges.firewall.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -363,7 +343,7 @@ Not found. Requested object not found.</p>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html" class="btn btn-neutral" title="com.vmware.vmc.orgs.sddcs.networks.edges package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs.networks.edges package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -389,26 +369,16 @@ Not found. Requested object 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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vmc.orgs.sddcs.networks.edges.nat package" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs.sddcs.networks.edges.firewall package" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,49 +188,42 @@
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_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.vmc.orgs.sddcs.networks.edges.l2vpn.config_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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve L2 VPN statistics for a compute gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.L2vpnStatusAndStats" title="com.vmware.vmc.model_client.L2vpnStatusAndStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.L2vpnStatusAndStats</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.L2vpnStatusAndStats</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.L2vpnStatusAndStats" title="com.vmware.vmc.model_client.L2vpnStatusAndStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.L2vpnStatusAndStats</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.L2vpnStatusAndStats</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -238,14 +233,11 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_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.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -262,7 +254,7 @@ Not found. Requested object not found.</p>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks.edges.nat package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html" class="btn btn-neutral" title="com.vmware.vmc.orgs.sddcs.networks.edges.firewall package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs.networks.edges.firewall package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -288,26 +280,16 @@ Not found. Requested object 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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.nat package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vmc.orgs.sddcs.networks.edges.statistics package" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,44 +188,37 @@
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_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.vmc.orgs.sddcs.networks.edges.nat.config_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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.add">
|
||||
<code class="descname">add</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>nat_rules</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Append a NAT rule for a management or compute gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>nat_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NatRules" title="com.vmware.vmc.model_client.NatRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NatRules</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>nat_rules</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NatRules" title="com.vmware.vmc.model_client.NatRules"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NatRules</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -231,32 +226,28 @@ Not found. Requested object not found.</p>
|
||||
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete the specific NAT rule for a management or compute gateway (NSX
|
||||
Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -264,33 +255,29 @@ Not found. Requested object not found.</p>
|
||||
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>rule_id</em>, <em>nsxnatrule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update the specific NAT rule for a management or compute gateway (NSX
|
||||
Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</li>
|
||||
<li><strong>nsxnatrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxnatrule" title="com.vmware.vmc.model_client.Nsxnatrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxnatrule</span></code></a>) – (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Rule Identifier. (required)</p></li>
|
||||
<li><p><strong>nsxnatrule</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxnatrule" title="com.vmware.vmc.model_client.Nsxnatrule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nsxnatrule</span></code></a>) – (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -300,14 +287,11 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_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.vmc.orgs.sddcs.networks.edges.nat.config_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -324,7 +308,7 @@ Not found. Requested object not found.</p>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks.edges.statistics package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html" class="btn btn-neutral" title="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -350,26 +334,16 @@ Not found. Requested object 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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks.edges.statistics package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="vmware package" href="vmware.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs.sddcs.networks.edges.nat package" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -186,52 +188,45 @@
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="descname">Firewall</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve firewall dashboard statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>interval</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>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>interval</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>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.DashboardStatistics</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -240,52 +235,45 @@ Not found. Requested object not found.</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="descname">Interface</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve interface dashboard statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>interval</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>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>interval</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>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.DashboardStatistics</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -294,52 +282,45 @@ Not found. Requested object not found.</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.</code><code class="descname">Ipsec</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>interval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve ipsec dashboard statistics for a management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>interval</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>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>interval</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>) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
|
||||
oneMonth, oneYear. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.DashboardStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DashboardStatistics" title="com.vmware.vmc.model_client.DashboardStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DashboardStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.DashboardStatistics</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -349,14 +330,11 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_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.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -366,54 +344,47 @@ Not found. Requested object not found.</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="descname">Internal</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>start_time=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve internal interface statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>start_time</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>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<li><strong>end_time</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>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>start_time</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>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
<li><p><strong>end_time</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>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.CbmStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.CbmStatistics</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -423,68 +394,58 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.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.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.</code><code class="descname">Uplink</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>start_time=None</em>, <em>end_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve uplink interface statistics for a management or compute
|
||||
gateway (NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>start_time</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>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<li><strong>end_time</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>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>start_time</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>) – Show statistics from this start time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
<li><p><strong>end_time</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>) – Show statistics until this end time (in milliseconds since epoch).
|
||||
(optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.CbmStatistics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.CbmStatistics</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -503,7 +464,7 @@ Not found. Requested object not found.</p>
|
||||
<a href="vmware.html" class="btn btn-neutral float-right" title="vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html" class="btn btn-neutral" title="com.vmware.vmc.orgs.sddcs.networks.edges.nat package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs.networks.edges.nat package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -529,26 +490,16 @@ Not found. Requested object 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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>com.vmware.vmc.orgs.sddcs.networks package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com.vmware.vmc.orgs.sddcs.networks.cgws package" href="com.vmware.vmc.orgs.sddcs.networks.cgws.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs.sddcs package" href="com.vmware.vmc.orgs.sddcs.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -228,57 +230,50 @@
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="descname">Peerconfig</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges_client.Peerconfig.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>objecttype</em>, <em>objectid</em>, <em>templateid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve IPsec VPN peer configuration for a management or compute
|
||||
gateway (NSX Edge). The response output is free form text generated as
|
||||
per the template specified as request parameter input.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>objecttype</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’.
|
||||
Required. (required)</li>
|
||||
<li><strong>objectid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site
|
||||
configuration. Required. (required)</li>
|
||||
<li><strong>templateid</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>) – Specify template identifier and response format. Valid values are
|
||||
‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>objecttype</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’.
|
||||
Required. (required)</p></li>
|
||||
<li><p><strong>objectid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site
|
||||
configuration. Required. (required)</p></li>
|
||||
<li><p><strong>templateid</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>) – Specify template identifier and response format. Valid values are
|
||||
‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">DynamicStructure</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>DynamicStructure</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -287,55 +282,48 @@ Not found. Requested object not found.</p>
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Status">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_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.vmc.orgs.sddcs.networks.edges_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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges_client.Status.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em>, <em>getlatest=None</em>, <em>detailed=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Status.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve the status of the specified management or compute gateway (NSX
|
||||
Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<li><strong>getlatest</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>) – If true, retrieve the status live from the gateway (NSX Edge). If
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
<li><p><strong>getlatest</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>) – If true, retrieve the status live from the gateway (NSX Edge). If
|
||||
false, retrieve the latest available status from database.
|
||||
(optional)</li>
|
||||
<li><strong>detailed</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>) – If true, retrieve detailed status per feature. If false, retrieve
|
||||
aggregated summary of status per feature. (optional)</li>
|
||||
(optional)</p></li>
|
||||
<li><p><strong>detailed</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>) – If true, retrieve detailed status per feature. If false, retrieve
|
||||
aggregated summary of status per feature. (optional)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.EdgeStatus" title="com.vmware.vmc.model_client.EdgeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.EdgeStatus</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.EdgeStatus</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.EdgeStatus" title="com.vmware.vmc.model_client.EdgeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.EdgeStatus</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.EdgeStatus</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -345,64 +333,54 @@ Not found. Requested object not found.</p>
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_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.vmc.orgs.sddcs.networks.edges_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||||
<p>Initialize StubFactoryBase</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics">
|
||||
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks.edges_client.</code><code class="descname">Vnics</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics" 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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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.vmc.orgs.sddcs.networks.edges_client.Vnics.get">
|
||||
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Retrieve all interfaces for the specified management or compute gateway
|
||||
(NSX Edge).</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</li>
|
||||
<li><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</li>
|
||||
<li><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier. (required)</p></li>
|
||||
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Sddc Identifier. (required)</p></li>
|
||||
<li><p><strong>edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Edge Identifier. (required)</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<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.vmc.html#com.vmware.vmc.model_client.Vnics" title="com.vmware.vmc.model_client.Vnics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Vnics</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">com.vmware.vmc.model.Vnics</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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.InvalidRequest</span></code>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vnics" title="com.vmware.vmc.model_client.Vnics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Vnics</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>com.vmware.vmc.model.Vnics</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.InvalidRequest</span></code>
|
||||
Bad request. Request object passed is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Authorization header not provided</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>
|
||||
<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. Requested object not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -421,7 +399,7 @@ Not found. Requested object not found.</p>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.cgws.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks.cgws package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.sddcs.html" class="btn btn-neutral" title="com.vmware.vmc.orgs.sddcs package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -447,26 +425,16 @@ Not found. Requested object 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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Interface definition language to python mapping for enumerated types — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>Interface definition language to python mapping for enumerated types — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -28,10 +35,6 @@
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -39,7 +42,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -56,7 +58,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -158,25 +160,24 @@ language. The special class contains class attributes which represent
|
||||
the values of the enumerated type.</p>
|
||||
<p>This documentation explains the following:</p>
|
||||
<ul class="simple">
|
||||
<li>How the class variables are defined in the module. This specifies the names that you can use in your program.</li>
|
||||
<li>How you instantiate a class to use it for communication with future versions of the service.</li>
|
||||
<li><p>How the class variables are defined in the module. This specifies the names that you can use in your program.</p></li>
|
||||
<li><p>How you instantiate a class to use it for communication with future versions of the service.</p></li>
|
||||
</ul>
|
||||
<div class="section" id="example-of-an-enumerated-type-documentation">
|
||||
<h2>Example of an enumerated type documentation<a class="headerlink" href="#example-of-an-enumerated-type-documentation" title="Permalink to this headline">¶</a></h2>
|
||||
<dl class="docutils">
|
||||
<dt><em>class</em> com.vmware.vapi.metadata_client. <strong>SourceType</strong> (string)</dt>
|
||||
<dd><p class="first">Bases: vmware.vapi.bindings.enum.Enum</p>
|
||||
<dl>
|
||||
<dt><em>class</em> com.vmware.vapi.metadata_client. <strong>SourceType</strong> (string)</dt><dd><p>Bases: vmware.vapi.bindings.enum.Enum</p>
|
||||
<p>Metadata source type</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See <a class="reference internal" href="#enumeration-description"><span class="std std-ref">enumerated type description page</span></a>.</p>
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See <a class="reference internal" href="#enumeration-description"><span class="std std-ref">enumerated type description page</span></a>.</p>
|
||||
</div>
|
||||
<p><strong>Parameters</strong> : <strong>string</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – String value for the SourceType instance.</p>
|
||||
<dl class="last docutils">
|
||||
<dt><strong>FILE</strong> = <em>SourceType(string=’FILE’)</em></dt>
|
||||
<dd>If the source is backed by a file.</dd>
|
||||
<dt><strong>REMOTE</strong> = <em>SourceType(string=’REMOTE’)</em></dt>
|
||||
<dd>If the source is backed by a remote service.</dd>
|
||||
<dl class="simple">
|
||||
<dt><strong>FILE</strong> = <em>SourceType(string=’FILE’)</em></dt><dd><p>If the source is backed by a file.</p>
|
||||
</dd>
|
||||
<dt><strong>REMOTE</strong> = <em>SourceType(string=’REMOTE’)</em></dt><dd><p>If the source is backed by a remote service.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
@ -186,7 +187,7 @@ the values of the enumerated type.</p>
|
||||
<p>The enumerated type classes are defined in python modules that your code
|
||||
imports. You can use these in your code.</p>
|
||||
<ol class="arabic simple">
|
||||
<li>If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.</li>
|
||||
<li><p>If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.</p></li>
|
||||
</ol>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SourceType is an enumerated type</span>
|
||||
<span class="kn">from</span> <span class="nn">com.vmware.vapi.metadata_client</span> <span class="kn">import</span> <span class="n">SourceType</span>
|
||||
@ -197,7 +198,7 @@ imports. You can use these in your code.</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ol class="arabic simple" start="2">
|
||||
<li>When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.</li>
|
||||
<li><p>When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.</p></li>
|
||||
</ol>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># SourceType is an enumerated type</span>
|
||||
<span class="kn">from</span> <span class="nn">com.vmware.vapi.metadata_client</span> <span class="kn">import</span> <span class="n">SourceType</span>
|
||||
@ -213,7 +214,7 @@ imports. You can use these in your code.</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ol class="arabic simple" start="3">
|
||||
<li>Sending a new enumerated type value to a server that has a newer version of the enumerated type.</li>
|
||||
<li><p>Sending a new enumerated type value to a server that has a newer version of the enumerated type.</p></li>
|
||||
</ol>
|
||||
<p>To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the
|
||||
enumerated type class.</p>
|
||||
@ -256,26 +257,16 @@ enumerated type class.</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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Index — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>Index — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -18,9 +18,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,10 +36,6 @@
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="#" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -40,7 +43,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -57,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -206,9 +208,23 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AddressFWSourceDestination">AddressFWSourceDestination (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent">Agent (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.AGENT_STATE_CUSTOMIZING">AGENT_STATE_CUSTOMIZING (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETED">AGENT_STATE_DELETED (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.AGENT_STATE_DELETING">AGENT_STATE_DELETING (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.AGENT_STATE_DEPLOYING">AGENT_STATE_DEPLOYING (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.AGENT_STATE_FAILED">AGENT_STATE_FAILED (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.AGENT_STATE_NOT_READY">AGENT_STATE_NOT_READY (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.AGENT_STATE_READY">AGENT_STATE_READY (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AmiInfo">AmiInfo (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AppliancesSummary">AppliancesSummary (class in com.vmware.vmc.model_client)</a>
|
||||
@ -264,6 +280,8 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.CloudProvider">CloudProvider (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Cluster">Cluster (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Cluster.cluster_id">cluster_id (com.vmware.vmc.model_client.Cluster attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS">CLUSTER_STATE_ADDING_HOSTS (com.vmware.vmc.model_client.Cluster attribute)</a>
|
||||
</li>
|
||||
@ -294,6 +312,8 @@
|
||||
<li><a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.reservations_client">com.vmware.vmc.orgs.reservations_client (module)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs">com.vmware.vmc.orgs.sddcs (module)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.addons_client">com.vmware.vmc.orgs.sddcs.addons_client (module)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.dns_client">com.vmware.vmc.orgs.sddcs.dns_client (module)</a>
|
||||
</li>
|
||||
@ -327,10 +347,10 @@
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client (module)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat_client (module)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics">com.vmware.vmc.orgs.sddcs.networks.edges.statistics (module)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client (module)</a>
|
||||
@ -389,9 +409,11 @@
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.sddcs_client.Convert">Convert (class in com.vmware.vmc.orgs.sddcs_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.create">create() (com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config method)</a>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create">create() (com.vmware.vmc.orgs.sddcs.addons_client.Credentials method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.create">(com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.networks_client.Logical.create">(com.vmware.vmc.orgs.sddcs.networks_client.Logical method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.sddcs_client.Clusters.create">(com.vmware.vmc.orgs.sddcs_client.Clusters method)</a>
|
||||
@ -407,11 +429,17 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.Subscriptions.create">(com.vmware.vmc.orgs_client.Subscriptions method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX">CREATE_ADDON_TYPE_HCX (com.vmware.vmc.orgs.sddcs.addons_client.Credentials attribute)</a>
|
||||
</li>
|
||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.client.create_vmc_client">create_vmc_client() (in module vmware.vapi.vmc.client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials">Credentials (class in com.vmware.vmc.orgs.sddcs.addons_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.CrlCertificates">CrlCertificates (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter">CSPSecurityContextFilter (class in vmware.vapi.vmc.csp_filter)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.CustomerEniInfo">CustomerEniInfo (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
@ -588,10 +616,12 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES_GCM">ENCRYPTION_AES_GCM (com.vmware.vmc.model_client.Vpn attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vpn.ENCRYPTION_TRIPLE_DES">ENCRYPTION_TRIPLE_DES (com.vmware.vmc.model_client.Vpn attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN">ENCRYPTION_UNKNOWN (com.vmware.vmc.model_client.Vpn attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN">ENCRYPTION_UNKNOWN (com.vmware.vmc.model_client.Vpn attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.EniInfo">EniInfo (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.ErrorResponse">ErrorResponse (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
@ -667,6 +697,8 @@
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.account_link_client.SddcConnections.get">(com.vmware.vmc.orgs.account_link_client.SddcConnections method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.reservations_client.Mw.get">(com.vmware.vmc.orgs.reservations_client.Mw method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get">(com.vmware.vmc.orgs.sddcs.addons_client.Credentials method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.get">(com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests method)</a>
|
||||
</li>
|
||||
@ -746,6 +778,8 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_ON_DEMAND">GET_0_OFFER_TYPE_ON_DEMAND (com.vmware.vmc.orgs_client.Subscriptions attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_TERM">GET_0_OFFER_TYPE_TERM (com.vmware.vmc.orgs_client.Subscriptions attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX">GET_ADDON_TYPE_HCX (com.vmware.vmc.orgs.sddcs.addons_client.Credentials attribute)</a>
|
||||
</li>
|
||||
<li><a href="vmware.vapi.vmc.html#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries">get_max_retries() (vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter method)</a>
|
||||
</li>
|
||||
@ -867,9 +901,11 @@
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.LicenceAclPermissions">LicenceAclPermissions (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.sddcs_client.Publicips.list">list() (com.vmware.vmc.orgs.sddcs_client.Publicips method)</a>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list">list() (com.vmware.vmc.orgs.sddcs.addons_client.Credentials method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.sddcs_client.Publicips.list">(com.vmware.vmc.orgs.sddcs_client.Publicips method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.subscriptions_client.OfferInstances.list">(com.vmware.vmc.orgs.subscriptions_client.OfferInstances method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.subscriptions_client.Products.list">(com.vmware.vmc.orgs.subscriptions_client.Products method)</a>
|
||||
@ -889,6 +925,8 @@
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.LIST_ADDON_TYPE_HCX">LIST_ADDON_TYPE_HCX (com.vmware.vmc.orgs.sddcs.addons_client.Credentials attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.LoadBalancerDashboardStats">LoadBalancerDashboardStats (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.html#com.vmware.vmc_client.Locale">Locale (class in com.vmware.vmc_client)</a>
|
||||
@ -948,10 +986,12 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_HOSTED">NETWORK_TYPE_HOSTED (com.vmware.vmc.model_client.LogicalNetwork attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_ROUTED">NETWORK_TYPE_ROUTED (com.vmware.vmc.model_client.LogicalNetwork attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.NetworkTemplate">NetworkTemplate (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.NetworkTemplate">NetworkTemplate (class in com.vmware.vmc.model_client)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials">NewCredentials (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxfirewallrule">Nsxfirewallrule (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
@ -962,6 +1002,8 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxnatrule">Nsxnatrule (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nsxsite">Nsxsite (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.NsxtAddons">NsxtAddons (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
@ -998,8 +1040,12 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PagedEdgeList">PagedEdgeList (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PagingInfo">PagingInfo (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.orgs_client.Sddcs.patch">patch() (com.vmware.vmc.orgs_client.Sddcs method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.html#com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig">Peerconfig (class in com.vmware.vmc.orgs.sddcs.networks.edges_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PopAgentXeniConnection">PopAgentXeniConnection (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PopAmiInfo">PopAmiInfo (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
@ -1019,8 +1065,6 @@
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.tbrs_client.Reservation.post">(com.vmware.vmc.orgs.tbrs_client.Reservation method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.dns_client.Private">Private (class in com.vmware.vmc.orgs.sddcs.dns_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.subscriptions_client.Products">Products (class in com.vmware.vmc.orgs.subscriptions_client)</a>
|
||||
@ -1029,6 +1073,30 @@
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED">PROJECT_STATE_DELETED (com.vmware.vmc.model_client.Organization attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Agent.provider">provider (com.vmware.vmc.model_client.Agent attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsAgent.provider">(com.vmware.vmc.model_client.AwsAgent attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCloudProvider.provider">(com.vmware.vmc.model_client.AwsCloudProvider attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsEsxHost.provider">(com.vmware.vmc.model_client.AwsEsxHost attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcConfig.provider">(com.vmware.vmc.model_client.AwsSddcConfig attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcResourceConfig.provider">(com.vmware.vmc.model_client.AwsSddcResourceConfig attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.CloudProvider.provider">(com.vmware.vmc.model_client.CloudProvider attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.EsxHost.provider">(com.vmware.vmc.model_client.EsxHost attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcConfig.provider">(com.vmware.vmc.model_client.SddcConfig attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcResourceConfig.provider">(com.vmware.vmc.model_client.SddcResourceConfig attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Sddc.PROVIDER_AWS">PROVIDER_AWS (com.vmware.vmc.model_client.Sddc attribute)</a>
|
||||
|
||||
<ul>
|
||||
@ -1138,6 +1206,8 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetworkDhcpConfig">SddcNetworkDhcpConfig (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetworkDhcpIpPool">SddcNetworkDhcpIpPool (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcPatchRequest">SddcPatchRequest (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcPublicIp">SddcPublicIp (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
@ -1170,8 +1240,6 @@
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DOCKER">SERVICE_DOCKER (com.vmware.vmc.model_client.PopServiceInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_LOG_COLLECTOR">SERVICE_FM_LOG_COLLECTOR (com.vmware.vmc.model_client.PopServiceInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_MANAGEMENT">SERVICE_FM_MANAGEMENT (com.vmware.vmc.model_client.PopServiceInfo attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR">SERVICE_FM_METRICS_COLLECTOR (com.vmware.vmc.model_client.PopServiceInfo attribute)</a>
|
||||
</li>
|
||||
@ -1225,23 +1293,41 @@
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SupportWindow.START_DAY_WEDNESDAY">START_DAY_WEDNESDAY (com.vmware.vmc.model_client.SupportWindow attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_ACTIVE">STATE_ACTIVE (com.vmware.vmc.model_client.AwsCustomerConnectedAccount attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcConnection.STATE_ACTIVE">(com.vmware.vmc.model_client.AwsSddcConnection attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_APPLIED">STATE_APPLIED (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_AVAILABLE">STATE_AVAILABLE (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_BROKEN">STATE_BROKEN (com.vmware.vmc.model_client.AwsCustomerConnectedAccount attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcConnection.STATE_BROKEN">(com.vmware.vmc.model_client.AwsSddcConnection attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vpn.STATE_CONNECTED">STATE_CONNECTED (com.vmware.vmc.model_client.Vpn attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED">STATE_DELETED (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsCustomerConnectedAccount.STATE_DELETED">STATE_DELETED (com.vmware.vmc.model_client.AwsCustomerConnectedAccount attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.AwsSddcConnection.STATE_DELETED">(com.vmware.vmc.model_client.AwsSddcConnection attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED">(com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING">STATE_DELETING (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED">STATE_DISCONNECTED (com.vmware.vmc.model_client.Vpn attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED">STATE_FAILED (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZING">STATE_INITIALIZING (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZATION">STATE_INITIALIZATION (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcTemplate.STATE_INUSE">STATE_INUSE (com.vmware.vmc.model_client.SddcTemplate attribute)</a>
|
||||
</li>
|
||||
@ -1301,6 +1387,8 @@
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.account_link_client.StubFactory">(class in com.vmware.vmc.orgs.account_link_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.html#com.vmware.vmc.orgs.reservations_client.StubFactory">(class in com.vmware.vmc.orgs.reservations_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.StubFactory">(class in com.vmware.vmc.orgs.sddcs.addons_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.dns_client.StubFactory">(class in com.vmware.vmc.orgs.sddcs.dns_client)</a>
|
||||
</li>
|
||||
@ -1429,9 +1517,11 @@
|
||||
<h2 id="U">U</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.dns_client.Private.update">update() (com.vmware.vmc.orgs.sddcs.dns_client.Private method)</a>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update">update() (com.vmware.vmc.orgs.sddcs.addons_client.Credentials method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.dns_client.Private.update">(com.vmware.vmc.orgs.sddcs.dns_client.Private method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.dns_client.Public.update">(com.vmware.vmc.orgs.sddcs.dns_client.Public method)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.cgws.html#com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config.update">(com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config method)</a>
|
||||
@ -1457,6 +1547,10 @@
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.html#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.UPDATE_ADDON_TYPE_HCX">UPDATE_ADDON_TYPE_HCX (com.vmware.vmc.orgs.sddcs.addons_client.Credentials attribute)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.html#com.vmware.vmc.model_client.UpdateCredentials">UpdateCredentials (class in com.vmware.vmc.model_client)</a>
|
||||
</li>
|
||||
<li><a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink">Uplink (class in com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
@ -1563,26 +1657,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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Welcome to VMware Cloud on AWS Console API’s documentation! — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>Welcome to VMware Cloud on AWS Console API’s documentation! — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,10 +36,6 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="com package" href="com.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -40,7 +43,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -57,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -165,6 +167,7 @@
|
||||
<li class="toctree-l9"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html">com.vmware.vmc.orgs.sddcs package</a><ul>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#subpackages">Subpackages</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.addons_client">com.vmware.vmc.orgs.sddcs.addons_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.dns_client">com.vmware.vmc.orgs.sddcs.dns_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networking_client">com.vmware.vmc.orgs.sddcs.networking_client module</a></li>
|
||||
<li class="toctree-l10"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networks_client">com.vmware.vmc.orgs.sddcs.networks_client module</a></li>
|
||||
@ -222,9 +225,9 @@
|
||||
<div class="section" id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
|
||||
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
|
||||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@ -263,26 +266,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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
BIN
vmc/objects.inv
BIN
vmc/objects.inv
Binary file not shown.
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Python Module Index — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>Python Module Index — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -31,10 +38,6 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -42,7 +45,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -59,7 +61,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -165,182 +167,193 @@
|
||||
<td>
|
||||
<a href="com.html#module-com"><code class="xref">com</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-2" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<code class="xref">com</code></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware"><code class="xref">com.vmware</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.html#module-com.vmware.vmc"><code class="xref">com.vmware.vmc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.html#module-com.vmware.vmc.model_client"><code class="xref">com.vmware.vmc.model_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs"><code class="xref">com.vmware.vmc.orgs</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.account_link_client"><code class="xref">com.vmware.vmc.orgs.account_link_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.reservations_client"><code class="xref">com.vmware.vmc.orgs.reservations_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs"><code class="xref">com.vmware.vmc.orgs.sddcs</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.addons_client"><code class="xref">com.vmware.vmc.orgs.sddcs.addons_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.dns_client"><code class="xref">com.vmware.vmc.orgs.sddcs.dns_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networking_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networking_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.html#module-com.vmware.vmc.orgs.sddcs.networks"><code class="xref">com.vmware.vmc.orgs.sddcs.networks</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.cgws.html#module-com.vmware.vmc.orgs.sddcs.networks.cgws"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.cgws</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.cgws.html#module-com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.dns_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.dns_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.firewall</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.nat</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.nat_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.statistics</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.html#module-com.vmware.vmc.orgs.sddcs.networks.edges_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks.edges_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.sddcs.html#module-com.vmware.vmc.orgs.sddcs.networks_client"><code class="xref">com.vmware.vmc.orgs.sddcs.networks_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.sddcs_client"><code class="xref">com.vmware.vmc.orgs.sddcs_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.storage_client"><code class="xref">com.vmware.vmc.orgs.storage_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.subscriptions_client"><code class="xref">com.vmware.vmc.orgs.subscriptions_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.orgs.html#module-com.vmware.vmc.orgs.tbrs_client"><code class="xref">com.vmware.vmc.orgs.tbrs_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.vmc.html#module-com.vmware.vmc.orgs_client"><code class="xref">com.vmware.vmc.orgs_client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<tr class="cg-2">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="com.vmware.html#module-com.vmware.vmc_client"><code class="xref">com.vmware.vmc_client</code></a></td><td>
|
||||
@ -350,26 +363,32 @@
|
||||
<strong>v</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-2" style="display: none" alt="-" /></td>
|
||||
id="toggle-3" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<a href="vmware.html#module-vmware"><code class="xref">vmware</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-4" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<code class="xref">vmware</code></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.html#module-vmware.vapi"><code class="xref">vmware.vapi</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc"><code class="xref">vmware.vapi.vmc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.client"><code class="xref">vmware.vapi.vmc.client</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-2">
|
||||
<tr class="cg-4">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="vmware.vapi.vmc.html#module-vmware.vapi.vmc.csp_filter"><code class="xref">vmware.vapi.vmc.csp_filter</code></a></td><td>
|
||||
@ -404,26 +423,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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Search — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>Search — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,17 @@
|
||||
|
||||
|
||||
|
||||
<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/searchtools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
@ -28,10 +36,6 @@
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="#" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -39,7 +43,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -56,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -187,27 +190,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/language_data.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>vmware package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="vmware.vapi package" href="vmware.vapi.html" />
|
||||
<link rel="prev" title="com.vmware.vmc.orgs.sddcs.networks.edges.statistics package" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -190,7 +192,7 @@
|
||||
<a href="vmware.vapi.html" class="btn btn-neutral float-right" title="vmware.vapi package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html" class="btn btn-neutral" title="com.vmware.vmc.orgs.sddcs.networks.edges.statistics package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs.networks.edges.statistics package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -216,26 +218,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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware.vapi package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>vmware.vapi package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -30,10 +37,6 @@
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="vmware.vapi.vmc package" href="vmware.vapi.vmc.html" />
|
||||
<link rel="prev" title="vmware package" href="vmware.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -41,7 +44,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -58,7 +60,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -189,7 +191,7 @@
|
||||
<a href="vmware.vapi.vmc.html" class="btn btn-neutral float-right" title="vmware.vapi.vmc package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="vmware.html" class="btn btn-neutral" title="vmware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="vmware.html" class="btn btn-neutral float-left" title="vmware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -215,26 +217,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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>vmware.vapi.vmc package — VMware Cloud on AWS Console API 1.3.1 documentation</title>
|
||||
<title>vmware.vapi.vmc package — VMware Cloud on AWS Console API 1.4.0 documentation</title>
|
||||
|
||||
|
||||
|
||||
@ -17,9 +17,16 @@
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
@ -29,10 +36,6 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="prev" title="vmware.vapi package" href="vmware.vapi.html" />
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -40,7 +43,6 @@
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
@ -57,7 +59,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
1.3.1
|
||||
1.4.0
|
||||
</div>
|
||||
|
||||
|
||||
@ -178,20 +180,16 @@
|
||||
VMC API</p>
|
||||
<p>Initialize VmcClient by creating a stub factory instance using a CSP
|
||||
Security context filter added to the filter chain of the connector</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests HTTP session instance</li>
|
||||
<li><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</li>
|
||||
<li><strong>vmc_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the VMC service</li>
|
||||
<li><strong>csp_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the CSP service</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests HTTP session instance</p></li>
|
||||
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</p></li>
|
||||
<li><p><strong>vmc_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the VMC service</p></li>
|
||||
<li><p><strong>csp_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL of the CSP service</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
@ -199,25 +197,21 @@ Security context filter added to the filter chain of the connector</p>
|
||||
<code class="descclassname">vmware.vapi.vmc.client.</code><code class="descname">create_vmc_client</code><span class="sig-paren">(</span><em>refresh_token</em>, <em>session=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.client.create_vmc_client" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helper method to create an instance of the VMC API client using the public
|
||||
VMC and CSP URL.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</li>
|
||||
<li><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Requests HTTP session instance. If not specified, then one
|
||||
is automatically created and used</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token obtained from CSP</p></li>
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Requests HTTP session instance. If not specified, then one
|
||||
is automatically created and used</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#vmware.vapi.vmc.client.VmcClient" title="vmware.vapi.vmc.client.VmcClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.vmc.client.VmcClient</span></code></a></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">VMC Client instance</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#vmware.vapi.vmc.client.VmcClient" title="vmware.vapi.vmc.client.VmcClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.vmc.client.VmcClient</span></code></a></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>VMC Client instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
@ -231,34 +225,28 @@ is automatically created and used</li>
|
||||
<p>CSP Security Context filter in API Provider chain adds the security
|
||||
context based on a refresh token to the execution context passed in.</p>
|
||||
<p>Initialize SecurityContextFilter</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||||
<li><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests Session object to use for making HTTP calls</li>
|
||||
<li><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token to use for obtaining an access token</li>
|
||||
<li><strong>refresh_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL that allows exchanging a refresh token for an
|
||||
access token</li>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">requests.Session</span></code>) – Requests Session object to use for making HTTP calls</p></li>
|
||||
<li><p><strong>refresh_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Refresh token to use for obtaining an access token</p></li>
|
||||
<li><p><strong>refresh_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – URL that allows exchanging a refresh token for an
|
||||
access token</p></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="method">
|
||||
<dt id="vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries">
|
||||
<code class="descname">get_max_retries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.get_max_retries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the max number of retries</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of retries</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Number of retries</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -267,18 +255,17 @@ access token</li>
|
||||
<dd><p>Retrieve security context. If this method is called after an error
|
||||
occured, then a new access token is obtained using the refresh token and
|
||||
a new security context is created.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Security context</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>on_error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether this method is called after getting an error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.SecurityContext</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Security context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
@ -286,19 +273,18 @@ a new security context is created.</p>
|
||||
<code class="descname">should_retry</code><span class="sig-paren">(</span><em>error_value</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter.should_retry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns whether the request should be retried or not based on the error
|
||||
specified.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns True if request should be retried in case the error is
|
||||
either Unauthenticated or Unauthorized else False</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>error_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>Returns True if request should be retried in case the error is
|
||||
either Unauthenticated or Unauthorized else False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -315,7 +301,7 @@ either Unauthenticated or Unauthorized else False</td>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
|
||||
<a href="vmware.vapi.html" class="btn btn-neutral" title="vmware.vapi package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="vmware.vapi.html" class="btn btn-neutral float-left" title="vmware.vapi package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
@ -341,26 +327,16 @@ either Unauthenticated or Unauthorized else False</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/language_data.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue
Block a user