mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 20:09:58 -05:00
861 lines
53 KiB
HTML
861 lines
53 KiB
HTML
|
|
|||
|
|
|||
|
<!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.nsx_policy.infra.tier_0s package — NSX-T Policy API 2.3.0.0.3 documentation</title>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
|||
|
|
|||
|
|
|||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|||
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|||
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
|||
|
|
|||
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
<link rel="stylesheet" href="_static/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.nsx_policy.infra.tier_0s.locale_services package" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.html" />
|
|||
|
<link rel="prev" title="com.vmware.nsx_policy.infra.realized_state package" href="com.vmware.nsx_policy.infra.realized_state.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">
|
|||
|
<div class="wy-side-nav-search" >
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<a href="index.html" class="icon icon-home"> NSX-T Policy API
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</a>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<div class="version">
|
|||
|
2.3.0.0.3
|
|||
|
</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.nsx_policy_client">com.vmware.nsx_policy_client module</a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_policy_client_for_vmc">com.vmware.nsx_policy_client_for_vmc module</a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
</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">NSX-T Policy 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> »</li>
|
|||
|
|
|||
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|||
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|||
|
<li><a href="com.vmware.nsx_policy.html">com.vmware.nsx_policy package</a> »</li>
|
|||
|
|
|||
|
<li><a href="com.vmware.nsx_policy.infra.html">com.vmware.nsx_policy.infra package</a> »</li>
|
|||
|
|
|||
|
<li>com.vmware.nsx_policy.infra.tier_0s package</li>
|
|||
|
|
|||
|
|
|||
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|||
|
|
|||
|
<a href="_sources/com.vmware.nsx_policy.infra.tier_0s.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.nsx_policy.infra.tier_0s">
|
|||
|
<span id="com-vmware-nsx-policy-infra-tier-0s-package"></span><h1>com.vmware.nsx_policy.infra.tier_0s package<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.tier_0s" 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.nsx_policy.infra.tier_0s.locale_services.html">com.vmware.nsx_policy.infra.tier_0s.locale_services package</a><ul>
|
|||
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.html#subpackages">Subpackages</a><ul>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.html">com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp package</a><ul>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.html#submodules">Submodules</a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client">com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client module</a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html">com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package</a><ul>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html#submodules">Submodules</a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client">com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client module</a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.html#submodules">Submodules</a></li>
|
|||
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client">com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module</a></li>
|
|||
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client">com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module</a></li>
|
|||
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client">com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_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.nsx_policy.infra.tier_0s.locale_services_client">
|
|||
|
<span id="com-vmware-nsx-policy-infra-tier-0s-locale-services-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
<dl class="class">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp">
|
|||
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services_client.</code><code class="descname">Bgp</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.get">
|
|||
|
<code class="descname">get</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Read BGP routing config</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpRoutingConfig" title="com.vmware.nsx_policy.model_client.BgpRoutingConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BgpRoutingConfig</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.BgpRoutingConfig</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.patch">
|
|||
|
<code class="descname">patch</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>bgp_routing_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.patch" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>If an BGP routing config not present, create BGP routing config. If it
|
|||
|
already exists, update the routing config.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>bgp_routing_config</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpRoutingConfig" title="com.vmware.nsx_policy.model_client.BgpRoutingConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BgpRoutingConfig</span></code></a>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.update">
|
|||
|
<code class="descname">update</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>bgp_routing_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>If BGP routing config is not already present, create BGP routing
|
|||
|
config. If it already exists, replace the BGP routing config with this
|
|||
|
object.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>bgp_routing_config</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpRoutingConfig" title="com.vmware.nsx_policy.model_client.BgpRoutingConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BgpRoutingConfig</span></code></a>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpRoutingConfig" title="com.vmware.nsx_policy.model_client.BgpRoutingConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.BgpRoutingConfig</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.BgpRoutingConfig</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="class">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext">
|
|||
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services_client.</code><code class="descname">L2vpnContext</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext.get">
|
|||
|
<code class="descname">get</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Read L2Vpn Context.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VpnContext" title="com.vmware.nsx_policy.model_client.L2VpnContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L2VpnContext</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.L2VpnContext</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="class">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext">
|
|||
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services_client.</code><code class="descname">L3vpnContext</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.get">
|
|||
|
<code class="descname">get</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Read the L3Vpn Context under tier-0.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3VpnContext" title="com.vmware.nsx_policy.model_client.L3VpnContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3VpnContext</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.L3VpnContext</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.patch">
|
|||
|
<code class="descname">patch</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>l3_vpn_context</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.patch" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Create the new L3Vpn Context under tier-0 if it does not exist. If the
|
|||
|
L3Vpn Context already exists under tier-0, merge with the the existing
|
|||
|
one. This is a patch. If the passed L3VpnContext has new L3VpnRules,
|
|||
|
add them to the existing L3VpnContext. If the passed L3VpnContext also
|
|||
|
has existing L3VpnRules, update the existing L3VpnRules.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3_vpn_context</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3VpnContext" title="com.vmware.nsx_policy.model_client.L3VpnContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3VpnContext</span></code></a>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.update">
|
|||
|
<code class="descname">update</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>l3_vpn_context</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Create the new L3Vpn Context under tier-0 if it does not exist. If the
|
|||
|
L3Vpn Context already exists under tier-0, replace the the existing
|
|||
|
one. This is a full replace.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3_vpn_context</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3VpnContext" title="com.vmware.nsx_policy.model_client.L3VpnContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3VpnContext</span></code></a>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3VpnContext" title="com.vmware.nsx_policy.model_client.L3VpnContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3VpnContext</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.L3VpnContext</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="class">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns">
|
|||
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services_client.</code><code class="descname">L3vpns</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns" 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.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION">
|
|||
|
<code class="descname">LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION</code><em class="property"> = 'PolicyBasedL3VpnSession'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">l3vpnSession</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" title="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">L3vpns.list()</span></code></a>.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="attribute">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION">
|
|||
|
<code class="descname">LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION</code><em class="property"> = 'RouteBasedL3VpnSession'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">l3vpnSession</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" title="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">L3vpns.list()</span></code></a>.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.delete">
|
|||
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>l3vpn_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Delete the L3Vpn with the given id.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3vpn_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.get">
|
|||
|
<code class="descname">get</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>l3vpn_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Read the L3Vpn with the given id. No sensitive data is returned as part
|
|||
|
of the response.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3vpn_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3Vpn" title="com.vmware.nsx_policy.model_client.L3Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3Vpn</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.L3Vpn</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list">
|
|||
|
<code class="descname">list</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>cursor=None</em>, <em>included_fields=None</em>, <em>l3vpn_session=None</em>, <em>page_size=None</em>, <em>sort_ascending=None</em>, <em>sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Paginated list of L3Vpns.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
|
|||
|
by current result page) (optional)</p></li>
|
|||
|
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
|
|||
|
result (optional)</p></li>
|
|||
|
<li><p><strong>l3vpn_session</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>) – Resource type of L3Vpn Session (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>) – Maximum number of results to return in this page (server may return
|
|||
|
fewer) (optional, default to 1000)</p></li>
|
|||
|
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
|
|||
|
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3VpnListResult" title="com.vmware.nsx_policy.model_client.L3VpnListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3VpnListResult</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.L3VpnListResult</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.patch">
|
|||
|
<code class="descname">patch</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>l3vpn_id</em>, <em>l3_vpn</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.patch" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Create the new L3Vpn if it does not exist. If the L3Vpn already exists,
|
|||
|
merge with the the existing one. This is a patch. - If the passed L3Vpn
|
|||
|
is a policy-based one and has new L3VpnRules, add them to the existing
|
|||
|
L3VpnRules. - If the passed L3Vpn is a policy-based one and also has
|
|||
|
existing L3VpnRules, update the existing L3VpnRules.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3vpn_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3_vpn</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3Vpn" title="com.vmware.nsx_policy.model_client.L3Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3Vpn</span></code></a>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.showsensitivedata">
|
|||
|
<code class="descname">showsensitivedata</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>l3vpn_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.showsensitivedata" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Read the L3Vpn with the given id. Sensitive data is returned as part of
|
|||
|
the response.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3vpn_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3Vpn" title="com.vmware.nsx_policy.model_client.L3Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3Vpn</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.L3Vpn</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="method">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.update">
|
|||
|
<code class="descname">update</code><span class="sig-paren">(</span><em>tier0_id</em>, <em>locale_service_id</em>, <em>l3vpn_id</em>, <em>l3_vpn</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.update" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Create a new L3Vpn if the L3Vpn with given id does not already exist.
|
|||
|
If the L3Vpn with the given id already exists, replace the existing
|
|||
|
L3Vpn. This a full replace.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>tier0_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>locale_service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3vpn_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
|
|||
|
<li><p><strong>l3_vpn</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3Vpn" title="com.vmware.nsx_policy.model_client.L3Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3Vpn</span></code></a>) – (required)</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type</dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3Vpn" title="com.vmware.nsx_policy.model_client.L3Vpn"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.L3Vpn</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns</dt>
|
|||
|
<dd class="field-odd"><p>com.vmware.nsx_policy.model.L3Vpn</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
|
|||
|
Service Unavailable</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
|
|||
|
Bad Request, Precondition Failed</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
|
|||
|
Internal Server Error</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise</dt>
|
|||
|
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
Forbidden</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise</dt>
|
|||
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
Not Found</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="class">
|
|||
|
<dt id="com.vmware.nsx_policy.infra.tier_0s.locale_services_client.StubFactory">
|
|||
|
<em class="property">class </em><code class="descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
<p>Initialize StubFactoryBase</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters</dt>
|
|||
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</div>
|
|||
|
</div>
|
|||
|
|
|||
|
|
|||
|
</div>
|
|||
|
|
|||
|
</div>
|
|||
|
<footer>
|
|||
|
|
|||
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|||
|
<a href="com.vmware.nsx_policy.infra.tier_0s.locale_services.html" class="btn btn-neutral float-right" title="com.vmware.nsx_policy.infra.tier_0s.locale_services package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|||
|
|
|||
|
<a href="com.vmware.nsx_policy.infra.realized_state.html" class="btn btn-neutral float-left" title="com.vmware.nsx_policy.infra.realized_state package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|||
|
</div>
|
|||
|
|
|||
|
|
|||
|
<hr/>
|
|||
|
|
|||
|
<div role="contentinfo">
|
|||
|
<p>
|
|||
|
© Copyright 2019, VMware, Inc.
|
|||
|
|
|||
|
</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);
|
|||
|
});
|
|||
|
</script>
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
|
|||
|
</body>
|
|||
|
</html>
|