diff --git a/vmc/_sources/index.rst.txt b/vmc/_sources/index.rst.txt index a570c456..1ef8a44c 100644 --- a/vmc/_sources/index.rst.txt +++ b/vmc/_sources/index.rst.txt @@ -1,5 +1,5 @@ .. vmc documentation master file, created by - sphinx-quickstart on Tue Nov 10 04:28:13 2020. + sphinx-quickstart on Wed Jan 13 04:30:17 2021. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/vmc/_static/basic.css b/vmc/_static/basic.css index 24a49f09..be19270e 100644 --- a/vmc/_static/basic.css +++ b/vmc/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/vmc/_static/doctools.js b/vmc/_static/doctools.js index 7d88f807..144884ea 100644 --- a/vmc/_static/doctools.js +++ b/vmc/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/vmc/_static/documentation_options.js b/vmc/_static/documentation_options.js index 84e13d14..3c54bd89 100644 --- a/vmc/_static/documentation_options.js +++ b/vmc/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.30.0', + VERSION: '1.31.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/vmc/_static/fonts/FontAwesome.otf b/vmc/_static/fonts/FontAwesome.otf deleted file mode 100644 index 401ec0f3..00000000 Binary files a/vmc/_static/fonts/FontAwesome.otf and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bold.eot b/vmc/_static/fonts/Lato/lato-bold.eot deleted file mode 100644 index 3361183a..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bold.eot and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bold.ttf b/vmc/_static/fonts/Lato/lato-bold.ttf deleted file mode 100644 index 29f691d5..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bold.ttf and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bold.woff b/vmc/_static/fonts/Lato/lato-bold.woff deleted file mode 100644 index c6dff51f..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bold.woff and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bold.woff2 b/vmc/_static/fonts/Lato/lato-bold.woff2 deleted file mode 100644 index bb195043..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bold.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bolditalic.eot b/vmc/_static/fonts/Lato/lato-bolditalic.eot deleted file mode 100644 index 3d415493..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bolditalic.eot and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bolditalic.ttf b/vmc/_static/fonts/Lato/lato-bolditalic.ttf deleted file mode 100644 index f402040b..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bolditalic.ttf and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bolditalic.woff b/vmc/_static/fonts/Lato/lato-bolditalic.woff deleted file mode 100644 index 88ad05b9..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bolditalic.woff and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-bolditalic.woff2 b/vmc/_static/fonts/Lato/lato-bolditalic.woff2 deleted file mode 100644 index c4e3d804..00000000 Binary files a/vmc/_static/fonts/Lato/lato-bolditalic.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-italic.eot b/vmc/_static/fonts/Lato/lato-italic.eot deleted file mode 100644 index 3f826421..00000000 Binary files a/vmc/_static/fonts/Lato/lato-italic.eot and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-italic.ttf b/vmc/_static/fonts/Lato/lato-italic.ttf deleted file mode 100644 index b4bfc9b2..00000000 Binary files a/vmc/_static/fonts/Lato/lato-italic.ttf and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-italic.woff b/vmc/_static/fonts/Lato/lato-italic.woff deleted file mode 100644 index 76114bc0..00000000 Binary files a/vmc/_static/fonts/Lato/lato-italic.woff and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-italic.woff2 b/vmc/_static/fonts/Lato/lato-italic.woff2 deleted file mode 100644 index 3404f37e..00000000 Binary files a/vmc/_static/fonts/Lato/lato-italic.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-regular.eot b/vmc/_static/fonts/Lato/lato-regular.eot deleted file mode 100644 index 11e3f2a5..00000000 Binary files a/vmc/_static/fonts/Lato/lato-regular.eot and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-regular.ttf b/vmc/_static/fonts/Lato/lato-regular.ttf deleted file mode 100644 index 74decd9e..00000000 Binary files a/vmc/_static/fonts/Lato/lato-regular.ttf and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-regular.woff b/vmc/_static/fonts/Lato/lato-regular.woff deleted file mode 100644 index ae1307ff..00000000 Binary files a/vmc/_static/fonts/Lato/lato-regular.woff and /dev/null differ diff --git a/vmc/_static/fonts/Lato/lato-regular.woff2 b/vmc/_static/fonts/Lato/lato-regular.woff2 deleted file mode 100644 index 3bf98433..00000000 Binary files a/vmc/_static/fonts/Lato/lato-regular.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Bold.woff b/vmc/_static/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb60000..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Bold.woff2 b/vmc/_static/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e231..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Light.woff b/vmc/_static/fonts/Roboto-Slab-Light.woff deleted file mode 100644 index 337d2871..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Light.woff and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Light.woff2 b/vmc/_static/fonts/Roboto-Slab-Light.woff2 deleted file mode 100644 index 20398aff..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Light.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Regular.woff b/vmc/_static/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63f..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Regular.woff2 b/vmc/_static/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5b..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Thin.woff b/vmc/_static/fonts/Roboto-Slab-Thin.woff deleted file mode 100644 index 6b30ea63..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Thin.woff and /dev/null differ diff --git a/vmc/_static/fonts/Roboto-Slab-Thin.woff2 b/vmc/_static/fonts/Roboto-Slab-Thin.woff2 deleted file mode 100644 index 328f5bb0..00000000 Binary files a/vmc/_static/fonts/Roboto-Slab-Thin.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot deleted file mode 100644 index 79dc8efe..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf deleted file mode 100644 index df5d1df2..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff deleted file mode 100644 index 6cb60000..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 deleted file mode 100644 index 7059e231..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot deleted file mode 100644 index 2f7ca78a..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf deleted file mode 100644 index eb52a790..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff deleted file mode 100644 index f815f63f..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff and /dev/null differ diff --git a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 deleted file mode 100644 index f2c76e5b..00000000 Binary files a/vmc/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/fontawesome-webfont.eot b/vmc/_static/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca9..00000000 Binary files a/vmc/_static/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/vmc/_static/fonts/fontawesome-webfont.svg b/vmc/_static/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845e..00000000 --- a/vmc/_static/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/vmc/_static/fonts/fontawesome-webfont.ttf b/vmc/_static/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2f..00000000 Binary files a/vmc/_static/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/vmc/_static/fonts/fontawesome-webfont.woff b/vmc/_static/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a4..00000000 Binary files a/vmc/_static/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/vmc/_static/fonts/fontawesome-webfont.woff2 b/vmc/_static/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc60..00000000 Binary files a/vmc/_static/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/lato-bold-italic.woff b/vmc/_static/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b9..00000000 Binary files a/vmc/_static/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/vmc/_static/fonts/lato-bold-italic.woff2 b/vmc/_static/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d804..00000000 Binary files a/vmc/_static/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/lato-bold.woff b/vmc/_static/fonts/lato-bold.woff deleted file mode 100644 index c6dff51f..00000000 Binary files a/vmc/_static/fonts/lato-bold.woff and /dev/null differ diff --git a/vmc/_static/fonts/lato-bold.woff2 b/vmc/_static/fonts/lato-bold.woff2 deleted file mode 100644 index bb195043..00000000 Binary files a/vmc/_static/fonts/lato-bold.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/lato-normal-italic.woff b/vmc/_static/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc0..00000000 Binary files a/vmc/_static/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/vmc/_static/fonts/lato-normal-italic.woff2 b/vmc/_static/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37e..00000000 Binary files a/vmc/_static/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/vmc/_static/fonts/lato-normal.woff b/vmc/_static/fonts/lato-normal.woff deleted file mode 100644 index ae1307ff..00000000 Binary files a/vmc/_static/fonts/lato-normal.woff and /dev/null differ diff --git a/vmc/_static/fonts/lato-normal.woff2 b/vmc/_static/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf98433..00000000 Binary files a/vmc/_static/fonts/lato-normal.woff2 and /dev/null differ diff --git a/vmc/_static/js/modernizr.min.js b/vmc/_static/js/modernizr.min.js deleted file mode 100644 index f65d4797..00000000 --- a/vmc/_static/js/modernizr.min.js +++ /dev/null @@ -1,4 +0,0 @@ -/* Modernizr 2.6.2 (Custom Build) | MIT & BSD - * Build: http://modernizr.com/download/#-fontface-backgroundsize-borderimage-borderradius-boxshadow-flexbox-hsla-multiplebgs-opacity-rgba-textshadow-cssanimations-csscolumns-generatedcontent-cssgradients-cssreflections-csstransforms-csstransforms3d-csstransitions-applicationcache-canvas-canvastext-draganddrop-hashchange-history-audio-video-indexeddb-input-inputtypes-localstorage-postmessage-sessionstorage-websockets-websqldatabase-webworkers-geolocation-inlinesvg-smil-svg-svgclippaths-touch-webgl-shiv-mq-cssclasses-addtest-prefixed-teststyles-testprop-testallprops-hasevent-prefixes-domprefixes-load - */ -;window.Modernizr=function(a,b,c){function D(a){j.cssText=a}function E(a,b){return D(n.join(a+";")+(b||""))}function F(a,b){return typeof a===b}function G(a,b){return!!~(""+a).indexOf(b)}function H(a,b){for(var d in a){var e=a[d];if(!G(e,"-")&&j[e]!==c)return b=="pfx"?e:!0}return!1}function I(a,b,d){for(var e in a){var f=b[a[e]];if(f!==c)return d===!1?a[e]:F(f,"function")?f.bind(d||b):f}return!1}function J(a,b,c){var d=a.charAt(0).toUpperCase()+a.slice(1),e=(a+" "+p.join(d+" ")+d).split(" ");return F(b,"string")||F(b,"undefined")?H(e,b):(e=(a+" "+q.join(d+" ")+d).split(" "),I(e,b,c))}function K(){e.input=function(c){for(var d=0,e=c.length;d',a,""].join(""),l.id=h,(m?l:n).innerHTML+=f,n.appendChild(l),m||(n.style.background="",n.style.overflow="hidden",k=g.style.overflow,g.style.overflow="hidden",g.appendChild(n)),i=c(l,a),m?l.parentNode.removeChild(l):(n.parentNode.removeChild(n),g.style.overflow=k),!!i},z=function(b){var c=a.matchMedia||a.msMatchMedia;if(c)return c(b).matches;var d;return y("@media "+b+" { #"+h+" { position: absolute; } }",function(b){d=(a.getComputedStyle?getComputedStyle(b,null):b.currentStyle)["position"]=="absolute"}),d},A=function(){function d(d,e){e=e||b.createElement(a[d]||"div"),d="on"+d;var f=d in e;return f||(e.setAttribute||(e=b.createElement("div")),e.setAttribute&&e.removeAttribute&&(e.setAttribute(d,""),f=F(e[d],"function"),F(e[d],"undefined")||(e[d]=c),e.removeAttribute(d))),e=null,f}var a={select:"input",change:"input",submit:"form",reset:"form",error:"img",load:"img",abort:"img"};return d}(),B={}.hasOwnProperty,C;!F(B,"undefined")&&!F(B.call,"undefined")?C=function(a,b){return B.call(a,b)}:C=function(a,b){return b in a&&F(a.constructor.prototype[b],"undefined")},Function.prototype.bind||(Function.prototype.bind=function(b){var c=this;if(typeof c!="function")throw new TypeError;var d=w.call(arguments,1),e=function(){if(this instanceof e){var a=function(){};a.prototype=c.prototype;var f=new a,g=c.apply(f,d.concat(w.call(arguments)));return Object(g)===g?g:f}return c.apply(b,d.concat(w.call(arguments)))};return e}),s.flexbox=function(){return J("flexWrap")},s.canvas=function(){var a=b.createElement("canvas");return!!a.getContext&&!!a.getContext("2d")},s.canvastext=function(){return!!e.canvas&&!!F(b.createElement("canvas").getContext("2d").fillText,"function")},s.webgl=function(){return!!a.WebGLRenderingContext},s.touch=function(){var c;return"ontouchstart"in a||a.DocumentTouch&&b instanceof DocumentTouch?c=!0:y(["@media (",n.join("touch-enabled),("),h,")","{#modernizr{top:9px;position:absolute}}"].join(""),function(a){c=a.offsetTop===9}),c},s.geolocation=function(){return"geolocation"in navigator},s.postmessage=function(){return!!a.postMessage},s.websqldatabase=function(){return!!a.openDatabase},s.indexedDB=function(){return!!J("indexedDB",a)},s.hashchange=function(){return A("hashchange",a)&&(b.documentMode===c||b.documentMode>7)},s.history=function(){return!!a.history&&!!history.pushState},s.draganddrop=function(){var a=b.createElement("div");return"draggable"in a||"ondragstart"in a&&"ondrop"in a},s.websockets=function(){return"WebSocket"in a||"MozWebSocket"in a},s.rgba=function(){return D("background-color:rgba(150,255,150,.5)"),G(j.backgroundColor,"rgba")},s.hsla=function(){return D("background-color:hsla(120,40%,100%,.5)"),G(j.backgroundColor,"rgba")||G(j.backgroundColor,"hsla")},s.multiplebgs=function(){return D("background:url(https://),url(https://),red url(https://)"),/(url\s*\(.*?){3}/.test(j.background)},s.backgroundsize=function(){return J("backgroundSize")},s.borderimage=function(){return J("borderImage")},s.borderradius=function(){return J("borderRadius")},s.boxshadow=function(){return J("boxShadow")},s.textshadow=function(){return b.createElement("div").style.textShadow===""},s.opacity=function(){return E("opacity:.55"),/^0.55$/.test(j.opacity)},s.cssanimations=function(){return J("animationName")},s.csscolumns=function(){return J("columnCount")},s.cssgradients=function(){var a="background-image:",b="gradient(linear,left top,right bottom,from(#9f9),to(white));",c="linear-gradient(left top,#9f9, white);";return D((a+"-webkit- ".split(" ").join(b+a)+n.join(c+a)).slice(0,-a.length)),G(j.backgroundImage,"gradient")},s.cssreflections=function(){return J("boxReflect")},s.csstransforms=function(){return!!J("transform")},s.csstransforms3d=function(){var a=!!J("perspective");return a&&"webkitPerspective"in g.style&&y("@media (transform-3d),(-webkit-transform-3d){#modernizr{left:9px;position:absolute;height:3px;}}",function(b,c){a=b.offsetLeft===9&&b.offsetHeight===3}),a},s.csstransitions=function(){return J("transition")},s.fontface=function(){var a;return y('@font-face {font-family:"font";src:url("https://")}',function(c,d){var e=b.getElementById("smodernizr"),f=e.sheet||e.styleSheet,g=f?f.cssRules&&f.cssRules[0]?f.cssRules[0].cssText:f.cssText||"":"";a=/src/i.test(g)&&g.indexOf(d.split(" ")[0])===0}),a},s.generatedcontent=function(){var a;return y(["#",h,"{font:0/0 a}#",h,':after{content:"',l,'";visibility:hidden;font:3px/1 a}'].join(""),function(b){a=b.offsetHeight>=3}),a},s.video=function(){var a=b.createElement("video"),c=!1;try{if(c=!!a.canPlayType)c=new Boolean(c),c.ogg=a.canPlayType('video/ogg; codecs="theora"').replace(/^no$/,""),c.h264=a.canPlayType('video/mp4; codecs="avc1.42E01E"').replace(/^no$/,""),c.webm=a.canPlayType('video/webm; codecs="vp8, vorbis"').replace(/^no$/,"")}catch(d){}return c},s.audio=function(){var a=b.createElement("audio"),c=!1;try{if(c=!!a.canPlayType)c=new Boolean(c),c.ogg=a.canPlayType('audio/ogg; codecs="vorbis"').replace(/^no$/,""),c.mp3=a.canPlayType("audio/mpeg;").replace(/^no$/,""),c.wav=a.canPlayType('audio/wav; codecs="1"').replace(/^no$/,""),c.m4a=(a.canPlayType("audio/x-m4a;")||a.canPlayType("audio/aac;")).replace(/^no$/,"")}catch(d){}return c},s.localstorage=function(){try{return localStorage.setItem(h,h),localStorage.removeItem(h),!0}catch(a){return!1}},s.sessionstorage=function(){try{return sessionStorage.setItem(h,h),sessionStorage.removeItem(h),!0}catch(a){return!1}},s.webworkers=function(){return!!a.Worker},s.applicationcache=function(){return!!a.applicationCache},s.svg=function(){return!!b.createElementNS&&!!b.createElementNS(r.svg,"svg").createSVGRect},s.inlinesvg=function(){var a=b.createElement("div");return a.innerHTML="",(a.firstChild&&a.firstChild.namespaceURI)==r.svg},s.smil=function(){return!!b.createElementNS&&/SVGAnimate/.test(m.call(b.createElementNS(r.svg,"animate")))},s.svgclippaths=function(){return!!b.createElementNS&&/SVGClipPath/.test(m.call(b.createElementNS(r.svg,"clipPath")))};for(var L in s)C(s,L)&&(x=L.toLowerCase(),e[x]=s[L](),v.push((e[x]?"":"no-")+x));return e.input||K(),e.addTest=function(a,b){if(typeof a=="object")for(var d in a)C(a,d)&&e.addTest(d,a[d]);else{a=a.toLowerCase();if(e[a]!==c)return e;b=typeof b=="function"?b():b,typeof f!="undefined"&&f&&(g.className+=" "+(b?"":"no-")+a),e[a]=b}return e},D(""),i=k=null,function(a,b){function k(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function l(){var a=r.elements;return typeof a=="string"?a.split(" "):a}function m(a){var b=i[a[g]];return b||(b={},h++,a[g]=h,i[h]=b),b}function n(a,c,f){c||(c=b);if(j)return c.createElement(a);f||(f=m(c));var g;return f.cache[a]?g=f.cache[a].cloneNode():e.test(a)?g=(f.cache[a]=f.createElem(a)).cloneNode():g=f.createElem(a),g.canHaveChildren&&!d.test(a)?f.frag.appendChild(g):g}function o(a,c){a||(a=b);if(j)return a.createDocumentFragment();c=c||m(a);var d=c.frag.cloneNode(),e=0,f=l(),g=f.length;for(;e",f="hidden"in a,j=a.childNodes.length==1||function(){b.createElement("a");var a=b.createDocumentFragment();return typeof a.cloneNode=="undefined"||typeof a.createDocumentFragment=="undefined"||typeof a.createElement=="undefined"}()}catch(c){f=!0,j=!0}})();var r={elements:c.elements||"abbr article aside audio bdi canvas data datalist details figcaption figure footer header hgroup mark meter nav output progress section summary time video",shivCSS:c.shivCSS!==!1,supportsUnknownElements:j,shivMethods:c.shivMethods!==!1,type:"default",shivDocument:q,createElement:n,createDocumentFragment:o};a.html5=r,q(b)}(this,b),e._version=d,e._prefixes=n,e._domPrefixes=q,e._cssomPrefixes=p,e.mq=z,e.hasEvent=A,e.testProp=function(a){return H([a])},e.testAllProps=J,e.testStyles=y,e.prefixed=function(a,b,c){return b?J(a,b,c):J(a,"pfx")},g.className=g.className.replace(/(^|\s)no-js(\s|$)/,"$1$2")+(f?" js "+v.join(" "):""),e}(this,this.document),function(a,b,c){function d(a){return"[object Function]"==o.call(a)}function e(a){return"string"==typeof a}function f(){}function g(a){return!a||"loaded"==a||"complete"==a||"uninitialized"==a}function h(){var a=p.shift();q=1,a?a.t?m(function(){("c"==a.t?B.injectCss:B.injectJs)(a.s,0,a.a,a.x,a.e,1)},0):(a(),h()):q=0}function i(a,c,d,e,f,i,j){function k(b){if(!o&&g(l.readyState)&&(u.r=o=1,!q&&h(),l.onload=l.onreadystatechange=null,b)){"img"!=a&&m(function(){t.removeChild(l)},50);for(var d in y[c])y[c].hasOwnProperty(d)&&y[c][d].onload()}}var j=j||B.errorTimeout,l=b.createElement(a),o=0,r=0,u={t:d,s:c,e:f,a:i,x:j};1===y[c]&&(r=1,y[c]=[]),"object"==a?l.data=c:(l.src=c,l.type=a),l.width=l.height="0",l.onerror=l.onload=l.onreadystatechange=function(){k.call(this,r)},p.splice(e,0,u),"img"!=a&&(r||2===y[c]?(t.insertBefore(l,s?null:n),m(k,j)):y[c].push(l))}function j(a,b,c,d,f){return q=0,b=b||"j",e(a)?i("c"==b?v:u,a,b,this.i++,c,d,f):(p.splice(this.i++,0,a),1==p.length&&h()),this}function k(){var a=B;return a.loader={load:j,i:0},a}var l=b.documentElement,m=a.setTimeout,n=b.getElementsByTagName("script")[0],o={}.toString,p=[],q=0,r="MozAppearance"in l.style,s=r&&!!b.createRange().compareNode,t=s?l:n.parentNode,l=a.opera&&"[object Opera]"==o.call(a.opera),l=!!b.attachEvent&&!l,u=r?"object":l?"script":"img",v=l?"script":u,w=Array.isArray||function(a){return"[object Array]"==o.call(a)},x=[],y={},z={timeout:function(a,b){return b.length&&(a.timeout=b[0]),a}},A,B;B=function(a){function b(a){var a=a.split("!"),b=x.length,c=a.pop(),d=a.length,c={url:c,origUrl:c,prefixes:a},e,f,g;for(f=0;f - + - + - com package — vmc 1.30.0 documentation + com package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
- 1.30.0 + 1.31.0
@@ -136,6 +138,8 @@ + +
  • Submodules
    • -
  • com.vmware.vmc.orgs.account_link_client module
    • -
  • com.vmware.vmc.orgs.reservations_client module
    • -
  • com.vmware.vmc.orgs.sddcs_client module
    • -
  • com.vmware.vmc.orgs.storage_client module
    • -
  • com.vmware.vmc.orgs.subscriptions_client module
    • -
  • com.vmware.vmc.orgs.tbrs_client module
    • +
  • com.vmware.vmc.orgs.account_link_client module
    • +
  • com.vmware.vmc.orgs.reservations_client module
    • +
  • com.vmware.vmc.orgs.sddcs_client module
    • +
  • com.vmware.vmc.orgs.storage_client module
    • +
  • com.vmware.vmc.orgs.subscriptions_client module
    • +
  • com.vmware.vmc.orgs.tbrs_client module
  • Submodules
    • -
  • com.vmware.vmc.model_client module
    • -
  • com.vmware.vmc.orgs_client module
    • +
  • com.vmware.vmc.model_client module
    • +
  • com.vmware.vmc.orgs_client module
  • Submodules
    • -
  • com.vmware.vmc_client module
    • +
  • com.vmware.vmc_client module
    • @@ -237,37 +241,29 @@
    - diff --git a/vmc/com.vmware.html b/vmc/com.vmware.html index 97dd49a1..36965cd1 100644 --- a/vmc/com.vmware.html +++ b/vmc/com.vmware.html @@ -3,11 +3,11 @@ - + - + - com.vmware package — vmc 1.30.0 documentation + com.vmware package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
    - 1.30.0 + 1.31.0
    @@ -93,7 +95,7 @@
  • com.vmware package
    • @@ -141,6 +143,8 @@ + +
  • Submodules
    • -
  • com.vmware.vmc.orgs.account_link_client module
    • -
  • com.vmware.vmc.orgs.reservations_client module
    • -
  • com.vmware.vmc.orgs.sddcs_client module
    • -
  • com.vmware.vmc.orgs.storage_client module
    • -
  • com.vmware.vmc.orgs.subscriptions_client module
    • -
  • com.vmware.vmc.orgs.tbrs_client module
    • +
  • com.vmware.vmc.orgs.account_link_client module
    • +
  • com.vmware.vmc.orgs.reservations_client module
    • +
  • com.vmware.vmc.orgs.sddcs_client module
    • +
  • com.vmware.vmc.orgs.storage_client module
    • +
  • com.vmware.vmc.orgs.subscriptions_client module
    • +
  • com.vmware.vmc.orgs.tbrs_client module
  • Submodules
    • -
  • com.vmware.vmc.model_client module
    • -
  • com.vmware.vmc.orgs_client module
    • +
  • com.vmware.vmc.model_client module
    • +
  • com.vmware.vmc.orgs_client module
    • @@ -232,120 +236,8 @@

    Submodules

    -
    -

    com.vmware.vmc_client module

    -
    -
    -class com.vmware.vmc_client.Locale(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -set(vmc_locale)
    -

    Sets the locale for the session which is used for translating -responses.

    -
    -
    Parameters
    -

    vmc_locale (com.vmware.vmc.model_client.VmcLocale) – The locale to be set. (required)

    -
    -
    Return type
    -

    com.vmware.vmc.model_client.VmcLocale

    -
    -
    Returns
    -

    com.vmware.vmc.model.VmcLocale

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc_client.Orgs(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -get(org)
    -

    Get details of organization

    -
    -
    Parameters
    -

    org (str) – Organization identifier (required)

    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Organization

    -
    -
    Returns
    -

    com.vmware.vmc.model.Organization

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Organization doesn’t exist

    -
    -
    -
    - -
    -
    -list()
    -

    Return a list of all organizations the calling user (based on -credential) is authorized on.

    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.Organization

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc_client.StubFactory(stub_config)
    -

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    -

    Initialize StubFactoryBase

    -
    -
    Parameters
    -

    stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

    -
    -
    -
    - +
    +

    com.vmware.vmc_client module

    @@ -354,37 +246,29 @@ Forbidden

    - diff --git a/vmc/com.vmware.vmc.html b/vmc/com.vmware.vmc.html index 5027dad4..d1e0f9d6 100644 --- a/vmc/com.vmware.vmc.html +++ b/vmc/com.vmware.vmc.html @@ -3,11 +3,11 @@ - + - + - com.vmware.vmc package — vmc 1.30.0 documentation + com.vmware.vmc package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
    - 1.30.0 + 1.31.0
    @@ -93,7 +95,7 @@
  • com.vmware package
    • @@ -141,6 +143,8 @@ + +
  • Submodules
    • -
  • com.vmware.vmc.orgs.account_link_client module
    • -
  • com.vmware.vmc.orgs.reservations_client module
    • -
  • com.vmware.vmc.orgs.sddcs_client module
    • -
  • com.vmware.vmc.orgs.storage_client module
    • -
  • com.vmware.vmc.orgs.subscriptions_client module
    • -
  • com.vmware.vmc.orgs.tbrs_client module
    • +
  • com.vmware.vmc.orgs.account_link_client module
    • +
  • com.vmware.vmc.orgs.reservations_client module
    • +
  • com.vmware.vmc.orgs.sddcs_client module
    • +
  • com.vmware.vmc.orgs.storage_client module
    • +
  • com.vmware.vmc.orgs.subscriptions_client module
    • +
  • com.vmware.vmc.orgs.tbrs_client module
    • @@ -225,5434 +229,11 @@

    Submodules

    -
    -

    com.vmware.vmc.model_client module

    -
    -
    -class com.vmware.vmc.model_client.AbstractEntity(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    +
    +

    com.vmware.vmc.model_client module

    -
    -
    Parameters
    -
      -

    • updated (datetime.datetime) –

      • -

    • user_id (str) – User id that last updated this record

      • -

    • updated_by_user_id (str) – User id that last updated this record

      • -

    • created (datetime.datetime) –

      • -

    • version (long) – Version of this entity format: int32

      • -

    • updated_by_user_name (str or None) – User name that last updated this record

      • -

    • user_name (str) – User name that last updated this record

      • -

    • id (str) – Unique ID for this entity

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.AccountLinkConfig(delay_account_link=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    delay_account_link (bool or None) – Boolean flag identifying whether account linking should be delayed -or not for the SDDC.

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.AccountLinkSddcConfig(customer_subnet_ids=None, connected_account_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • customer_subnet_ids (list of str or None) –

      • -

    • connected_account_id (str or None) – The ID of the customer connected account to work with.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.Agent(internal_ip=None, agent_url=None, management_ip=None, hostname_verifier_enabled=None, master=None, network_netmask=None, network_gateway=None, provider='Agent', cert_enabled=None, agent_state=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • internal_ip (str or None) – The internal IP address of the agent which is provided by the -underlying cloud provider

      • -

    • agent_url (str or None) – The accessible URL of the agent service, it is resolved to public -IP address from the Internet and private IP address within SDDC

      • -

    • management_ip (str or None) – The internal management IP address of the agent exposed to the -SDDC, which might be different from the internal IP

      • -

    • hostname_verifier_enabled (bool or None) – Boolean flag to indicate if the agent is using FQDN in the -certificate

      • -

    • master (bool or None) – Boolean flag to indicate if the agent is the master, only the -master Agent is accessible

      • -

    • network_netmask (str or None) – Network netmask of the agent

      • -

    • network_gateway (str or None) – Network gateway of the agent

      • -

    • provider (str) – The cloud provider

      • -

    • cert_enabled (bool or None) – Boolean flag to indicate if the agent is using CA signed -certificate

      • -

    • agent_state (str or None) –

      Possible values are:

      - -
      -

      Agent state

      -
      -

      • -
    -
    -
    -
    -
    -AGENT_STATE_CUSTOMIZING = 'CUSTOMIZING'
    -
    - -
    -
    -AGENT_STATE_DELETED = 'DELETED'
    -
    - -
    -
    -AGENT_STATE_DELETING = 'DELETING'
    -
    - -
    -
    -AGENT_STATE_DEPLOYING = 'DEPLOYING'
    -
    - -
    -
    -AGENT_STATE_FAILED = 'FAILED'
    -
    - -
    -
    -AGENT_STATE_NOT_READY = 'NOT_READY'
    -
    - -
    -
    -AGENT_STATE_READY = 'READY'
    -
    - -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AmiInfo(instance_type=None, region=None, id=None, name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    the AmiInfo used for deploying esx of the sddc

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • instance_type (str or None) – instance type of the esx ami

      • -

    • region (str or None) – the region of the esx ami

      • -

    • id (str or None) – the ami id for the esx

      • -

    • name (str or None) – the name of the esx ami

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.AvailableZoneInfo(subnets=None, id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • subnets (list of Subnet or None) –

      • -

    • id (str or None) – available zone id

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.AwsAgent(instance_id=None, key_pair=None, internal_ip=None, agent_url=None, management_ip=None, hostname_verifier_enabled=None, master=None, network_netmask=None, network_gateway=None, provider='AWS', cert_enabled=None, agent_state=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • instance_id (str or None) –

      • -

    • key_pair (AwsKeyPair or None) –

      • -

    • internal_ip (str or None) – The internal IP address of the agent which is provided by the -underlying cloud provider

      • -

    • agent_url (str or None) – The accessible URL of the agent service, it is resolved to public -IP address from the Internet and private IP address within SDDC

      • -

    • management_ip (str or None) – The internal management IP address of the agent exposed to the -SDDC, which might be different from the internal IP

      • -

    • hostname_verifier_enabled (bool or None) – Boolean flag to indicate if the agent is using FQDN in the -certificate

      • -

    • master (bool or None) – Boolean flag to indicate if the agent is the master, only the -master Agent is accessible

      • -

    • network_netmask (str or None) – Network netmask of the agent

      • -

    • network_gateway (str or None) – Network gateway of the agent

      • -

    • provider (str) – The cloud provider

      • -

    • cert_enabled (bool or None) – Boolean flag to indicate if the agent is using CA signed -certificate

      • -

    • agent_state (str or None) –

      Possible values are:

      - -
      -

      Agent state

      -
      -

      • -
    -
    -
    -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AwsCloudProvider(regions=None, provider='AWS')
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • regions (list of str or None) –

      • -

    • provider (str) – Name of the Cloud Provider

      • -
    -
    -
    -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AwsCompatibleSubnets(customer_available_zones=None, vpc_map=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • customer_available_zones (list of str or None) –

      • -

    • vpc_map ((dict of str and VpcInfoSubnets) or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.AwsCustomerConnectedAccount(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, policy_payer_arn=None, region_to_az_to_shadow_mapping=None, org_id=None, cf_stack_name=None, state=None, account_number=None, policy_service_arn=None, policy_external_id=None, policy_payer_linked_arn=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • updated (datetime.datetime) –

      • -

    • user_id (str) – User id that last updated this record

      • -

    • updated_by_user_id (str) – User id that last updated this record

      • -

    • created (datetime.datetime) –

      • -

    • version (long) – Version of this entity format: int32

      • -

    • updated_by_user_name (str or None) – User name that last updated this record

      • -

    • user_name (str) – User name that last updated this record

      • -

    • id (str) – Unique ID for this entity

      • -

    • policy_payer_arn (str or None) –

      • -

    • region_to_az_to_shadow_mapping ((dict of str and (dict of str and str)) or None) – Provides a map of regions to availability zones from the shadow -account’s perspective

      • -

    • org_id (str or None) –

      • -

    • cf_stack_name (str or None) –

      • -

    • state (str or None) –

      Possible values are:

      - -

      • -

    • account_number (str or None) –

      • -

    • policy_service_arn (str or None) –

      • -

    • policy_external_id (str or None) –

      • -

    • policy_payer_linked_arn (str or None) –

      • -
    -
    -
    -
    -
    -STATE_ACTIVE = 'ACTIVE'
    -
    - -
    -
    -STATE_BROKEN = 'BROKEN'
    -
    - -
    -
    -STATE_DELETED = 'DELETED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AwsEsxHost(internal_public_ip_pool=None, name=None, availability_zone=None, esx_id=None, hostname=None, provider='AWS', instance_type=None, mac_address=None, custom_properties=None, esx_state=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AwsKeyPair(key_name=None, key_fingerprint=None, key_material=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • key_name (str or None) –

      • -

    • key_fingerprint (str or None) –

      • -

    • key_material (str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.AwsKmsInfo(amazon_resource_name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    amazon_resource_name (str) – The ARN associated with the customer master key for this cluster.

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.AwsSddcConfig(region=None, msft_license_config=None, vpc_cidr=None, host_instance_type=None, skip_creating_vxlan=None, vxlan_subnet=None, size=None, storage_capacity=None, name=None, account_link_sddc_config=None, sddc_id=None, num_hosts=None, sddc_type=None, account_link_config=None, provider='AWS', sso_domain=None, sddc_template_id=None, deployment_type=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • region (str) –

      • -

    • msft_license_config (MsftLicensingConfig or None) – Indicates the desired licensing support, if any, of Microsoft -software.

      • -

    • vpc_cidr (str or None) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.

      • -

    • host_instance_type (HostInstanceTypes or None) – The instance type for the esx hosts in the primary cluster of the -SDDC.

      • -

    • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

      • -

    • vxlan_subnet (str or None) – VXLAN IP subnet in CIDR for compute gateway

      • -

    • size (str or None) –

      Possible values are:

      - -

      The size of the vCenter and NSX appliances. “large” sddcSize -corresponds to a ‘large’ vCenter appliance and ‘large’ NSX -appliance. ‘medium’ sddcSize corresponds to ‘medium’ vCenter -appliance and ‘medium’ NSX appliance. Value defaults to ‘medium’.

      -

      • -

    • storage_capacity (long or None) – The storage capacity value to be requested for the sddc primary -cluster, in GiBs. If provided, instead of using the direct-attached -storage, a capacity value amount of seperable storage will be used. -format: int64

      • -

    • name (str) –

      • -

    • account_link_sddc_config (list of AccountLinkSddcConfig or None) – A list of the SDDC linking configurations to use.

      • -

    • sddc_id (str or None) – If provided, will be assigned as SDDC id of the provisioned SDDC. -format: UUID

      • -

    • num_hosts (long) –

      • -

    • sddc_type (str or None) – Denotes the sddc type , if the value is null or empty, the type is -considered as default.

      • -

    • account_link_config (AccountLinkConfig or None) – The account linking configuration, we will keep this one and remove -accountLinkSddcConfig finally.

      • -

    • provider (str) –

      Possible values are:

      - -

      Determines what additional properties are available based on cloud -provider.

      -

      • -

    • sso_domain (str or None) – The SSO domain name to use for vSphere users. If not specified, -vmc.local will be used.

      • -

    • sddc_template_id (str or None) – If provided, configuration from the template will applied to the -provisioned SDDC. format: UUID

      • -

    • deployment_type (str or None) –

      Possible values are:

      - -

      Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is -SingleAZ.

      -

      • -
    -
    -
    -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AwsSddcConnection(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, cidr_block_subnet=None, connected_account_id=None, eni_group=None, subnet_id=None, cgw_present=None, org_id=None, sddc_id=None, cidr_block_vpc=None, connection_order=None, state=None, subnet_availability_zone=None, vpc_id=None, customer_eni_infos=None, default_route_table=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • updated (datetime.datetime) –

      • -

    • user_id (str) – User id that last updated this record

      • -

    • updated_by_user_id (str) – User id that last updated this record

      • -

    • created (datetime.datetime) –

      • -

    • version (long) – Version of this entity format: int32

      • -

    • updated_by_user_name (str or None) – User name that last updated this record

      • -

    • user_name (str) – User name that last updated this record

      • -

    • id (str) – Unique ID for this entity

      • -

    • cidr_block_subnet (str or None) – The CIDR block of the customer’s subnet this link is in.

      • -

    • connected_account_id (str or None) – The corresponding connected (customer) account UUID this connection -is attached to.

      • -

    • eni_group (str or None) – Which group the ENIs belongs to. (deprecated)

      • -

    • subnet_id (str or None) – The ID of the subnet this link is to.

      • -

    • cgw_present (bool or None) – Determines whether the CGW is present in this connection set or -not. Used for multi-az deployments.

      • -

    • org_id (str or None) – The org this link belongs to.

      • -

    • sddc_id (str or None) – The SDDC this link is used for.

      • -

    • cidr_block_vpc (str or None) – The CIDR block of the customer’s VPC.

      • -

    • connection_order (long or None) – The order of the connection

      • -

    • state (str or None) –

      Possible values are:

      - -
      -

      The state of the connection.

      -
      -

      • -

    • subnet_availability_zone (str or None) – Which availability zone is this connection in?

      • -

    • vpc_id (str or None) – The VPC ID of the subnet this link is to.

      • -

    • customer_eni_infos (list of CustomerEniInfo or None) – A list of all ENIs used for this connection.

      • -

    • default_route_table (str or None) – The default routing table in the customer’s VPC.

      • -
    -
    -
    -
    -
    -STATE_ACTIVE = 'ACTIVE'
    -
    - -
    -
    -STATE_BROKEN = 'BROKEN'
    -
    - -
    -
    -STATE_DELETED = 'DELETED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AwsSddcResourceConfig(backup_restore_bucket=None, public_ip_pool=None, vpc_info=None, kms_vpc_endpoint=None, max_num_public_ip=None, account_link_sddc_config=None, vsan_encryption_config=None, vpc_info_peered_agent=None, mgmt_appliance_network_name=None, mgw_id=None, nsx_mgr_url=None, nsx_cloud_audit_password=None, management_ds=None, nsx_api_public_endpoint_url=None, clusters=None, sddc_networks=None, nsx_mgr_management_ip=None, nsx_cloud_audit=None, esx_cluster_id=None, vc_public_ip=None, vc_url=None, esx_hosts=None, vc_management_ip=None, management_rp=None, witness_availability_zone=None, sddc_size=None, nsx_controller_ips=None, esx_host_subnet=None, sso_domain=None, deployment_type=None, msft_license_config=None, dns_with_management_vm_private_ip=None, nsxt=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, custom_properties=None, cloud_password=None, provider='AWS', nsx_cloud_admin_password=None, cloud_username=None, vc_instance_id=None, cloud_user_group=None, skip_creating_vxlan=None, sddc_manifest=None, vxlan_subnet=None, region=None, sddc_id=None, pop_agent_xeni_connection=None, nsx_cloud_admin=None, nsxt_addons=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • backup_restore_bucket (str or None) –

      • -

    • public_ip_pool (list of SddcPublicIp or None) –

      • -

    • vpc_info (VpcInfo or None) –

      • -

    • kms_vpc_endpoint (KmsVpcEndpoint or None) –

      • -

    • max_num_public_ip (long or None) – maximum number of public IP that user can allocate.

      • -

    • account_link_sddc_config (list of SddcLinkConfig or None) –

      • -

    • vsan_encryption_config (VsanEncryptionConfig or None) –

      • -

    • vpc_info_peered_agent (VpcInfo or None) –

      • -

    • mgmt_appliance_network_name (str or None) – Name for management appliance network.

      • -

    • mgw_id (str or None) – Management Gateway Id

      • -

    • nsx_mgr_url (str or None) – URL of the NSX Manager

      • -

    • nsx_cloud_audit_password (str or None) – NSX cloud audit Password

      • -

    • management_ds (str or None) – The ManagedObjectReference of the management Datastore

      • -

    • nsx_api_public_endpoint_url (str or None) – nsx api entire base url

      • -

    • clusters (list of Cluster or None) – List of clusters in the SDDC.

      • -

    • sddc_networks (list of str or None) –

      • -

    • nsx_mgr_management_ip (str or None) – NSX Manager internal management IP

      • -

    • nsx_cloud_audit (str or None) – NSX cloud audit user name

      • -

    • esx_cluster_id (str or None) – Cluster Id to add ESX workflow

      • -

    • vc_public_ip (str or None) – vCenter public IP

      • -

    • vc_url (str or None) – URL of the vCenter server

      • -

    • esx_hosts (list of AwsEsxHost or None) –

      • -

    • vc_management_ip (str or None) – vCenter internal management IP

      • -

    • management_rp (str or None) –

      • -

    • witness_availability_zone (str or None) – Availability zone where the witness node is provisioned for a -MultiAZ SDDC. This is null for a SingleAZ SDDC.

      • -

    • sddc_size (SddcSize or None) –

      • -

    • nsx_controller_ips (list of str or None) – List of Controller IPs

      • -

    • esx_host_subnet (str or None) – ESX host subnet

      • -

    • sso_domain (str or None) – The SSO domain name to use for vSphere users

      • -

    • deployment_type (str or None) –

      Possible values are:

      - -
      -

      Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.

      -
      -

      • -

    • msft_license_config (MsftLicensingConfig or None) – The Microsoft license status of this SDDC.

      • -

    • dns_with_management_vm_private_ip (bool or None) – if true, use the private IP addresses to register DNS records for -the management VMs

      • -

    • nsxt (bool or None) – if true, NSX-T UI is enabled.

      • -

    • psc_management_ip (str or None) – PSC internal management IP

      • -

    • psc_url (str or None) – URL of the PSC server

      • -

    • cgws (list of str or None) –

      • -

    • availability_zones (list of str or None) – Availability zones over which esx hosts are provisioned. MultiAZ -SDDCs will have hosts provisioned over two availability zones while -SingleAZ SDDCs will provision over one.

      • -

    • custom_properties ((dict of str and str) or None) –

      • -

    • cloud_password (str or None) – Password for vCenter SDDC administrator

      • -

    • provider (str) –

      Possible values are:

      - -
      -

      Discriminator for additional properties

      -
      -

      • -

    • nsx_cloud_admin_password (str or None) – NSX cloud admin password

      • -

    • cloud_username (str or None) – Username for vCenter SDDC administrator

      • -

    • vc_instance_id (str or None) – unique id of the vCenter server

      • -

    • cloud_user_group (str or None) – Group name for vCenter SDDC administrator

      • -

    • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

      • -

    • sddc_manifest (SddcManifest or None) –

      • -

    • vxlan_subnet (str or None) – VXLAN IP subnet

      • -

    • region (str or None) – region in which sddc is deployed

      • -

    • sddc_id (str or None) – sddc identifier

      • -

    • pop_agent_xeni_connection (PopAgentXeniConnection or None) –

      • -

    • nsx_cloud_admin (str or None) – NSX cloud admin user name

      • -

    • nsxt_addons (NsxtAddons or None) –

      • -
    -
    -
    -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.AwsSubnet(connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, subnet_cidr_block=None, is_compatible=None, vpc_id=None, vpc_cidr_block=None, name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • connected_account_id (str or None) – The connected account ID this subnet is accessible through. This is -an internal ID formatted as a UUID specific to Skyscraper.

      • -

    • region_name (str or None) – The region this subnet is in, usually in the form of country code, -general location, and a number (ex. us-west-2).

      • -

    • availability_zone (str or None) – The availability zone this subnet is in, which should be the region -name plus one extra letter (ex. us-west-2a).

      • -

    • subnet_id (str or None) – The subnet ID in AWS, provided in the form ‘subnet-######’.

      • -

    • subnet_cidr_block (str or None) – The CIDR block of the subnet, in the form of ‘#.#.#.#/#’.

      • -

    • is_compatible (bool or None) – Flag indicating whether this subnet is compatible. If true, this is -a valid choice for the customer to deploy a SDDC in.

      • -

    • vpc_id (str or None) – The VPC ID the subnet resides in within AWS. Tends to be -‘vpc-#######’.

      • -

    • vpc_cidr_block (str or None) – The CIDR block of the VPC, in the form of ‘#.#.#.#/#’.

      • -

    • name (str or None) – Optional field (may not be provided by AWS), indicates the found -name tag for the subnet.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.CloudProvider(provider='CloudProvider')
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    provider (str) – Name of the Cloud Provider

    -
    -
    -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.Cluster(esx_host_list=None, msft_license_config=None, cluster_state=None, aws_kms_info=None, cluster_capacity=None, esx_host_info=None, host_cpu_cores_count=None, cluster_id=None, cluster_name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -CLUSTER_STATE_ADDING_HOSTS = 'ADDING_HOSTS'
    -
    - -
    -
    -CLUSTER_STATE_DEPLOYING = 'DEPLOYING'
    -
    - -
    -
    -CLUSTER_STATE_FAILED = 'FAILED'
    -
    - -
    -
    -CLUSTER_STATE_READY = 'READY'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ClusterConfig(host_cpu_cores_count=None, host_instance_type=None, storage_capacity=None, msft_license_config=None, num_hosts=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • host_cpu_cores_count (long or None) – Customize CPU cores on hosts in a cluster. Specify number of cores -to be enabled on hosts in a cluster. format: int32

      • -

    • host_instance_type (HostInstanceTypes or None) – The instance type for the esx hosts added to this cluster.

      • -

    • storage_capacity (long or None) – For EBS-backed instances only, the requested storage capacity in -GiB. format: int64

      • -

    • msft_license_config (MsftLicensingConfig or None) – The desired Microsoft license status to apply to this cluster.

      • -

    • num_hosts (long) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ClusterReconfigureParams(storage_capacity=None, bias=None, num_hosts=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • storage_capacity (long or None) – The final desired storage capacity after reconfiguring the cluster -in GiB. format: int64

      • -

    • bias (str or None) – Bias value as obtained from the storage constraints call.

      • -

    • num_hosts (long) – Number of hosts in the cluster after reconfiguring. format: int32

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ComputeGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, logical_networks=None, nat_rules=None, l2_vpn=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • public_ip (SddcPublicIp or None) –

      • -

    • primary_dns (str or None) –

      • -

    • secondary_dns (str or None) –

      • -

    • firewall_rules (list of FirewallRule or None) –

      • -

    • vpns (list of Vpn or None) –

      • -

    • logical_networks (list of LogicalNetwork or None) –

      • -

    • nat_rules (list of NatRule or None) –

      • -

    • l2_vpn (vmware.vapi.struct.VapiStruct or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ConfigSpec(expiry_in_days=None, availability=None, sddc_sizes=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Represents a configuration spec for any sddc provision operation.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • expiry_in_days (long or None) – Indicates after how many days the sddc should expire

      • -

    • availability ((dict of str and list of InstanceTypeConfig) or None) – Map of region to instance types available in that region

      • -

    • sddc_sizes (list of str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ConnectivityAgentValidation(source=None, type=None, ports=None, path=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -SOURCE_SRM = 'SRM'
    -
    - -
    -
    -SOURCE_VCENTER = 'VCENTER'
    -
    - -
    -
    -SOURCE_VR = 'VR'
    -
    - -
    -
    -TYPE_CONNECTIVITY = 'CONNECTIVITY'
    -
    - -
    -
    -TYPE_CURL = 'CURL'
    -
    - -
    -
    -TYPE_DNS = 'DNS'
    -
    - -
    -
    -TYPE_PING = 'PING'
    -
    - -
    -
    -TYPE_TRACEROUTE = 'TRACEROUTE'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ConnectivityValidationGroup(id=None, name=None, sub_groups=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -ID_DRAAS = 'DRAAS'
    -
    - -
    -
    -ID_HLM = 'HLM'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ConnectivityValidationGroups(groups=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    groups (list of ConnectivityValidationGroup or None) – List of groups.

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ConnectivityValidationInput(id=None, value=None, label=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • id (str or None) –

      Possible values are:

      - -

      input value type, i.e. HOSTNAME_OR_IP, HOST_IP, HOSTNAME. Accept -FQDN or IP address as input value when id = HOSTNAME_OR_IP, accept -FQDN ONLY when id = HOSTNAME, accept IP address ONLY when id = -HOST_IP.

      -

      • -

    • value (str or None) – the FQDN or IP address to run the test against, use #primary-dns -or #secondary-dns as the on-prem primary/secondary DNS server IP.

      • -

    • label (str or None) – (Optional, for UI display only) input value label.

      • -
    -
    -
    -
    -
    -ID_HOSTNAME = 'HOSTNAME'
    -
    - -
    -
    -ID_HOSTNAME_OR_IP = 'HOSTNAME_OR_IP'
    -
    - -
    -
    -ID_HOST_IP = 'HOST_IP'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ConnectivityValidationSubGroup(inputs=None, tests=None, label=None, help=None, id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -ID_ACTIVE_DIRECTORY = 'ACTIVE_DIRECTORY'
    -
    - -
    -
    -ID_DRAAS_ONPREM_PSC = 'DRAAS_ONPREM_PSC'
    -
    - -
    -
    -ID_DRAAS_ONPREM_SRM = 'DRAAS_ONPREM_SRM'
    -
    - -
    -
    -ID_DRAAS_ONPREM_VCENTER = 'DRAAS_ONPREM_VCENTER'
    -
    - -
    -
    -ID_DRAAS_ONPREM_VR = 'DRAAS_ONPREM_VR'
    -
    - -
    -
    -ID_ONPREM_ESX = 'ONPREM_ESX'
    -
    - -
    -
    -ID_ONPREM_PSC = 'ONPREM_PSC'
    -
    - -
    -
    -ID_ONPREM_VCENTER = 'ONPREM_VCENTER'
    -
    - -
    -
    -ID_PRIMARY_DNS = 'PRIMARY_DNS'
    -
    - -
    -
    -ID_SECONDARY_DNS = 'SECONDARY_DNS'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.CustomerEniInfo(secondary_ip_addresses=None, eni_id=None, primary_ip_address=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Indicates a single cross-account ENI and its characteristics.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • secondary_ip_addresses (list of str or None) – Indicates list of secondary IP created for this ENI.

      • -

    • eni_id (str or None) – Interface ID on customer account.

      • -

    • primary_ip_address (str or None) – Indicates primary address of the ENI.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.EbsBackedVsanConfig(instance_type=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    information for EBS-backed VSAN configuration

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    instance_type (str or None) – instance type for EBS-backed VSAN configuration

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.EnablementInfo(enabled=None, name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • enabled (bool) –

      • -

    • name (str) – Add-on name, for example “hcx”, “drass”, skynet”. If it is -“default”, the value of enabled is for default settings of future -add-ons.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.EniInfo(subnet_id=None, id=None, security_group_id=None, private_ip=None, mac_address=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Information of the x-eni created.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • subnet_id (str or None) – Subnet it belongs to.

      • -

    • id (str or None) – Interface ID.

      • -

    • security_group_id (str or None) – Security Group of Eni.

      • -

    • private_ip (str or None) – Private ip of eni.

      • -

    • mac_address (str or None) – Mac address of nic.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.EntityCapacity(storage_capacity_gib=None, memory_capacity_gib=None, total_number_of_cores=None, number_of_ssds=None, cpu_capacity_ghz=None, number_of_sockets=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Decribes the capacity of a given entity.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • storage_capacity_gib (long or None) – The storage capacity for the given entity in GiB.

      • -

    • memory_capacity_gib (long or None) – The memory capacity for the given entity in GiB.

      • -

    • total_number_of_cores (long or None) – The number of CPU cores for the given entity.

      • -

    • number_of_ssds (long or None) – The number of SSDs for the given entity.

      • -

    • cpu_capacity_ghz (float or None) – The CPU capacity for the given entity in Ghz.

      • -

    • number_of_sockets (long or None) – The number of sockets for the given entity.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ErrorResponse(status=None, path=None, retryable=None, error_code=None, error_messages=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • status (long) – HTTP status code

      • -

    • path (str) – Originating request URI

      • -

    • retryable (bool) – If true, client should retry operation

      • -

    • error_code (str) – unique error code

      • -

    • error_messages (list of str) – localized error messages

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.EsxConfig(availability_zone=None, strict_placement=None, cluster_id=None, esxs=None, num_hosts=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • availability_zone (str or None) – Availability zone where the hosts should be provisioned. (Can be -specified only for privileged host operations).

      • -

    • strict_placement (bool or None) – An option to indicate if the host needs to be strictly placed in a -placement group. Fail the operation otherwise.

      • -

    • cluster_id (str or None) – An optional cluster id if the esxs operation has to be on a -specific cluster.

      • -

    • esxs (list of str or None) – An optional list of ESX IDs to remove. format: UUID

      • -

    • num_hosts (long) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.EsxHost(name=None, availability_zone=None, esx_id=None, hostname=None, provider='EsxHost', instance_type=None, mac_address=None, custom_properties=None, esx_state=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -ESX_STATE_ADDING_TO_VCENTER = 'ADDING_TO_VCENTER'
    -
    - -
    -
    -ESX_STATE_DELETED = 'DELETED'
    -
    - -
    -
    -ESX_STATE_DELETING = 'DELETING'
    -
    - -
    -
    -ESX_STATE_DELETING_FROM_VCENTER = 'DELETING_FROM_VCENTER'
    -
    - -
    -
    -ESX_STATE_DEPLOYING = 'DEPLOYING'
    -
    - -
    -
    -ESX_STATE_FAILED = 'FAILED'
    -
    - -
    -
    -ESX_STATE_INITIALIZING = 'INITIALIZING'
    -
    - -
    -
    -ESX_STATE_PENDING_CLOUD_DELETION = 'PENDING_CLOUD_DELETION'
    -
    - -
    -
    -ESX_STATE_PROVISIONED = 'PROVISIONED'
    -
    - -
    -
    -ESX_STATE_READY = 'READY'
    -
    - -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.EsxHostInfo(instance_type=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    instance_type (str or None) – Backing cloud provider instance type for cluster.

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.FirewallRule(rule_type=None, application_ids=None, name=None, rule_interface=None, destination=None, id=None, destination_scope=None, source=None, source_scope=None, services=None, action=None, revision=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • rule_type (str or None) –

      Possible values are:

      - -

      • -

    • application_ids (list of str or None) –

      • -

    • name (str or None) –

      • -

    • rule_interface (str or None) – Deprecated, left for backwards compatibility. Remove once UI stops -using it.

      • -

    • destination (str or None) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated -list of those entries. If not specified, defaults to ‘any’.

      • -

    • id (str or None) –

      • -

    • destination_scope (FirewallRuleScope or None) –

      • -

    • source (str or None) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated -list of those entries. If not specified, defaults to ‘any’.

      • -

    • source_scope (FirewallRuleScope or None) –

      • -

    • services (list of FirewallService or None) – list of protocols and ports for this firewall rule

      • -

    • action (str or None) –

      Possible values are:

      - -

      • -

    • revision (long or None) – current revision of the list of firewall rules, used to protect -against concurrent modification (first writer wins) format: int32 -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -
    -
    -
    -
    -
    -ACTION_ALLOW = 'ALLOW'
    -
    - -
    -
    -ACTION_DENY = 'DENY'
    -
    - -
    -
    -RULE_TYPE_DEFAULT = 'DEFAULT'
    -
    - -
    -
    -RULE_TYPE_USER = 'USER'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.FirewallRuleScope(grouping_object_ids=None, vnic_group_ids=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Optional for FirewallRule. If not specified, defaults to ‘any’.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -VNIC_GROUP_IDS_EXTERNAL = 'external'
    -
    - -
    -
    -VNIC_GROUP_IDS_INTERNAL = 'internal'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_0 = 'vnic-index-0'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_1 = 'vnic-index-1'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_2 = 'vnic-index-2'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_3 = 'vnic-index-3'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_4 = 'vnic-index-4'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_5 = 'vnic-index-5'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_6 = 'vnic-index-6'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_7 = 'vnic-index-7'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_8 = 'vnic-index-8'
    -
    - -
    -
    -VNIC_GROUP_IDS_VNIC_INDEX_9 = 'vnic-index-9'
    -
    - -
    -
    -VNIC_GROUP_IDS_VSE = 'vse'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.FirewallService(protocol=None, ports=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • protocol (str or None) – protocol name, such as ‘tcp’, ‘udp’ etc.

      • -

    • ports (list of str or None) – a list of port numbers and port ranges, such as {80, 91-95, 99}. If -not specified, defaults to ‘any’.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.GatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Describes common properties for MGW and CGW configuration templates

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • public_ip (SddcPublicIp or None) –

      • -

    • primary_dns (str or None) –

      • -

    • secondary_dns (str or None) –

      • -

    • firewall_rules (list of FirewallRule or None) –

      • -

    • vpns (list of Vpn or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.GlcmBundle(s3_bucket=None, id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    the GlcmBundle used for deploying the sddc

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • s3_bucket (str or None) – the glcmbundle’s s3 bucket

      • -

    • id (str or None) – the glcmbundle’s id

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.HostInstanceTypes(string)
    -

    Bases: vmware.vapi.bindings.enum.Enum

    -
    -

    Note

    -

    This class represents an enumerated type in the interface language -definition. 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 the newer -version of the API, you instantiate this class. See enumerated -type description page.

    -
    -
    -
    Parameters
    -

    string (str) – String value for the HostInstanceTypes instance.

    -
    -
    -
    -
    -I3EN_METAL = HostInstanceTypes(string='I3EN_METAL')
    -
    - -
    -
    -I3_METAL = HostInstanceTypes(string='I3_METAL')
    -
    - -
    -
    -R5_METAL = HostInstanceTypes(string='R5_METAL')
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.InstanceTypeConfig(instance_type=None, hosts=None, display_name=None, entity_capacity=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Represents a structure for instance type config

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • instance_type (str or None) – Instance type name.

      • -

    • hosts (list of long or None) – Array of number of hosts allowed for this operation. Range of hosts -user can select for sddc provision

      • -

    • display_name (str or None) – Display name of instance_type.

      • -

    • entity_capacity (EntityCapacity or None) – The capacity of the given instance type.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.KmsVpcEndpoint(vpc_endpoint_id=None, network_interface_ids=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • vpc_endpoint_id (str or None) – The identifier of the VPC endpoint created to AWS Key Management -Service

      • -

    • network_interface_ids (list of str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.L2Vpn(enabled=None, sites=None, listener_ip=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • enabled (bool or None) – Enable (true) or disable (false) L2 VPN.

      • -

    • sites (list of Site) – Array of L2 vpn site config.

      • -

    • listener_ip (str or None) – Public uplink ip address. IP of external interface on which L2VPN -service listens to.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.LogicalNetwork(subnet_cidr=None, name=None, gateway_ip=None, dhcp_enabled=None, dhcp_ip_range=None, tunnel_id=None, id=None, network_type=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • subnet_cidr (str or None) – the subnet cidr

      • -

    • name (str or None) – name of the network

      • -

    • gateway_ip (str or None) – gateway ip of the logical network

      • -

    • dhcp_enabled (str or None) – if ‘true’ - enabled; if ‘false’ - disabled

      • -

    • dhcp_ip_range (str or None) – ip range within the subnet mask, range delimiter is ‘-‘ (example -10.118.10.130-10.118.10.140)

      • -

    • tunnel_id (long or None) – tunnel id of extended network format: int32

      • -

    • id (str or None) –

      • -

    • network_type (str or None) –

      Possible values are:

      - -

      • -
    -
    -
    -
    -
    -NETWORK_TYPE_EXTENDED = 'EXTENDED'
    -
    - -
    -
    -NETWORK_TYPE_HOSTED = 'HOSTED'
    -
    - -
    -
    -NETWORK_TYPE_ROUTED = 'ROUTED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.MaintenanceWindow(day_of_week=None, hour_of_day=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -DAY_OF_WEEK_FRIDAY = 'FRIDAY'
    -
    - -
    -
    -DAY_OF_WEEK_MONDAY = 'MONDAY'
    -
    - -
    -
    -DAY_OF_WEEK_SATURDAY = 'SATURDAY'
    -
    - -
    -
    -DAY_OF_WEEK_SUNDAY = 'SUNDAY'
    -
    - -
    -
    -DAY_OF_WEEK_THURSDAY = 'THURSDAY'
    -
    - -
    -
    -DAY_OF_WEEK_TUESDAY = 'TUESDAY'
    -
    - -
    -
    -DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.MaintenanceWindowEntry(in_maintenance_window=None, reservation_schedule=None, reservation_id=None, in_maintenance_mode=None, sddc_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • in_maintenance_window (bool or None) – true if the SDDC is in the defined Mainentance Window

      • -

    • reservation_schedule (ReservationSchedule or None) –

      • -

    • reservation_id (str or None) – ID for reservation format: uuid

      • -

    • in_maintenance_mode (bool or None) – true if the SDDC is currently undergoing maintenance

      • -

    • sddc_id (str or None) – SDDC ID for this reservation format: uuid

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.MaintenanceWindowGet(day_of_week=None, hour_of_day=None, duration_min=None, version=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -DAY_OF_WEEK_FRIDAY = 'FRIDAY'
    -
    - -
    -
    -DAY_OF_WEEK_MONDAY = 'MONDAY'
    -
    - -
    -
    -DAY_OF_WEEK_SATURDAY = 'SATURDAY'
    -
    - -
    -
    -DAY_OF_WEEK_SUNDAY = 'SUNDAY'
    -
    - -
    -
    -DAY_OF_WEEK_THURSDAY = 'THURSDAY'
    -
    - -
    -
    -DAY_OF_WEEK_TUESDAY = 'TUESDAY'
    -
    - -
    -
    -DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ManagementGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, subnet_cidr=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • public_ip (SddcPublicIp or None) –

      • -

    • primary_dns (str or None) –

      • -

    • secondary_dns (str or None) –

      • -

    • firewall_rules (list of FirewallRule or None) –

      • -

    • vpns (list of Vpn or None) –

      • -

    • subnet_cidr (str or None) – mgw network subnet cidr

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.MapZonesRequest(connected_account_id=None, org_id=None, petronas_regions_to_map=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • connected_account_id (str or None) – The connected account ID to remap. This is a standard UUID.

      • -

    • org_id (str or None) – The org ID to remap in. This is a standard UUID.

      • -

    • petronas_regions_to_map (list of str or None) – A list of Petronas regions to map.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.Metadata(timestamp=None, cycle_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    metadata of the sddc manifest

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • timestamp (str or None) – the timestamp for the bundle

      • -

    • cycle_id (str or None) – the cycle id

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.MsftLicensingConfig(mssql_licensing=None, windows_licensing=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -MSSQL_LICENSING_CUSTOMER_SUPPLIED = 'CUSTOMER_SUPPLIED'
    -
    - -
    -
    -MSSQL_LICENSING_DISABLED = 'DISABLED'
    -
    - -
    -
    -MSSQL_LICENSING_ENABLED = 'ENABLED'
    -
    - -
    -
    -WINDOWS_LICENSING_CUSTOMER_SUPPLIED = 'CUSTOMER_SUPPLIED'
    -
    - -
    -
    -WINDOWS_LICENSING_DISABLED = 'DISABLED'
    -
    - -
    -
    -WINDOWS_LICENSING_ENABLED = 'ENABLED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.NatRule(rule_type=None, protocol=None, name=None, internal_ports=None, public_ports=None, public_ip=None, internal_ip=None, action=None, id=None, revision=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • rule_type (str or None) –

      • -

    • protocol (str or None) –

      • -

    • name (str or None) –

      • -

    • internal_ports (str or None) –

      • -

    • public_ports (str or None) –

      • -

    • public_ip (str or None) –

      • -

    • internal_ip (str or None) –

      • -

    • action (str or None) –

      Possible values are:

      - -

      • -

    • id (str or None) –

      • -

    • revision (long or None) – current revision of the list of nat rules, used to protect against -concurrent modification (first writer wins) format: int32 -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -
    -
    -
    -
    -
    -ACTION_DNAT = 'dnat'
    -
    - -
    -
    -ACTION_SNAT = 'snat'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.NetworkTemplate(management_gateway_templates=None, compute_gateway_templates=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.NewCredentials(username=None, password=None, name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • username (str) – Username of the credentials

      • -

    • password (str) – Password associated with the credentials

      • -

    • name (str) – Name of the credentials

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.NsxtAddons(enable_nsx_advanced_addon=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Details the state of different NSX add-ons.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    enable_nsx_advanced_addon (bool or None) – Indicates whether NSX Advanced addon is enabled or disabled.

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.OfferInstancesHolder(on_demand=None, offers=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Holder for the offer instances.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.OfferType(string)
    -

    Bases: vmware.vapi.bindings.enum.Enum

    -
    -

    Note

    -

    This class represents an enumerated type in the interface language -definition. 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 the newer -version of the API, you instantiate this class. See enumerated -type description page.

    -
    -
    -
    Parameters
    -

    string (str) – String value for the OfferType instance.

    -
    -
    -
    -
    -ON_DEMAND = OfferType(string='ON_DEMAND')
    -
    - -
    -
    -TERM = OfferType(string='TERM')
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.OnDemandOfferInstance(product=None, product_type=None, name=None, currency=None, region=None, unit_price=None, monthly_cost=None, version=None, type=None, description=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Holder for the on-demand offer instance.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • product (str) –

      • -

    • product_type (str or None) – Deprecated. Please use product and type fields instead.

      • -

    • name (str) –

      • -

    • currency (str) –

      • -

    • region (str) –

      • -

    • unit_price (str) –

      • -

    • monthly_cost (str) –

      • -

    • version (str) –

      • -

    • type (str) –

      • -

    • description (str) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.OrgProperties(values=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    values ((dict of str and str) or None) – A map of string properties to values.

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.OrgSellerInfo(seller_account_id=None, seller=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • seller_account_id (str or None) – The accountid for this org for the seller-of-record. NILLABLE.

      • -

    • seller (str or None) – The seller-of-record for the current organization. For example AWS -or VMWARE

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.Organization(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, org_type=None, display_name=None, name=None, org_seller_info=None, project_state=None, properties=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • updated (datetime.datetime) –

      • -

    • user_id (str) – User id that last updated this record

      • -

    • updated_by_user_id (str) – User id that last updated this record

      • -

    • created (datetime.datetime) –

      • -

    • version (long) – Version of this entity format: int32

      • -

    • updated_by_user_name (str or None) – User name that last updated this record

      • -

    • user_name (str) – User name that last updated this record

      • -

    • id (str) – Unique ID for this entity

      • -

    • org_type (str or None) – ORG_TYPE to be associated with the org

      • -

    • display_name (str or None) –

      • -

    • name (str or None) –

      • -

    • org_seller_info (OrgSellerInfo or None) –

      • -

    • project_state (str or None) –

      Possible values are:

      - -

      • -

    • properties (OrgProperties or None) –

      • -
    -
    -
    -
    -
    -PROJECT_STATE_CREATED = 'CREATED'
    -
    - -
    -
    -PROJECT_STATE_DELETED = 'DELETED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.PaymentMethodInfo(type=None, default_flag=None, payment_method_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • type (str or None) –

      • -

    • default_flag (bool or None) –

      • -

    • payment_method_id (str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.PopAgentXeniConnection(default_subnet_route=None, eni_info=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • default_subnet_route (str or None) – The gateway route ip fo the subnet.

      • -

    • eni_info (EniInfo or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.PopAmiInfo(instance_type=None, region=None, id=None, name=None, type=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • instance_type (str or None) – instance type of the esx ami

      • -

    • region (str or None) – the region of the esx ami

      • -

    • id (str or None) – the ami id for the esx

      • -

    • name (str or None) – the name of the esx ami

      • -

    • type (str or None) –

      Possible values are:

      - -
      -

      PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI.

      -
      -

      • -
    -
    -
    -
    -
    -TYPE_CENTOS = 'CENTOS'
    -
    - -
    -
    -TYPE_POP = 'POP'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.PopInfo(ami_infos=None, created_at=None, service_infos=None, id=None, manifest_version=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Present a SDDC PoP information.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • ami_infos (dict of str and PopAmiInfo) – A map of [region name of PoP / PoP-AMI]:[PopAmiInfo].

      • -

    • created_at (datetime.datetime or None) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time -pattern. format: date-time

      • -

    • service_infos ((dict of str and PopServiceInfo) or None) – A map of [service type]:[PopServiceInfo]

      • -

    • id (str or None) – UUID of the PopInfo format: UUID

      • -

    • manifest_version (str or None) – version of the manifest.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.PopServiceInfo(cln=None, version=None, build=None, service=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -SERVICE_AGENT = 'AGENT'
    -
    - -
    -
    -SERVICE_AIDE = 'AIDE'
    -
    - -
    -
    -SERVICE_BRE = 'BRE'
    -
    - -
    -
    -SERVICE_BRF = 'BRF'
    -
    - -
    -
    -SERVICE_DNS = 'DNS'
    -
    - -
    -
    -SERVICE_DOCKER = 'DOCKER'
    -
    - -
    -
    -SERVICE_FM_LOG_COLLECTOR = 'FM_LOG_COLLECTOR'
    -
    - -
    -
    -SERVICE_FM_METRICS_COLLECTOR = 'FM_METRICS_COLLECTOR'
    -
    - -
    -
    -SERVICE_FORWARD_PROXY = 'FORWARD_PROXY'
    -
    - -
    -
    -SERVICE_GLCM = 'GLCM'
    -
    - -
    -
    -SERVICE_JRE = 'JRE'
    -
    - -
    -
    -SERVICE_LOGZ_LOG_COLLECTOR = 'LOGZ_LOG_COLLECTOR'
    -
    - -
    -
    -SERVICE_NTP = 'NTP'
    -
    - -
    -
    -SERVICE_OS = 'OS'
    -
    - -
    -
    -SERVICE_REVERSE_PROXY = 'REVERSE_PROXY'
    -
    - -
    -
    -SERVICE_RTS = 'RTS'
    -
    - -
    -
    -SERVICE_S3_ADAPTER = 'S3_ADAPTER'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ProvisionSpec(provider=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Represents a provisioning spec for a sddc

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    provider ((dict of str and SddcConfigSpec) or None) – Map of provider to sddc config spec

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.RequestDetail(aws_quota_request_id=None, detail_status=None, resolved_at=None, desired_value=None, aws_support_case_status=None, aws_support_case_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -DETAIL_STATUS_DENIED = 'DENIED'
    -
    - -
    -
    -DETAIL_STATUS_ERROR = 'ERROR'
    -
    - -
    -
    -DETAIL_STATUS_NEW = 'NEW'
    -
    - -
    -
    -DETAIL_STATUS_PENDINGSUBMIT = 'PENDINGSUBMIT'
    -
    - -
    -
    -DETAIL_STATUS_PENDINGVERFICATION = 'PENDINGVERFICATION'
    -
    - -
    -
    -DETAIL_STATUS_RESOLVED = 'RESOLVED'
    -
    - -
    -
    -DETAIL_STATUS_SUBMITTED = 'SUBMITTED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.Reservation(duration=None, rid=None, create_time=None, start_time=None, metadata=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • duration (long or None) – Duration - required for reservation in maintenance window format: -int64

      • -

    • rid (str or None) – Reservation ID format: uuid

      • -

    • create_time (str or None) – Optional

      • -

    • start_time (datetime.datetime or None) – Start time of a reservation format: date-time

      • -

    • metadata ((dict of str and str) or None) – Optional

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ReservationInMw(rid=None, week_of=None, create_time=None, metadata=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • rid (str or None) – Reservation ID format: uuid

      • -

    • week_of (str or None) – SUNDAY of the week that maintenance is scheduled, ISO format date

      • -

    • create_time (datetime.datetime or None) – Optional format: date-time

      • -

    • metadata ((dict of str and str) or None) – Optional

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ReservationSchedule(day_of_week=None, hour_of_day=None, duration_min=None, version=None, reservations=None, reservations_mw=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -DAY_OF_WEEK_FRIDAY = 'FRIDAY'
    -
    - -
    -
    -DAY_OF_WEEK_MONDAY = 'MONDAY'
    -
    - -
    -
    -DAY_OF_WEEK_SATURDAY = 'SATURDAY'
    -
    - -
    -
    -DAY_OF_WEEK_SUNDAY = 'SUNDAY'
    -
    - -
    -
    -DAY_OF_WEEK_THURSDAY = 'THURSDAY'
    -
    - -
    -
    -DAY_OF_WEEK_TUESDAY = 'TUESDAY'
    -
    - -
    -
    -DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ReservationWindow(reservation_state=None, emergency=None, maintenance_properties=None, reserve_id=None, start_hour=None, sddc_id=None, manifest_id=None, duration_hours=None, start_date=None, metadata=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -RESERVATION_STATE_CANCELED = 'CANCELED'
    -
    - -
    -
    -RESERVATION_STATE_COMPLETED = 'COMPLETED'
    -
    - -
    -
    -RESERVATION_STATE_RUNNING = 'RUNNING'
    -
    - -
    -
    -RESERVATION_STATE_SCHEDULED = 'SCHEDULED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties(status=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    status (str or None) – Status of upgrade, if any

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.RouteTableInfo(name=None, id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • name (str or None) – route table name

      • -

    • id (str or None) – route table id

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.Sddc(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, name=None, sddc_state=None, expiration_date=None, org_id=None, sddc_type=None, provider=None, account_link_state=None, sddc_access_state=None, resource_config=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    - -
    - -
    - -
    - -
    - -
    - -
    -
    -PROVIDER_AWS = 'AWS'
    -
    - -
    -
    -PROVIDER_ZEROCLOUD = 'ZEROCLOUD'
    -
    - -
    -
    -SDDC_STATE_CANCELED = 'CANCELED'
    -
    - -
    -
    -SDDC_STATE_DELETED = 'DELETED'
    -
    - -
    -
    -SDDC_STATE_DELETING = 'DELETING'
    -
    - -
    -
    -SDDC_STATE_DEPLOYING = 'DEPLOYING'
    -
    - -
    -
    -SDDC_STATE_FAILED = 'FAILED'
    -
    - -
    -
    -SDDC_STATE_READY = 'READY'
    -
    - -
    -
    -SDDC_STATE_READY_FOR_GLCM_BRINGUP = 'READY_FOR_GLCM_BRINGUP'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.SddcConfig(msft_license_config=None, vpc_cidr=None, host_instance_type=None, skip_creating_vxlan=None, vxlan_subnet=None, size=None, storage_capacity=None, name=None, account_link_sddc_config=None, sddc_id=None, num_hosts=None, sddc_type=None, account_link_config=None, provider='SddcConfig', sso_domain=None, sddc_template_id=None, deployment_type=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • msft_license_config (MsftLicensingConfig or None) – Indicates the desired licensing support, if any, of Microsoft -software.

      • -

    • vpc_cidr (str or None) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.

      • -

    • host_instance_type (HostInstanceTypes or None) – The instance type for the esx hosts in the primary cluster of the -SDDC.

      • -

    • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

      • -

    • vxlan_subnet (str or None) – VXLAN IP subnet in CIDR for compute gateway

      • -

    • size (str or None) –

      Possible values are:

      - -

      The size of the vCenter and NSX appliances. “large” sddcSize -corresponds to a ‘large’ vCenter appliance and ‘large’ NSX -appliance. ‘medium’ sddcSize corresponds to ‘medium’ vCenter -appliance and ‘medium’ NSX appliance. Value defaults to ‘medium’.

      -

      • -

    • storage_capacity (long or None) – The storage capacity value to be requested for the sddc primary -cluster, in GiBs. If provided, instead of using the direct-attached -storage, a capacity value amount of seperable storage will be used. -format: int64

      • -

    • name (str) –

      • -

    • account_link_sddc_config (list of AccountLinkSddcConfig or None) – A list of the SDDC linking configurations to use.

      • -

    • sddc_id (str or None) – If provided, will be assigned as SDDC id of the provisioned SDDC. -format: UUID

      • -

    • num_hosts (long) –

      • -

    • sddc_type (str or None) – Denotes the sddc type , if the value is null or empty, the type is -considered as default.

      • -

    • account_link_config (AccountLinkConfig or None) – The account linking configuration, we will keep this one and remove -accountLinkSddcConfig finally.

      • -

    • provider (str) –

      Possible values are:

      - -

      Determines what additional properties are available based on cloud -provider.

      -

      • -

    • sso_domain (str or None) – The SSO domain name to use for vSphere users. If not specified, -vmc.local will be used.

      • -

    • sddc_template_id (str or None) – If provided, configuration from the template will applied to the -provisioned SDDC. format: UUID

      • -

    • deployment_type (str or None) –

      Possible values are:

      - -

      Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is -SingleAZ.

      -

      • -
    -
    -
    -
    -
    -DEPLOYMENT_TYPE_MULTIAZ = 'MultiAZ'
    -
    - -
    -
    -DEPLOYMENT_TYPE_SINGLEAZ = 'SingleAZ'
    -
    - -
    -
    -PROVIDER_AWS = 'AWS'
    -
    - -
    -
    -PROVIDER_ZEROCLOUD = 'ZEROCLOUD'
    -
    - -
    -
    -SIZE_LARGE = 'large'
    -
    - -
    -
    -SIZE_MEDIUM = 'medium'
    -
    - -
    -
    -SIZE_NSX_LARGE = 'nsx_large'
    -
    - -
    -
    -SIZE_NSX_SMALL = 'nsx_small'
    -
    - -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.SddcConfigSpec(sddc_type_config_spec=None, region_display_names=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Represents a configuration spec for a sddc

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • sddc_type_config_spec ((dict of str and ConfigSpec) or None) – Map of sddc type to config spec

      • -

    • region_display_names ((dict of str and str) or None) – The region name to display names mapping

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SddcId(sddc_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    sddc_id (str or None) – Sddc ID

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SddcLinkConfig(customer_subnet_ids=None, connected_account_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • customer_subnet_ids (list of str or None) –

      • -

    • connected_account_id (str or None) – Determines which connected customer account to link to

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SddcManifest(vmc_version=None, glcm_bundle=None, pop_info=None, vmc_internal_version=None, ebs_backed_vsan_config=None, vsan_witness_ami=None, esx_ami=None, esx_nsxt_ami=None, metadata=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Describes software components of the installed SDDC

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • vmc_version (str or None) – the vmcVersion of the sddc for display

      • -

    • glcm_bundle (GlcmBundle or None) –

      • -

    • pop_info (PopInfo or None) –

      • -

    • vmc_internal_version (str or None) – the vmcInternalVersion of the sddc for internal use

      • -

    • ebs_backed_vsan_config (EbsBackedVsanConfig or None) –

      • -

    • vsan_witness_ami (AmiInfo or None) –

      • -

    • esx_ami (AmiInfo or None) –

      • -

    • esx_nsxt_ami (AmiInfo or None) –

      • -

    • metadata (Metadata or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SddcPatchRequest(name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Patch request body for SDDC

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    name (str or None) – The new name of the SDDC to be changed to.

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SddcPublicIp(public_ip=None, name=None, allocation_id=None, dnat_rule_id=None, associated_private_ip=None, snat_rule_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • public_ip (str) –

      • -

    • name (str or None) –

      • -

    • allocation_id (str or None) –

      • -

    • dnat_rule_id (str or None) –

      • -

    • associated_private_ip (str or None) –

      • -

    • snat_rule_id (str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SddcResourceConfig(mgmt_appliance_network_name=None, mgw_id=None, nsx_mgr_url=None, nsx_cloud_audit_password=None, management_ds=None, nsx_api_public_endpoint_url=None, clusters=None, sddc_networks=None, nsx_mgr_management_ip=None, nsx_cloud_audit=None, esx_cluster_id=None, vc_public_ip=None, vc_url=None, esx_hosts=None, vc_management_ip=None, management_rp=None, witness_availability_zone=None, sddc_size=None, nsx_controller_ips=None, esx_host_subnet=None, sso_domain=None, deployment_type=None, msft_license_config=None, dns_with_management_vm_private_ip=None, nsxt=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, custom_properties=None, cloud_password=None, provider='SddcResourceConfig', nsx_cloud_admin_password=None, cloud_username=None, vc_instance_id=None, cloud_user_group=None, skip_creating_vxlan=None, sddc_manifest=None, vxlan_subnet=None, region=None, sddc_id=None, pop_agent_xeni_connection=None, nsx_cloud_admin=None, nsxt_addons=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • mgmt_appliance_network_name (str or None) – Name for management appliance network.

      • -

    • mgw_id (str or None) – Management Gateway Id

      • -

    • nsx_mgr_url (str or None) – URL of the NSX Manager

      • -

    • nsx_cloud_audit_password (str or None) – NSX cloud audit Password

      • -

    • management_ds (str or None) – The ManagedObjectReference of the management Datastore

      • -

    • nsx_api_public_endpoint_url (str or None) – nsx api entire base url

      • -

    • clusters (list of Cluster or None) – List of clusters in the SDDC.

      • -

    • sddc_networks (list of str or None) –

      • -

    • nsx_mgr_management_ip (str or None) – NSX Manager internal management IP

      • -

    • nsx_cloud_audit (str or None) – NSX cloud audit user name

      • -

    • esx_cluster_id (str or None) – Cluster Id to add ESX workflow

      • -

    • vc_public_ip (str or None) – vCenter public IP

      • -

    • vc_url (str or None) – URL of the vCenter server

      • -

    • esx_hosts (list of AwsEsxHost or None) –

      • -

    • vc_management_ip (str or None) – vCenter internal management IP

      • -

    • management_rp (str or None) –

      • -

    • witness_availability_zone (str or None) – Availability zone where the witness node is provisioned for a -MultiAZ SDDC. This is null for a SingleAZ SDDC.

      • -

    • sddc_size (SddcSize or None) –

      • -

    • nsx_controller_ips (list of str or None) – List of Controller IPs

      • -

    • esx_host_subnet (str or None) – ESX host subnet

      • -

    • sso_domain (str or None) – The SSO domain name to use for vSphere users

      • -

    • deployment_type (str or None) –

      Possible values are:

      - -
      -

      Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.

      -
      -

      • -

    • msft_license_config (MsftLicensingConfig or None) – The Microsoft license status of this SDDC.

      • -

    • dns_with_management_vm_private_ip (bool or None) – if true, use the private IP addresses to register DNS records for -the management VMs

      • -

    • nsxt (bool or None) – if true, NSX-T UI is enabled.

      • -

    • psc_management_ip (str or None) – PSC internal management IP

      • -

    • psc_url (str or None) – URL of the PSC server

      • -

    • cgws (list of str or None) –

      • -

    • availability_zones (list of str or None) – Availability zones over which esx hosts are provisioned. MultiAZ -SDDCs will have hosts provisioned over two availability zones while -SingleAZ SDDCs will provision over one.

      • -

    • custom_properties ((dict of str and str) or None) –

      • -

    • cloud_password (str or None) – Password for vCenter SDDC administrator

      • -

    • provider (str) –

      Possible values are:

      - -
      -

      Discriminator for additional properties

      -
      -

      • -

    • nsx_cloud_admin_password (str or None) – NSX cloud admin password

      • -

    • cloud_username (str or None) – Username for vCenter SDDC administrator

      • -

    • vc_instance_id (str or None) – unique id of the vCenter server

      • -

    • cloud_user_group (str or None) – Group name for vCenter SDDC administrator

      • -

    • skip_creating_vxlan (bool or None) – skip creating vxlan for compute gateway for SDDC provisioning

      • -

    • sddc_manifest (SddcManifest or None) –

      • -

    • vxlan_subnet (str or None) – VXLAN IP subnet

      • -

    • region (str or None) – region in which sddc is deployed

      • -

    • sddc_id (str or None) – sddc identifier

      • -

    • pop_agent_xeni_connection (PopAgentXeniConnection or None) –

      • -

    • nsx_cloud_admin (str or None) – NSX cloud admin user name

      • -

    • nsxt_addons (NsxtAddons or None) –

      • -
    -
    -
    -
    -
    -DEPLOYMENT_TYPE_MULTI_AZ = 'MULTI_AZ'
    -
    - -
    -
    -DEPLOYMENT_TYPE_SINGLE_AZ = 'SINGLE_AZ'
    -
    - -
    -
    -PROVIDER_AWS = 'AWS'
    -
    - -
    -
    -PROVIDER_ZEROCLOUD = 'ZEROCLOUD'
    -
    - -
    -
    -property provider
    -

    Return the discriminator value

    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.SddcSize(vc_size=None, nsx_size=None, size=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Size of the SDDC

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -NSX_SIZE_LARGE = 'large'
    -
    - -
    -
    -NSX_SIZE_MEDIUM = 'medium'
    -
    - -
    -
    -NSX_SIZE_SMALL = 'small'
    -
    - -
    -
    -SIZE_LARGE = 'LARGE'
    -
    - -
    -
    -SIZE_MEDIUM = 'MEDIUM'
    -
    - -
    -
    -SIZE_NSX_LARGE = 'NSX_LARGE'
    -
    - -
    -
    -SIZE_NSX_SMALL = 'NSX_SMALL'
    -
    - -
    -
    -VC_SIZE_LARGE = 'large'
    -
    - -
    -
    -VC_SIZE_MEDIUM = 'medium'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.SddcStateRequest(sddcs=None, states=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -STATES_CANCELED = 'CANCELED'
    -
    - -
    -
    -STATES_COMPLETED = 'COMPLETED'
    -
    - -
    -
    -STATES_RUNNING = 'RUNNING'
    -
    - -
    -
    -STATES_SCHEDULED = 'SCHEDULED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.SddcTemplate(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, account_link_sddc_configs=None, state=None, network_template=None, name=None, source_sddc_id=None, org_id=None, sddc=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -STATE_APPLIED = 'APPLIED'
    -
    - -
    -
    -STATE_AVAILABLE = 'AVAILABLE'
    -
    - -
    -
    -STATE_DELETED = 'DELETED'
    -
    - -
    -
    -STATE_DELETING = 'DELETING'
    -
    - -
    -
    -STATE_FAILED = 'FAILED'
    -
    - -
    -
    -STATE_INITIALIZATION = 'INITIALIZATION'
    -
    - -
    -
    -STATE_INUSE = 'INUSE'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.ServiceError(default_message=None, original_service=None, localized_message=None, original_service_error_code=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Detailed service errors associated with a task.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • default_message (str or None) – Error message in English.

      • -

    • original_service (str or None) – The original service name of the error.

      • -

    • localized_message (str or None) – The localized message.

      • -

    • original_service_error_code (str or None) – The original error code of the service.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.ServiceQuotaRequest(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, requester_email=None, task_id=None, region=None, aws_account_number=None, org_id=None, reason=None, request_status=None, request_details=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • updated (datetime.datetime) –

      • -

    • user_id (str) – User id that last updated this record

      • -

    • updated_by_user_id (str) – User id that last updated this record

      • -

    • created (datetime.datetime) –

      • -

    • version (long) – Version of this entity format: int32

      • -

    • updated_by_user_name (str or None) – User name that last updated this record

      • -

    • user_name (str) – User name that last updated this record

      • -

    • id (str) – Unique ID for this entity

      • -

    • requester_email (str or None) –

      • -

    • task_id (str or None) – The task for running the service quota request.

      • -

    • region (str or None) – Region for the service quota

      • -

    • aws_account_number (str or None) –

      • -

    • org_id (str or None) – The org ID for this request. This is a standard UUID.

      • -

    • reason (str or None) – Reason for this quota increase

      • -

    • request_status (str or None) –

      Possible values are:

      - -

      • -

    • request_details ((dict of str and RequestDetail) or None) – service quota request item details

      • -
    -
    -
    -
    -
    -REQUEST_STATUS_DENIED = 'DENIED'
    -
    - -
    -
    -REQUEST_STATUS_ERROR = 'ERROR'
    -
    - -
    -
    -REQUEST_STATUS_NEW = 'NEW'
    -
    - -
    -
    -REQUEST_STATUS_PENDING = 'PENDING'
    -
    - -
    -
    -REQUEST_STATUS_RESOLVED = 'RESOLVED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.Site(password=None, user_id=None, name=None, rx_bytes_on_local_subnet=None, secure_traffic=None, established_date=None, failure_message=None, dropped_tx_packets=None, dropped_rx_packets=None, tunnel_status=None, tx_bytes_from_local_subnet=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • password (str or None) – Site password.

      • -

    • user_id (str or None) – Site user id.

      • -

    • name (str or None) – Unique name for the site getting configured.

      • -

    • rx_bytes_on_local_subnet (long or None) – Bytes received on local network. format: int64 -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -

    • secure_traffic (bool or None) – Enable/disable encription.

      • -

    • established_date (str or None) – Date tunnel was established. -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -

    • failure_message (str or None) – failure message. -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -

    • dropped_tx_packets (str or None) – Number of transmitted packets dropped. -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -

    • dropped_rx_packets (str or None) – Number of received packets dropped. -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -

    • tunnel_status (str or None) –

      Possible values are:

      - -
      -

      Site tunnel status.

      -
      -

      This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      -

      • -

    • tx_bytes_from_local_subnet (long or None) – Bytes transmitted from local subnet. format: int64 -This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.

      • -
    -
    -
    -
    -
    -TUNNEL_STATUS_CONNECTED = 'CONNECTED'
    -
    - -
    -
    -TUNNEL_STATUS_DISCONNECTED = 'DISCONNECTED'
    -
    - -
    -
    -TUNNEL_STATUS_UNKNOWN = 'UNKNOWN'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.StubFactory(stub_config)
    -

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    -

    Initialize StubFactoryBase

    -
    -
    Parameters
    -

    stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.Subnet(subnet_id=None, name=None, route_tables=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    (as there’s already one SubnetInfo, use Subnet instead)

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • subnet_id (str or None) – subnet id

      • -

    • name (str or None) – subnet name

      • -

    • route_tables (list of SubnetRouteTableInfo or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SubnetInfo(compatible=None, connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, availability_zone_id=None, subnet_cidr_block=None, note=None, vpc_id=None, vpc_cidr_block=None, name=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • compatible (bool or None) – Is this customer subnet compatible with the SDDC?

      • -

    • connected_account_id (str or None) – The ID of the connected account this subnet is from.

      • -

    • region_name (str or None) – The region this subnet is from.

      • -

    • availability_zone (str or None) – The availability zone (customer-centric) this subnet is in.

      • -

    • subnet_id (str or None) – The ID of the subnet.

      • -

    • availability_zone_id (str or None) – The availability zone id (customer-centric) this subnet is in.

      • -

    • subnet_cidr_block (str or None) – The CIDR block of the subnet.

      • -

    • note (str or None) – Why a subnet is marked as not compatible. May be blank if -compatible.

      • -

    • vpc_id (str or None) – The ID of the VPC this subnet resides in.

      • -

    • vpc_cidr_block (str or None) – The CIDR block of the VPC containing this subnet.

      • -

    • name (str or None) – The name of the subnet. This is either the tagged name or the -default AWS id it was given.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SubnetRouteTableInfo(subnet_id=None, association_id=None, routetable_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • subnet_id (str or None) – subnet id

      • -

    • association_id (str or None) – subnet - route table association id

      • -

    • routetable_id (str or None) – route table id

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SubscriptionDetails(status=None, anniversary_billing_date=None, end_date=None, billing_frequency=None, auto_renewed_allowed=None, commitment_term=None, csp_subscription_id=None, billing_subscription_id=None, offer_version=None, offer_type=None, description=None, product_id=None, region=None, product_name=None, offer_name=None, commitment_term_uom=None, start_date=None, quantity=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    details of a subscription

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -STATUS_ACTIVATED = 'ACTIVATED'
    -
    - -
    -
    -STATUS_CANCELLED = 'CANCELLED'
    -
    - -
    -
    -STATUS_CREATED = 'CREATED'
    -
    - -
    -
    -STATUS_EXPIRED = 'EXPIRED'
    -
    - -
    -
    -STATUS_FAILED = 'FAILED'
    -
    - -
    -
    -STATUS_ORDER_SUBMITTED = 'ORDER_SUBMITTED'
    -
    - -
    -
    -STATUS_PENDING_PROVISIONING = 'PENDING_PROVISIONING'
    -
    - -
    -
    -STATUS_SUSPENDED = 'SUSPENDED'
    -
    - -
    -
    -STATUS_TERMINATED = 'TERMINATED'
    -
    - -
    -
    -STATUS_UKNOWN = 'UKNOWN'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.SubscriptionProducts(product=None, types=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Details of products that are available for purchase.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • product (str or None) – The name of the product

      • -

    • types (list of str or None) – A list of different types/version for the product.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SubscriptionRequest(product=None, product_type=None, product_id=None, billing_frequency=None, region=None, commitment_term=None, offer_context_id=None, offer_version=None, offer_name=None, quantity=None, type=None, price=None, product_charge_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • product (str or None) – The product for which subscription needs to be created. Refer -/vmc/api/orgs/{orgId}/products.

      • -

    • product_type (str) – Old identifier for product. *Deprecarted*. See product and type

      • -

    • product_id (str or None) –

      • -

    • billing_frequency (str or None) – Frequency of the billing.

      • -

    • region (str) –

      • -

    • commitment_term (str) –

      • -

    • offer_context_id (str or None) –

      • -

    • offer_version (str) –

      • -

    • offer_name (str) –

      • -

    • quantity (long) –

      • -

    • type (str or None) – The type of the product for which the subscription needs to be -created.

      • -

    • price (long or None) –

      • -

    • product_charge_id (str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.SupportWindow(start_day=None, seats=None, sddcs=None, duration_hours=None, start_hour=None, support_window_id=None, metadata=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -START_DAY_FRIDAY = 'FRIDAY'
    -
    - -
    -
    -START_DAY_MONDAY = 'MONDAY'
    -
    - -
    -
    -START_DAY_SATURDAY = 'SATURDAY'
    -
    - -
    -
    -START_DAY_SUNDAY = 'SUNDAY'
    -
    - -
    -
    -START_DAY_THURSDAY = 'THURSDAY'
    -
    - -
    -
    -START_DAY_TUESDAY = 'TUESDAY'
    -
    - -
    -
    -START_DAY_WEDNESDAY = 'WEDNESDAY'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.SupportWindowId(window_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    window_id (str or None) – Support Window ID

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.Task(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, status=None, localized_error_message=None, resource_id=None, parent_task_id=None, task_version=None, correlation_id=None, start_resource_entity_version=None, sub_status=None, task_type=None, start_time=None, task_progress_phases=None, error_message=None, org_id=None, end_resource_entity_version=None, service_errors=None, org_type=None, estimated_remaining_minutes=None, params=None, progress_percent=None, phase_in_progress=None, resource_type=None, end_time=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • updated (datetime.datetime) –

      • -

    • user_id (str) – User id that last updated this record

      • -

    • updated_by_user_id (str) – User id that last updated this record

      • -

    • created (datetime.datetime) –

      • -

    • version (long) – Version of this entity format: int32

      • -

    • updated_by_user_name (str or None) – User name that last updated this record

      • -

    • user_name (str) – User name that last updated this record

      • -

    • id (str) – Unique ID for this entity

      • -

    • status (str or None) –

      Possible values are:

      - -

      • -

    • localized_error_message (str or None) –

      • -

    • resource_id (str or None) – UUID of the resource the task is acting upon

      • -

    • parent_task_id (str or None) – If this task was created by another task - this provides the -linkage. Mostly for debugging.

      • -

    • task_version (str or None) –

      • -

    • correlation_id (str or None) – (Optional) Client provided uniqifier to make task creation -idempotent. Be aware not all tasks support this. For tasks that do -- supplying the same correlation Id, for the same task type, within -a predefined window will ensure the operation happens at most once.

      • -

    • start_resource_entity_version (long or None) – Entity version of the resource at the start of the task. This is -only set for some task types. format: int32

      • -

    • sub_status (str or None) –

      • -

    • task_type (str or None) –

      • -

    • start_time (datetime.datetime or None) –

      • -

    • task_progress_phases (list of TaskProgressPhase or None) – Task progress phases involved in current task execution

      • -

    • error_message (str or None) –

      • -

    • org_id (str or None) –

      • -

    • end_resource_entity_version (long or None) – Entity version of the resource at the end of the task. This is only -set for some task types. format: int32

      • -

    • service_errors (list of ServiceError or None) – Service errors returned from SDDC services.

      • -

    • org_type (str or None) –

      • -

    • estimated_remaining_minutes (long or None) – Estimated remaining time in minute of the task execution, < 0 means -no estimation for the task. format: int32

      • -

    • params (vmware.vapi.struct.VapiStruct or None) –

      • -

    • progress_percent (long or None) – Estimated progress percentage the task executed format: int32

      • -

    • phase_in_progress (str or None) – The current in progress phase ID in the task execution, if none in -progress, empty string returned.

      • -

    • resource_type (str or None) – Type of resource being acted upon

      • -

    • end_time (datetime.datetime or None) –

      • -
    -
    -
    -
    -
    -STATUS_CANCELED = 'CANCELED'
    -
    - -
    -
    -STATUS_CANCELING = 'CANCELING'
    -
    - -
    -
    -STATUS_FAILED = 'FAILED'
    -
    - -
    -
    -STATUS_FINISHED = 'FINISHED'
    -
    - -
    -
    -STATUS_STARTED = 'STARTED'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.TaskProgressPhase(id=None, name=None, progress_percent=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    A task progress can be (but does NOT have to be) divided to more meaningful -progress phases.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • id (str) – The identifier of the task progress phase

      • -

    • name (str) – The display name of the task progress phase

      • -

    • progress_percent (long) – The percentage of the phase that has completed format: int32

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.TermBillingOptions(unit_price=None, billing_frequency=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Holder for term billing options.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • unit_price (str or None) –

      • -

    • billing_frequency (str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.TermOfferInstance(description=None, product=None, product_type=None, name=None, currency=None, region=None, commitment_term=None, unit_price=None, billing_options=None, version=None, offer_context_id=None, product_charge_id=None, type=None, product_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Holder for the term offer instances.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • description (str) –

      • -

    • product (str) –

      • -

    • product_type (str or None) – Deprecated. Please use product and type fields instead.

      • -

    • name (str) –

      • -

    • currency (str) –

      • -

    • region (str) –

      • -

    • commitment_term (long) –

      • -

    • unit_price (str) – (deprecated. unit_price is moved into TermBillingOptions. For -backward compatibility, this field reflect “Prepaid” price at the -offer level.)

      • -

    • billing_options (list of TermBillingOptions or None) –

      • -

    • version (str) –

      • -

    • offer_context_id (str or None) –

      • -

    • product_charge_id (str or None) –

      • -

    • type (str) –

      • -

    • product_id (str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.TermsOfServiceResult(terms_id=None, signed=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • terms_id (str or None) – The terms of service ID requested.

      • -

    • signed (bool or None) – Wehther or not the terms requested have been signed.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.UpdateCredentials(username=None, password=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • username (str) – Username of the credentials

      • -

    • password (str) – Password associated with the credentials

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VmcLocale(locale=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    locale (str or None) – The locale to be used for translating responses for the session

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VpcInfo(esx_security_group_id=None, vpc_cidr=None, vgw_id=None, esx_public_security_group_id=None, vif_ids=None, vm_security_group_id=None, route_table_id=None, edge_subnet_id=None, id=None, api_association_id=None, api_subnet_id=None, private_subnet_id=None, private_association_id=None, vcdr_enis=None, subnet_id=None, internet_gateway_id=None, security_group_id=None, association_id=None, vgw_route_table_id=None, traffic_group_edge_vm_ips=None, edge_association_id=None, provider=None, tgw_ips=None, peering_connection_id=None, network_type=None, available_zones=None, routetables=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • esx_security_group_id (str or None) –

      • -

    • vpc_cidr (str or None) –

      • -

    • vgw_id (str or None) –

      • -

    • esx_public_security_group_id (str or None) –

      • -

    • vif_ids (list of str or None) – set of virtual interfaces attached to the sddc

      • -

    • vm_security_group_id (str or None) –

      • -

    • route_table_id (str or None) – (deprecated)

      • -

    • edge_subnet_id (str or None) – Id of the NSX edge associated with this VPC (deprecated)

      • -

    • id (str or None) – vpc id

      • -

    • api_association_id (str or None) – Id of the association between subnet and route-table (deprecated)

      • -

    • api_subnet_id (str or None) – Id associated with this VPC (deprecated)

      • -

    • private_subnet_id (str or None) – (deprecated)

      • -

    • private_association_id (str or None) – (deprecated)

      • -

    • vcdr_enis (list of EniInfo or None) – Set of VCDR (VMware Cloud Disaster Recovery) ENIs

      • -

    • subnet_id (str or None) – (deprecated)

      • -

    • internet_gateway_id (str or None) –

      • -

    • security_group_id (str or None) –

      • -

    • association_id (str or None) – (deprecated)

      • -

    • vgw_route_table_id (str or None) – Route table which contains the route to VGW (deprecated)

      • -

    • traffic_group_edge_vm_ips (list of str or None) – List of edge vm Ips of traffic gourps added during scale-out

      • -

    • edge_association_id (str or None) – Id of the association between edge subnet and route-table -(deprecated)

      • -

    • provider (str or None) –

      • -

    • tgw_ips ((dict of str and list of str) or None) – Mapping from AZ to a list of IP addresses assigned to TGW ENI -that’s connected with Vpc

      • -

    • peering_connection_id (str or None) – (deprecated)

      • -

    • network_type (str or None) –

      • -

    • available_zones (list of AvailableZoneInfo or None) –

      • -

    • routetables ((dict of str and RouteTableInfo) or None) – map from routeTableName to routeTableInfo

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VpcInfoSubnets(vpc_id=None, cidr_block=None, description=None, subnets=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • vpc_id (str or None) – The ID of the VPC these subnets belong to.

      • -

    • cidr_block (str or None) – The overall CIDR block of the VPC. This is the AWS primary CIDR -block.

      • -

    • description (str or None) – The description of the VPC; usually it’s name or id.

      • -

    • subnets (list of SubnetInfo or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.Vpn(version=None, on_prem_gateway_ip=None, on_prem_network_cidr=None, pfs_enabled=None, id=None, channel_status=None, on_prem_nat_ip=None, name=None, internal_network_ids=None, tunnel_statuses=None, encryption=None, enabled=None, state=None, dh_group=None, authentication=None, pre_shared_key=None, ike_option=None, digest_algorithm=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -AUTHENTICATION_PSK = 'PSK'
    -
    - -
    -
    -AUTHENTICATION_UNKNOWN = 'UNKNOWN'
    -
    - -
    -
    -DH_GROUP_DH14 = 'DH14'
    -
    - -
    -
    -DH_GROUP_DH15 = 'DH15'
    -
    - -
    -
    -DH_GROUP_DH16 = 'DH16'
    -
    - -
    -
    -DH_GROUP_DH2 = 'DH2'
    -
    - -
    -
    -DH_GROUP_DH5 = 'DH5'
    -
    - -
    -
    -DH_GROUP_UNKNOWN = 'UNKNOWN'
    -
    - -
    -
    -DIGEST_ALGORITHM_SHA1 = 'SHA1'
    -
    - -
    -
    -DIGEST_ALGORITHM_SHA_256 = 'SHA_256'
    -
    - -
    -
    -ENCRYPTION_AES = 'AES'
    -
    - -
    -
    -ENCRYPTION_AES256 = 'AES256'
    -
    - -
    -
    -ENCRYPTION_AES_GCM = 'AES_GCM'
    -
    - -
    -
    -ENCRYPTION_TRIPLE_DES = 'TRIPLE_DES'
    -
    - -
    -
    -ENCRYPTION_UNKNOWN = 'UNKNOWN'
    -
    - -
    -
    -IKE_OPTION_IKEV1 = 'IKEV1'
    -
    - -
    -
    -IKE_OPTION_IKEV2 = 'IKEV2'
    -
    - -
    -
    -STATE_CONNECTED = 'CONNECTED'
    -
    - -
    -
    -STATE_DISCONNECTED = 'DISCONNECTED'
    -
    - -
    -
    -STATE_PARTIALLY_CONNECTED = 'PARTIALLY_CONNECTED'
    -
    - -
    -
    -STATE_UNKNOWN = 'UNKNOWN'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.VpnChannelStatus(channel_status=None, channel_state=None, last_info_message=None, failure_message=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -CHANNEL_STATUS_CONNECTED = 'CONNECTED'
    -
    - -
    -
    -CHANNEL_STATUS_DISCONNECTED = 'DISCONNECTED'
    -
    - -
    -
    -CHANNEL_STATUS_UNKNOWN = 'UNKNOWN'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.VpnTunnelStatus(on_prem_subnet=None, traffic_stats=None, last_info_message=None, local_subnet=None, tunnel_state=None, failure_message=None, tunnel_status=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
    -
    -
    -
    -
    -TUNNEL_STATUS_CONNECTED = 'CONNECTED'
    -
    - -
    -
    -TUNNEL_STATUS_DISCONNECTED = 'DISCONNECTED'
    -
    - -
    -
    -TUNNEL_STATUS_UNKNOWN = 'UNKNOWN'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.VpnTunnelTrafficStats(packets_out=None, packet_received_errors=None, rx_bytes_on_local_subnet=None, replay_errors=None, sequence_number_over_flow_errors=None, encryption_failures=None, integrity_errors=None, packet_sent_errors=None, decryption_failures=None, packets_in=None, tx_bytes_from_local_subnet=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • packets_out (str or None) –

      • -

    • packet_received_errors (str or None) –

      • -

    • rx_bytes_on_local_subnet (str or None) –

      • -

    • replay_errors (str or None) –

      • -

    • sequence_number_over_flow_errors (str or None) –

      • -

    • encryption_failures (str or None) –

      • -

    • integrity_errors (str or None) –

      • -

    • packet_sent_errors (str or None) –

      • -

    • decryption_failures (str or None) –

      • -

    • packets_in (str or None) –

      • -

    • tx_bytes_from_local_subnet (str or None) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VsanAvailableCapacity(cost=None, quality=None, size=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Infomation about an available vSAN capacity in a cluster.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • cost (str) –

      • -

    • quality (str) –

      • -

    • size (long) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VsanClusterReconfigBias(short_description=None, full_description=None, id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Bias for reconfiguring vSAN in a cluster.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • short_description (str) –

      • -

    • full_description (str) –

      • -

    • id (str) –

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VsanClusterReconfigConstraints(reconfig_biases=None, available_capacities=None, default_capacities=None, hosts=None, default_reconfig_bias_id=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Storage constraint information for reconfiguring vSAN in existing cluster.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • reconfig_biases (list of VsanClusterReconfigBias) – Biases to reconfigure vSAN in an existing cluster.

      • -

    • available_capacities (dict of str and list of VsanAvailableCapacity) – A map of VsanClusterReconfigBias id to the list of -VsanAvailableCapacity. It gives all of available vSAN capacities -for each of reconfiguration biases.

      • -

    • default_capacities (dict of str and VsanAvailableCapacity) – A map of VsanClusterReconfigBias id to a VsanAvailableCapacity. It -gives the default VsanAvailableCapacity for each of reconfiguration -biases.

      • -

    • hosts (long) – The number of hosts in a cluster for the constraints. format: int32

      • -

    • default_reconfig_bias_id (str) – The id of default VsanClusterReconfigBias for this constraints.

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VsanConfigConstraints(max_capacity=None, recommended_capacities=None, supported_capacity_increment=None, min_capacity=None, num_hosts=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    This describes the possible physical storage capacity choices for use with -a given VsanStorageDesigner implementation. These choices are specific to a -customer-defined number of hosts per cluster.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • max_capacity (long) – Maximum capacity supported for cluster (GiB). format: int64

      • -

    • recommended_capacities (list of long) – List of supported capacities which may offer preferable performance -(GiB). format: int64

      • -

    • supported_capacity_increment (long or None) – Increment to be added to min_capacity to result in a supported -capacity (GiB). format: int64

      • -

    • min_capacity (long) – Minimum capacity supported for cluster (GiB). format: int64

      • -

    • num_hosts (long) – Number of hosts in cluster. format: int64

      • -
    -
    -
    -
    - -
    -
    -class com.vmware.vmc.model_client.VsanDiskgroupMapping(mapping_type=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -

    Polymorphic object representing host storage spec.

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -

    mapping_type (str) –

    Possible values are:

    - -

    -
    -
    -
    -
    -MAPPING_TYPE_CANONICAL = 'CANONICAL'
    -
    - -
    -
    -MAPPING_TYPE_SERIAL = 'SERIAL'
    -
    - -
    -
    -MAPPING_TYPE_SYMMETRIC = 'SYMMETRIC'
    -
    - -
    - -
    -
    -class com.vmware.vmc.model_client.VsanEncryptionConfig(port=None, certificate=None)
    -

    Bases: vmware.vapi.bindings.struct.VapiStruct

    -
    -

    Tip

    -

    The arguments are used to initialize data attributes with the same -names.

    -
    -
    -
    Parameters
    -
      -

    • port (long or None) – Port to connect to AWS Key Management Service

      • -

    • certificate (str or None) – Public certificate used to connect to AWS Key Management Service

      • -
    -
    -
    -
    - -
    -
    -

    com.vmware.vmc.orgs_client module

    -
    - -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -get(org)
    -

    Gets a link that can be used on a customer’s account to start the -linking process.

    -
    -
    Parameters
    -

    org (str) – Organization identifier (required)

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Error -Generic Error

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.PaymentMethods(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -get_org_payment_methods(org, default_flag=None)
    -

    Get payment methods of organization

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • default_flag (bool or None) – When true, will only return default payment methods. (optional, -default to false)

      • -
    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.PaymentMethodInfo

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Organization doesn’t exist

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.Providers(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -list(org)
    -
    -
    Parameters
    -

    org (str) – Organization identifier (required)

    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.AwsCloudProvider

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Organization doesn’t exist

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.Reservations(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -list(org)
    -

    Get all reservations for this org

    -
    -
    Parameters
    -

    org (str) – Organization identifier (required)

    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.MaintenanceWindowEntry

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Access not allowed to the operation for the current user

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.SddcTemplates(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -delete(org, template_id)
    -

    Delete SDDC template identified by given id.

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • template_id (str) – SDDC Template identifier (required)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Task

    -
    -
    Returns
    -

    com.vmware.vmc.model.Task

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    -
    -get(org, template_id)
    -

    Get configuration template by given template id.

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • template_id (str) – SDDC Template identifier (required)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.SddcTemplate

    -
    -
    Returns
    -

    com.vmware.vmc.model.SddcTemplate

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Cannot find the SDDC Template with given identifier

    -
    -
    -
    - -
    -
    -list(org)
    -

    List all available SDDC configuration templates in an organization

    -
    -
    Parameters
    -

    org (str) – Organization identifier (required)

    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.SddcTemplate

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.Sddcs(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -create(org, sddc_config, validate_only=None)
    -

    Provision an SDDC in target cloud

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • sddc_config (com.vmware.vmc.model_client.AwsSddcConfig) – sddcConfig (required)

      • -

    • validate_only (bool or None) – When true, only validates the given sddc configuration without -provisioning. (optional)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Task

    -
    -
    Returns
    -

    com.vmware.vmc.model.Task

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    -
    -delete(org, sddc, retain_configuration=None, template_name=None, force=None)
    -

    Delete SDDC

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • sddc (str) – Sddc identifier (required)

      • -

    • retain_configuration (bool or None) – If = ‘true’, the SDDC’s configuration is retained as a template for -later use. This flag is applicable only to SDDCs in ACTIVE state. -(optional)

      • -

    • template_name (str or None) – Only applicable when retainConfiguration is also set to ‘true’. -When set, this value will be used as the name of the SDDC -configuration template generated. (optional)

      • -

    • force (bool or None) – If = true, will delete forcefully. Beware: do not use the force -flag if there is a chance an active provisioning or deleting task -is running against this SDDC. This option is restricted. (optional)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Task

    -
    -
    Returns
    -

    com.vmware.vmc.model.Task

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.InvalidRequest -The sddc is not in a state that’s valid for deletion

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Access not allowed to the operation for the current user

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Cannot find the SDDC with given identifier

    -
    -
    -
    - -
    -
    -get(org, sddc)
    -

    Get SDDC

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • sddc (str) – Sddc identifier (required)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Sddc

    -
    -
    Returns
    -

    com.vmware.vmc.model.Sddc

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Cannot find the SDDC with given identifier

    -
    -
    -
    - -
    -
    -list(org, include_deleted=None)
    -

    List all the SDDCs of an organization

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • include_deleted (bool or None) – When true, forces the result to also include deleted SDDCs. -(optional)

      • -
    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.Sddc

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    -
    -patch(org, sddc, sddc_patch_request)
    -

    Patch SDDC

    -
    -
    Parameters
    -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Sddc

    -
    -
    Returns
    -

    com.vmware.vmc.model.Sddc

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.InvalidRequest -SDDC cannot be patched

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Cannot find the SDDC with given identifier

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.StubFactory(stub_config)
    -

    Bases: vmware.vapi.bindings.stub.StubFactoryBase

    -

    Initialize StubFactoryBase

    -
    -
    Parameters
    -

    stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

    -
    -
    -
    - -
    -
    -class com.vmware.vmc.orgs_client.Subscriptions(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -GET_0_OFFER_TYPE_ON_DEMAND = 'ON_DEMAND'
    -

    Possible value for offerType of method Subscriptions.get_0().

    -
    - -
    -
    -GET_0_OFFER_TYPE_TERM = 'TERM'
    -

    Possible value for offerType of method Subscriptions.get_0().

    -
    - -
    -
    -create(org, subscription_request)
    -

    Initiates the creation of a subscription

    -
    -
    Parameters
    -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Task

    -
    -
    Returns
    -

    com.vmware.vmc.model.Task

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.InternalServerError -Server error. Check retryable flag to see if request should be -retried.

    -
    -
    -
    - -
    -
    -get(org, subscription)
    -

    Get subscription details for a given subscription id

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • subscription (str) – SubscriptionId for an sddc. (required)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.SubscriptionDetails

    -
    -
    Returns
    -

    com.vmware.vmc.model.SubscriptionDetails

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.InternalServerError -Server error. Check retryable flag to see if request should be -retried.

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    -
    - -
    -
    -get_0(org, offer_type=None)
    -

    Returns all subscriptions for a given org id

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • offer_type (str or None) – Offer Type * \`ON_DEMAND\` - on-demand subscription * -\`TERM\` - term subscription * All subscriptions if not -specified (optional)

      • -
    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.SubscriptionDetails

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.InternalServerError -Server error. Check retryable flag to see if request should be -retried.

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Not Found

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.Tasks(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -get(org, task)
    -

    Retrieve details of a task.

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • task (str) – Task identifier (required)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Task

    -
    -
    Returns
    -

    com.vmware.vmc.model.Task

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Cannot find the task with given identifier

    -
    -
    -
    - -
    -
    -list(org, filter=None)
    -

    List all tasks with optional filtering.

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • filter (str or None) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, -‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘ -(minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, -‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed -using ‘.’ Dates must be formatted as yyyy-MM-dd or -yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single -quotes, escape single quote with two single quotes The special -literal ‘created’ will be mapped to the time the resource was first -created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and -(org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - -$filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) -and (sddc.status eq ‘READY’) (optional)

      • -
    -
    -
    Return type
    -

    list of com.vmware.vmc.model_client.Task

    -
    -
    Returns
    -

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    -
    -update(org, task, action=None)
    -

    Request that a running task be canceled. This is advisory only, some -tasks may not be cancelable, and some tasks might take an arbitrary -amount of time to respond to a cancelation request. The task must be -monitored to determine subsequent status.

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • task (str) – Task identifier (required)

      • -

    • action (str or None) – If = ‘cancel’, task will be canceled (optional)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.Task

    -
    -
    Returns
    -

    com.vmware.vmc.model.Task

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.InvalidRequest -Invalid action or bad argument

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.NotFound -Cannot find the task with given identifier

    -
    -
    -
    - -
    - -
    -
    -class com.vmware.vmc.orgs_client.Tos(config)
    -

    Bases: vmware.vapi.bindings.stub.VapiInterface

    -
    -
    Parameters
    -

    config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

    -
    -
    -
    -
    -get(org, terms_id)
    -

    Queries for the terms of service of a given org.

    -
    -
    Parameters
    -
      -

    • org (str) – Organization identifier (required)

      • -

    • terms_id (str) – The terms of service reference ID to check on. (required)

      • -
    -
    -
    Return type
    -

    com.vmware.vmc.model_client.TermsOfServiceResult

    -
    -
    Returns
    -

    com.vmware.vmc.model.TermsOfServiceResult

    -
    -
    Raise
    -

    com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

    -
    -
    -
    - -
    - +
    +

    com.vmware.vmc.orgs_client module

    @@ -5661,37 +242,29 @@ Forbidden

    - diff --git a/vmc/com.vmware.vmc.orgs.aws.html b/vmc/com.vmware.vmc.orgs.aws.html index 0b7042ca..2a5f6536 100644 --- a/vmc/com.vmware.vmc.orgs.aws.html +++ b/vmc/com.vmware.vmc.orgs.aws.html @@ -3,11 +3,11 @@ - + - + - com.vmware.vmc.orgs.aws package — vmc 1.30.0 documentation + com.vmware.vmc.orgs.aws package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
    - 1.30.0 + 1.31.0
    @@ -93,7 +95,7 @@
  • com.vmware package
    • @@ -141,6 +143,8 @@ + +
    - diff --git a/vmc/com.vmware.vmc.orgs.aws.resources.html b/vmc/com.vmware.vmc.orgs.aws.resources.html index fb0d51cb..4eaab9aa 100644 --- a/vmc/com.vmware.vmc.orgs.aws.resources.html +++ b/vmc/com.vmware.vmc.orgs.aws.resources.html @@ -3,11 +3,11 @@ - + - + - com.vmware.vmc.orgs.aws.resources package — vmc 1.30.0 documentation + com.vmware.vmc.orgs.aws.resources package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
    - 1.30.0 + 1.31.0
    @@ -93,7 +95,7 @@
  • com.vmware package
    • @@ -141,6 +143,8 @@ + +
      @@ -162,7 +166,7 @@
    • - + View page source @@ -181,84 +185,8 @@

      Submodules

      -
      -

      com.vmware.vmc.orgs.aws.resources.servicequotas_client module

      -
      -
      -class com.vmware.vmc.orgs.aws.resources.servicequotas_client.Requests(config)
      -

      Bases: vmware.vapi.bindings.stub.VapiInterface

      -
      -
      Parameters
      -

      config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

      -
      -
      -
      -
      -get(org, service_quota_request_id)
      -

      Get Service Quota Request by its Id

      -
      -
      Parameters
      -
        -

      • org (str) – Organization identifier (required)

        • -

      • service_quota_request_id (str) – The UUID of the service quota request (required)

        • -
      -
      -
      Return type
      -

      com.vmware.vmc.model_client.ServiceQuotaRequest

      -
      -
      Returns
      -

      com.vmware.vmc.model.ServiceQuotaRequest

      -
      -
      Raise
      -

      com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

      -
      -
      Raise
      -

      com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

      -
      -
      -
      - -
      -
      -list(org)
      -

      List all service quota requests of an org

      -
      -
      Parameters
      -

      org (str) – Organization identifier (required)

      -
      -
      Return type
      -

      list of com.vmware.vmc.model_client.ServiceQuotaRequest

      -
      -
      Returns
      -

      -
      -
      Raise
      -

      com.vmware.vapi.std.errors_client.Unauthenticated -Unauthorized

      -
      -
      Raise
      -

      com.vmware.vapi.std.errors_client.Unauthorized -Forbidden

      -
      -
      -
      - -
      - -
      -
      -class com.vmware.vmc.orgs.aws.resources.servicequotas_client.StubFactory(stub_config)
      -

      Bases: vmware.vapi.bindings.stub.StubFactoryBase

      -

      Initialize StubFactoryBase

      -
      -
      Parameters
      -

      stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

      -
      -
      -
      - +
      +

      com.vmware.vmc.orgs.aws.resources.servicequotas_client module

      @@ -267,37 +195,29 @@ Forbidden

    - diff --git a/vmc/com.vmware.vmc.orgs.html b/vmc/com.vmware.vmc.orgs.html index 80ea5a0a..278b424d 100644 --- a/vmc/com.vmware.vmc.orgs.html +++ b/vmc/com.vmware.vmc.orgs.html @@ -3,11 +3,11 @@ - + - + - com.vmware.vmc.orgs package — vmc 1.30.0 documentation + com.vmware.vmc.orgs package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
    - 1.30.0 + 1.31.0
    @@ -93,7 +95,7 @@
  • com.vmware package
    • @@ -141,6 +143,8 @@ + +
    @@ -214,1170 +218,23 @@

    Submodules

    - diff --git a/vmc/index.html b/vmc/index.html index 9a83b811..0edb42d6 100644 --- a/vmc/index.html +++ b/vmc/index.html @@ -3,11 +3,11 @@ - + - + - Welcome to vmc’s documentation! — vmc 1.30.0 documentation + Welcome to vmc’s documentation! — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -50,7 +52,7 @@ - vmc + vmc @@ -60,7 +62,7 @@
    - 1.30.0 + 1.31.0
    @@ -129,6 +131,8 @@ + +
  • Submodules
    • -
  • com.vmware.vmc.orgs.account_link_client module
    • -
  • com.vmware.vmc.orgs.reservations_client module
    • -
  • com.vmware.vmc.orgs.sddcs_client module
    • -
  • com.vmware.vmc.orgs.storage_client module
    • -
  • com.vmware.vmc.orgs.subscriptions_client module
    • -
  • com.vmware.vmc.orgs.tbrs_client module
    • +
  • com.vmware.vmc.orgs.account_link_client module
    • +
  • com.vmware.vmc.orgs.reservations_client module
    • +
  • com.vmware.vmc.orgs.sddcs_client module
    • +
  • com.vmware.vmc.orgs.storage_client module
    • +
  • com.vmware.vmc.orgs.subscriptions_client module
    • +
  • com.vmware.vmc.orgs.tbrs_client module
  • Submodules
    • -
  • com.vmware.vmc.model_client module
    • -
  • com.vmware.vmc.orgs_client module
    • +
  • com.vmware.vmc.model_client module
    • +
  • com.vmware.vmc.orgs_client module
  • Submodules
    • -
  • com.vmware.vmc_client module
    • +
  • com.vmware.vmc_client module
    • @@ -216,7 +220,7 @@
  • vmware.vapi.vmc package
    • @@ -244,35 +248,28 @@
    -
    diff --git a/vmc/objects.inv b/vmc/objects.inv index 67dbf386..4a99c3d8 100644 Binary files a/vmc/objects.inv and b/vmc/objects.inv differ diff --git a/vmc/py-modindex.html b/vmc/py-modindex.html index 95391362..65e644d0 100644 --- a/vmc/py-modindex.html +++ b/vmc/py-modindex.html @@ -3,11 +3,11 @@ - + - + - Python Module Index — vmc 1.30.0 documentation + Python Module Index — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -52,7 +54,7 @@ - vmc + vmc @@ -62,7 +64,7 @@
    - 1.30.0 + 1.31.0
    @@ -131,6 +133,8 @@ + +
    - diff --git a/vmc/search.html b/vmc/search.html index f57d9fe5..1207bbbe 100644 --- a/vmc/search.html +++ b/vmc/search.html @@ -3,11 +3,11 @@ - + - + - Search — vmc 1.30.0 documentation + Search — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
    - 1.30.0 + 1.31.0
    @@ -136,6 +138,8 @@ + +
    @@ -189,37 +193,29 @@
    - diff --git a/vmc/vmware.vapi.html b/vmc/vmware.vapi.html index 256f98af..1fdef9e2 100644 --- a/vmc/vmware.vapi.html +++ b/vmc/vmware.vapi.html @@ -3,11 +3,11 @@ - + - + - vmware.vapi package — vmc 1.30.0 documentation + vmware.vapi package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -51,7 +53,7 @@ - vmc + vmc @@ -61,7 +63,7 @@
    - 1.30.0 + 1.31.0
    @@ -139,6 +141,8 @@ + +
    @@ -188,37 +192,29 @@
    - diff --git a/vmc/vmware.vapi.vmc.html b/vmc/vmware.vapi.vmc.html index 91d40a11..1aee0c23 100644 --- a/vmc/vmware.vapi.vmc.html +++ b/vmc/vmware.vapi.vmc.html @@ -3,11 +3,11 @@ - + - + - vmware.vapi.vmc package — vmc 1.30.0 documentation + vmware.vapi.vmc package — vmc 1.31.0 documentation @@ -16,10 +16,13 @@ + + + @@ -29,7 +32,6 @@ - @@ -50,7 +52,7 @@ - vmc + vmc @@ -60,7 +62,7 @@
    - 1.30.0 + 1.31.0
    @@ -138,6 +140,8 @@ + +
      @@ -153,7 +157,7 @@
    • - + View page source @@ -175,80 +179,8 @@

      vmware.vapi.vmc.client module

      -
      -

      vmware.vapi.vmc.csp_filter module

      -

      CSP Refresh token based SecurityContextFilter

      -
      -
      -class vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter(session, refresh_token, refresh_url)
      -

      Bases: vmware.vapi.security.client.security_context_filter.SecurityContextFilter

      -

      CSP Security Context filter in API Provider chain adds the security -context based on a refresh token to the execution context passed in.

      -

      Initialize SecurityContextFilter

      -
      -
      Parameters
      -
        -

      • session (requests.Session) – Requests Session object to use for making HTTP calls

        • -

      • refresh_token (str) – Refresh token to use for obtaining an access token

        • -

      • refresh_url (str) – URL that allows exchanging a refresh token for an -access token

        • -
      -
      -
      -
      -
      -get_max_retries()
      -

      Get the max number of retries

      -
      -
      Return type
      -

      int

      -
      -
      Returns
      -

      Number of retries

      -
      -
      -
      - -
      -
      -get_security_context(on_error)
      -

      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.

      -
      -
      Parameters
      -

      on_error (bool) – Whether this method is called after getting an error

      -
      -
      Return type
      -

      vmware.vapi.core.SecurityContext

      -
      -
      Returns
      -

      Security context

      -
      -
      -
      - -
      -
      -should_retry(error_value)
      -

      Returns whether the request should be retried or not based on the error -specified.

      -
      -
      Parameters
      -

      error_value (vmware.vapi.data.value.ErrorValue) – Method error

      -
      -
      Return type
      -

      bool

      -
      -
      Returns
      -

      Returns True if request should be retried in case the error is -either Unauthenticated or Unauthorized else False

      -
      -
      -
      - -
      - +
      +

      vmware.vapi.vmc.csp_filter module

      @@ -257,35 +189,28 @@ either Unauthenticated or Unauthorized else False

    -