1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 03:10:00 -05:00
vsphere-automation-sdk-python/vmc/com.vmware.vmc.orgs.sddcs.networks.edges.html

1019 lines
70 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">
<title>com.vmware.vmc.orgs.sddcs.networks.edges package &mdash; vmc 1.26.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 src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
2019-05-29 06:01:09 -04:00
<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.edges.firewall package" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html" />
<link rel="prev" title="com.vmware.vmc.orgs.sddcs.networks.cgws package" href="com.vmware.vmc.orgs.sddcs.networks.cgws.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"> vmc
2018-08-07 19:42:25 -04:00
</a>
<div class="version">
1.26.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">vmc</a>
2018-08-07 19:42:25 -04:00
</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><a href="com.vmware.vmc.orgs.sddcs.html">com.vmware.vmc.orgs.sddcs package</a> &raquo;</li>
<li><a href="com.vmware.vmc.orgs.sddcs.networks.html">com.vmware.vmc.orgs.sddcs.networks package</a> &raquo;</li>
<li>com.vmware.vmc.orgs.sddcs.networks.edges package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vmc.orgs.sddcs.networks.edges.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.networks.edges">
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-package"></span><h1>com.vmware.vmc.orgs.sddcs.networks.edges package<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges" 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.edges.firewall.html">com.vmware.vmc.orgs.sddcs.networks.edges.firewall package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.firewall.html#submodules">Submodules</a></li>
<li class="toctree-l2"><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-l1"><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-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.html#submodules">Submodules</a></li>
<li class="toctree-l2"><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-l1"><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-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.nat.html#submodules">Submodules</a></li>
<li class="toctree-l2"><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-l1"><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-l2"><a class="reference internal" href="com.vmware.vmc.orgs.sddcs.networks.edges.statistics.html#submodules">Submodules</a></li>
<li class="toctree-l2"><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-l2"><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>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client">
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-dhcp-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.</code><code class="sig-name descname">Leaseinfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve DHCP leaseinfo of a management or compute gateway (NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.DhcpLeases" title="com.vmware.vmc.model_client.DhcpLeases"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DhcpLeases</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.DhcpLeases</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_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-06-08 00:29:34 -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.edges.dns_client">
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-dns-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.dns_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.dns_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">enable</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.create" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Enable or disable DNS configuration for a management or compute gateway
(NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>enable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) Set to true to enable, set to false to disable. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.delete" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Delete DNS server configuration for a management or compute gateway
(NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve DNS server configuration for a management or compute gateway
(NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.DnsConfig" title="com.vmware.vmc.model_client.DnsConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DnsConfig</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.DnsConfig</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">dns_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config.update" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Configure DNS server configuration for a management or compute gateway
(NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>dns_config</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.DnsConfig" title="com.vmware.vmc.model_client.DnsConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DnsConfig</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve DNS server statistics for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.DnsStatusAndStats" title="com.vmware.vmc.model_client.DnsStatusAndStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.DnsStatusAndStats</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.DnsStatusAndStats</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.dns_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-06-08 00:29:34 -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.edges.firewall_client">
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-firewall-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config.delete" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Delete firewall configuration for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve the firewall configuration for a management or compute gateway
(NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.FirewallConfig" title="com.vmware.vmc.model_client.FirewallConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.FirewallConfig</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.FirewallConfig</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">firewall_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config.update" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Configure firewall for a management or compute gateway (NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>firewall_config</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.FirewallConfig" title="com.vmware.vmc.model_client.FirewallConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.FirewallConfig</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve statistics for a specific firewall rule for a management or
compute gateway (NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) Rule Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.FirewallRuleStats" title="com.vmware.vmc.model_client.FirewallRuleStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.FirewallRuleStats</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.FirewallRuleStats</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.firewall_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-06-08 00:29:34 -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.edges.ipsec_client">
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-ipsec-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config.delete" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Delete IPsec VPN configuration for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">show_sensitive_data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve IPsec VPN configuration for a management or compute gateway
(NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>show_sensitive_data</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Set to true to show sensitive data. Default value is false.
(optional)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.Ipsec" title="com.vmware.vmc.model_client.Ipsec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Ipsec</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Ipsec</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">ipsec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config.update" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Modify IPsec VPN configuration for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>ipsec</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Ipsec" title="com.vmware.vmc.model_client.Ipsec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Ipsec</span></code></a>) IPsec Configuration dto object. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve IPsec VPN statistics for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.IpsecStatusAndStats" title="com.vmware.vmc.model_client.IpsecStatusAndStats"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.IpsecStatusAndStats</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.IpsecStatusAndStats</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_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-06-08 00:29:34 -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.edges.nat_client">
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-nat-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.nat_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.nat_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.</code><code class="sig-name descname">Config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config.delete" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Delete all NAT configuration for the specified management or compute
gateway (NSX Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve NAT configuration for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.Nat" title="com.vmware.vmc.model_client.Nat"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nat</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.Nat</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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">nat</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config.update" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Modify NAT configuration for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>nat</strong> (<a class="reference internal" href="com.vmware.vmc.html#com.vmware.vmc.model_client.Nat" title="com.vmware.vmc.model_client.Nat"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.Nat</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.nat_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-06-08 00:29:34 -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.edges.statistics_client">
<span id="com-vmware-vmc-orgs-sddcs-networks-edges-statistics-client-module"></span><h2>com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client module<a class="headerlink" href="#module-com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.</code><code class="sig-name descname">Interfaces</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces" 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-06-08 00:29:34 -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>
<dl class="py method">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">sddc</span></em>, <em class="sig-param"><span class="n">edge_id</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Retrieve interface statistics for a management or compute gateway (NSX
Edge).</p>
2019-06-08 00:29:34 -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_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Edge Identifier. (required)</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Show statistics from this start time (in milliseconds since epoch).
(optional)</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Show statistics until this end time (in milliseconds since epoch).
(optional)</p></li>
2018-08-07 19:42:25 -04:00
</ul>
2019-06-08 00:29:34 -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.CbmStatistics" title="com.vmware.vmc.model_client.CbmStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.model_client.CbmStatistics</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.model.CbmStatistics</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
2018-08-07 19:42:25 -04:00
Bad request. Request object passed is invalid.</p>
2019-06-08 00:29:34 -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-06-08 00:29:34 -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-06-08 00:29:34 -04:00
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="py class">
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.orgs.sddcs.networks.edges.statistics_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-06-08 00:29:34 -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.edges.firewall.html" class="btn btn-neutral float-right" title="com.vmware.vmc.orgs.sddcs.networks.edges.firewall 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.sddcs.networks.cgws.html" class="btn btn-neutral float-left" title="com.vmware.vmc.orgs.sddcs.networks.cgws 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>
&copy; Copyright 2020, 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>