1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
vsphere-automation-sdk-python/vmc/com.vmware.vmc.orgs.sddcs.html

874 lines
59 KiB
HTML
Raw Normal View History

2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
2019-05-29 06:01:09 -04:00
<title>com.vmware.vmc.orgs.sddcs package &mdash; VMware Cloud on AWS Console API 1.4.0 documentation</title>
2018-08-07 19:42:25 -04:00
2019-05-29 06:01:09 -04:00
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
2019-04-17 00:48:58 -04:00
2019-04-15 06:06:35 -04:00
2019-05-29 06:01:09 -04:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
2018-08-07 19:42:25 -04:00
2019-05-29 06:01:09 -04:00
2019-04-17 00:48:58 -04:00
2019-05-29 06:01:09 -04:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
2018-08-07 19:42:25 -04:00
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vmc.orgs.sddcs.networks package" href="com.vmware.vmc.orgs.sddcs.networks.html" />
<link rel="prev" title="com.vmware.vmc.orgs package" href="com.vmware.vmc.orgs.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
2019-05-29 06:01:09 -04:00
<div class="wy-side-nav-search" >
2018-08-07 19:42:25 -04:00
<a href="index.html" class="icon icon-home"> VMware Cloud on AWS Console API
</a>
<div class="version">
2019-05-29 06:01:09 -04:00
1.4.0
2018-08-07 19:42:25 -04:00
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vmc_client">com.vmware.vmc_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
2019-01-16 05:37:32 -05:00
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
2018-08-07 19:42:25 -04:00
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">VMware Cloud on AWS Console API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vmc.html">com.vmware.vmc package</a> &raquo;</li>
<li><a href="com.vmware.vmc.orgs.html">com.vmware.vmc.orgs package</a> &raquo;</li>
<li>com.vmware.vmc.orgs.sddcs package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vmc.orgs.sddcs.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vmc.orgs.sddcs">
<span id="com-vmware-vmc-orgs-sddcs-package"></span><h1>com.vmware.vmc.orgs.sddcs package<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html">com.vmware.vmc.orgs.sddcs.networks package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.cgws.html">com.vmware.vmc.orgs.sddcs.networks.cgws package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.cgws.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.cgws.html#module-com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client">com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html">com.vmware.vmc.orgs.sddcs.networks.edges package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html">com.vmware.vmc.orgs.sddcs.networks.edges.firewall package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html">com.vmware.vmc.orgs.sddcs.networks.edges.nat package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client module</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html">com.vmware.vmc.orgs.sddcs.networks.edges.statistics package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client module</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client">com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.dns_client">com.vmware.vmc.orgs.sddcs.networks.edges.dns_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client">com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client">com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat_client">com.vmware.vmc.orgs.sddcs.networks.edges.nat_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.html#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client">com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.html#module-com.vmware.vmc.orgs.sddcs.networks.edges_client">com.vmware.vmc.orgs.sddcs.networks.edges_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
2019-05-29 06:01:09 -04:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.addons_client">
<span id="com-vmware-vmc-orgs-sddcs-addons-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.addons_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.addons_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.addons_client.</code><code class="descname">Credentials</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="attribute">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX">
<code class="descname">CREATE_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.CREATE_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.create()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX">
<code class="descname">GET_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.GET_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.get()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.LIST_ADDON_TYPE_HCX">
<code class="descname">LIST_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.LIST_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.list()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.UPDATE_ADDON_TYPE_HCX">
<code class="descname">UPDATE_ADDON_TYPE_HCX</code><em class="property"> = 'HCX'</em><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.UPDATE_ADDON_TYPE_HCX" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">addonType</span></code> of method <a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Credentials.update()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create">
<code class="descname">create</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em>, <em>credentials</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.create" title="Permalink to this definition"></a></dt>
<dd><p>Associated a new add on credentials with the SDDC such as HCX</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Add on type (required)</p></li>
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a>) Credentials creation payload (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ConcurrentChange</span></code>
Credentials with same name exists with in the scope of addOnType</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Invalid input</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.get" title="Permalink to this definition"></a></dt>
<dd><p>Get credential details by name</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Add on type (required)</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) name of the credentials (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list">
<code class="descname">list</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="Permalink to this definition"></a></dt>
<dd><p>List all the credentials assoicated with an addon type with in a SDDC</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Add on type (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list" title="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc_id</em>, <em>addon_type</em>, <em>name</em>, <em>credentials</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.Credentials.update" title="Permalink to this definition"></a></dt>
<dd><p>Update credential details</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Org id of the associated SDDC (required)</p></li>
<li><p><strong>sddc_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Id of the SDDC (required)</p></li>
<li><p><strong>addon_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Add on type (required)</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) name of the credentials (required)</p></li>
<li><p><strong>credentials</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.UpdateCredentials" title="com.vmware.vmc.model_client.UpdateCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.UpdateCredentials</span></code></a>) Credentials update payload (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.NewCredentials" title="com.vmware.vmc.model_client.NewCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.NewCredentials</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.NewCredentials</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad request</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.addons_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.addons_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.addons_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
2018-08-07 19:42:25 -04:00
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.dns_client">
<span id="com-vmware-vmc-orgs-sddcs-dns-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.dns_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.dns_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Private">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.dns_client.</code><code class="descname">Private</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Private" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Private.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Private.update" title="Permalink to this definition"></a></dt>
<dd><p>Update the DNS records of management VMs to use private IP addresses</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2019-01-16 05:37:32 -05:00
The sddc is not in a state thats valid for updates or invalid body</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Public">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.dns_client.</code><code class="descname">Public</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Public" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.Public.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.Public.update" title="Permalink to this definition"></a></dt>
<dd><p>Update the DNS records of management VMs to use public IP addresses</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2019-01-16 05:37:32 -05:00
The sddc is not in a state thats valid for updates or invalid body</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.dns_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.dns_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.dns_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.networking_client">
<span id="com-vmware-vmc-orgs-sddcs-networking-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networking_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networking_client" title="Permalink to this headline"></a></h2>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networking_client.</code><code class="descname">ConnectivityTests</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve metadata for connectivity tests.</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ConnectivityValidationGroups" title="com.vmware.vmc.model_client.ConnectivityValidationGroups"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroups</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.ConnectivityValidationGroups</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.post">
<code class="descname">post</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>request_info</em>, <em>action</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests.post" title="Permalink to this definition"></a></dt>
<dd><p>ConnectivityValidationGroupResultWrapper will be available at
task.params[test_result].</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>request_info</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.ConnectivityValidationGroup" title="com.vmware.vmc.model_client.ConnectivityValidationGroup"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.ConnectivityValidationGroup</span></code></a>) request information (required)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) If = start, start connectivity tests. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Task" title="com.vmware.vmc.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Task</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
2019-01-16 05:37:32 -05:00
Unauthorized</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2019-01-16 05:37:32 -05:00
Bad Request</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2019-01-16 05:37:32 -05:00
Forbidden</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.networking_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networking_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networking_client.StubFactory" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.networks_client">
<span id="com-vmware-vmc-orgs-sddcs-networks-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Edges">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks_client.</code><code class="descname">Edges</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Edges" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Edges.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>edge_type</em>, <em>prev_edge_id=None</em>, <em>start_index=None</em>, <em>page_size=None</em>, <em>sort_order_ascending=None</em>, <em>sort_by=None</em>, <em>filter=None</em>, <em>ld_rname=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Edges.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve information about all management and compute gateways and
other routers (NSX Edges).</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>edge_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Retrieve records matching NSX Edge type (gatewayServices or
2018-08-07 19:42:25 -04:00
distributedRouter). Specify gatewayServices to find management
2019-05-29 06:01:09 -04:00
and compute gateways in your SDDC. (required)</p></li>
<li><p><strong>prev_edge_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Provide Edge ID as prevEdgeId to serve as reference for startIndex.
(optional)</p></li>
<li><p><strong>start_index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Start index for the current page. Default is 0. (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Number of records per page. Default is 256. (optional)</p></li>
<li><p><strong>sort_order_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Set to true to fetch records in ascending sorted order. (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Sort records using one of the column names (id, name, description,
tenantId, size, enableFips). (optional)</p></li>
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Filter records matching the NSX Edge ID, name or description.
(optional)</p></li>
<li><p><strong>ld_rname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) (optional)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.PagedEdgeList" title="com.vmware.vmc.model_client.PagedEdgeList"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.PagedEdgeList</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.PagedEdgeList</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Bad request. Request object passed is invalid.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden. Authorization header not provided</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not found. Requested object not found.</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks_client.</code><code class="descname">Logical</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.create">
<code class="descname">create</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>sddc_network</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a network in an SDDC.</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>sddc_network</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Bad request. Request object passed is invalid.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden. Authorization header not provided.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not found. Requested object not found.</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.delete">
<code class="descname">delete</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>network_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a network in an SDDC.</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Logical Network Identifier (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Bad request. Request object passed is invalid.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden. Authorization header not provided.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not found. Requested object not found.</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>network_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve information about a network in an SDDC.</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Logical Network Identifier (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.SddcNetwork</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Bad request. Request object passed is invalid.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden. Authorization header not provided</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not found. Requested object not found.</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.get_0">
<code class="descname">get_0</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>page_size=None</em>, <em>start_index=None</em>, <em>prev_sddc_network_id=None</em>, <em>sort_order_ascending=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.get_0" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve all networks in an SDDC.</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Page size for pagination. (optional)</p></li>
<li><p><strong>start_index</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Start index of page. (optional)</p></li>
<li><p><strong>prev_sddc_network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Previous logical network id. (optional)</p></li>
<li><p><strong>sort_order_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Sort order ascending. (optional)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DataPageSddcNetwork" title="com.vmware.vmc.model_client.DataPageSddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DataPageSddcNetwork</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.DataPageSddcNetwork</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Bad request. Request object passed is invalid.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden. Authorization header not provided</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not found. Requested object not found.</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.Logical.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>network_id</em>, <em>sddc_network</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.Logical.update" title="Permalink to this definition"></a></dt>
<dd><p>Modify a network in an SDDC.</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Organization identifier. (required)</p></li>
<li><p><strong>sddc</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Sddc Identifier. (required)</p></li>
<li><p><strong>network_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Logical Network Identifier (required)</p></li>
<li><p><strong>sddc_network</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.SddcNetwork" title="com.vmware.vmc.model_client.SddcNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.SddcNetwork</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Bad request. Request object passed is invalid.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
2018-08-07 19:42:25 -04:00
Forbidden. Authorization header not provided.</p>
2019-05-29 06:01:09 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
2018-08-07 19:42:25 -04:00
Not found. Requested object not found.</p>
2019-05-29 06:01:09 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.orgs.sddcs.networks_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.orgs.sddcs.networks_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
2019-05-29 06:01:09 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vmc.orgs.sddcs.networks.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
2019-05-29 06:01:09 -04:00
<a href="com.vmware.vmc.orgs.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
2018-08-07 19:42:25 -04:00
</div>
<hr/>
<div role="contentinfo">
<p>
2019-01-16 05:37:32 -05:00
&copy; Copyright 2019, VMware, Inc.
2018-08-07 19:42:25 -04:00
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2019-05-29 06:01:09 -04:00
</script>
2018-08-07 19:42:25 -04:00
</body>
</html>