1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 11:19:59 -05:00
vsphere-automation-sdk-python/nsx/nsx_policy/com.vmware.nsx_policy.infra.tier_1s.html

3137 lines
235 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.nsx_policy.infra.tier_1s package &mdash; NSX-T Policy SDK 2.5.1.0.1 documentation</title>
2018-08-07 19:42:25 -04:00
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
2018-08-07 19:42:25 -04:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
2018-08-07 19:42:25 -04:00
2018-08-07 19:42:25 -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.nsx_policy.infra.tier_1s.locale_services package" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.html" />
<link rel="prev" title="com.vmware.nsx_policy.infra.tier_0s.nat package" href="com.vmware.nsx_policy.infra.tier_0s.nat.html" />
2018-08-07 19:42:25 -04:00
</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" >
2018-08-07 19:42:25 -04:00
<a href="index.html" class="icon icon-home"> NSX-T Policy SDK
</a>
<div class="version">
2.5.1.0.1
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.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>
2018-08-07 19:42:25 -04:00
</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 SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.nsx_policy.html">com.vmware.nsx_policy package</a> &raquo;</li>
<li><a href="com.vmware.nsx_policy.infra.html">com.vmware.nsx_policy.infra package</a> &raquo;</li>
<li>com.vmware.nsx_policy.infra.tier_1s package</li>
2018-08-07 19:42:25 -04:00
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.nsx_policy.infra.tier_1s.rst.txt" rel="nofollow"> View page source</a>
2018-08-07 19:42:25 -04:00
</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_1s">
<span id="com-vmware-nsx-policy-infra-tier-1s-package"></span><h1>com.vmware.nsx_policy.infra.tier_1s package<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.tier_1s" 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_1s.locale_services.html">com.vmware.nsx_policy.infra.tier_1s.locale_services package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.html">com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.sessions_client">com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.sessions_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client">com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client">com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client">com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.nat.html">com.vmware.nsx_policy.infra.tier_1s.nat package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.nat.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.nat.html#module-com.vmware.nsx_policy.infra.tier_1s.nat.nat_rules_client">com.vmware.nsx_policy.infra.tier_1s.nat.nat_rules_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.segments.html">com.vmware.nsx_policy.infra.tier_1s.segments package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.segments.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.tier_1s.segments.html#module-com.vmware.nsx_policy.infra.tier_1s.segments.ports_client">com.vmware.nsx_policy.infra.tier_1s.segments.ports_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
2018-08-07 19:42:25 -04:00
<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_1s.dns_forwarder_client">
<span id="com-vmware-nsx-policy-infra-tier-1s-dns-forwarder-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Nslookup">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.</code><code class="sig-name descname">Nslookup</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Nslookup" 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_1s.dns_forwarder_client.Nslookup.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">address=None</em>, <em class="sig-param">enforcement_point_path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Nslookup.get" title="Permalink to this definition"></a></dt>
<dd><p>Query the nameserver for an ip-address or a FQDN of the given an
address optionally using an specified DNS server. If the address is a
fqdn, nslookup will resolve ip-address with it. If the address is an
ip-address, do a reverse lookup and answer fqdn(s). If enforcement
point is specified, then DNS forwarder nslookup answer will get fetched
from specified enforcement point. Otherwise from all enforcement
points.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>address</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>) IP address or FQDN for nslookup (optional)</p></li>
<li><p><strong>enforcement_point_path</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>) String Path of the enforcement point (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.AggregatePolicyDnsAnswer" title="com.vmware.nsx_policy.model_client.AggregatePolicyDnsAnswer"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.AggregatePolicyDnsAnswer</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.AggregatePolicyDnsAnswer</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_1s.dns_forwarder_client.Statistics">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Statistics" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<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_1s.dns_forwarder_client.Statistics.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">enforcement_point_path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Statistics.get" title="Permalink to this definition"></a></dt>
<dd><p>Get statistics of tier-1 DNS forwarder. - no enforcement point path
specified: Statistics will be evaluated on each enforcement point. -
{enforcement_point_path}: Statistics are evaluated only on the given
enforcement point.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 id (required)</p></li>
<li><p><strong>enforcement_point_path</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>) String Path of the enforcement point (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.AggregateDNSForwarderStatistics" title="com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.AggregateDNSForwarderStatistics</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_1s.dns_forwarder_client.Status">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.</code><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<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_1s.dns_forwarder_client.Status.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">enforcement_point_path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Status.get" title="Permalink to this definition"></a></dt>
<dd><p>Get current status of tier-1 DNS forwarder. - no enforcement point path
specified: Status will be evaluated on each enforcement point. -
{enforcement_point_path}: Status will be evaluated only on the given
enforcement point.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 id (required)</p></li>
<li><p><strong>enforcement_point_path</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>) String Path of the enforcement point (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.AggregateDNSForwarderStatus" title="com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.AggregateDNSForwarderStatus</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_1s.dns_forwarder_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.tier_1s.locale_services_client">
<span id="com-vmware-nsx-policy-infra-tier-1s-locale-services-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_1s.locale_services_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.tier_1s.locale_services_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.locale_services_client.FloodProtectionProfileBindings">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.locale_services_client.</code><code class="sig-name descname">FloodProtectionProfileBindings</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.FloodProtectionProfileBindings" 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_1s.locale_services_client.FloodProtectionProfileBindings.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">flood_protection_profile_binding_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.FloodProtectionProfileBindings.delete" title="Permalink to this definition"></a></dt>
<dd><p>API will delete Flood Protection Profile Binding for Tier-1 Logical
Router LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>flood_protection_profile_binding_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_1s.locale_services_client.FloodProtectionProfileBindings.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">flood_protection_profile_binding_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.FloodProtectionProfileBindings.get" title="Permalink to this definition"></a></dt>
<dd><p>API will get Flood Protection Profile Binding Map for Tier-1 Logical
Router LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>flood_protection_profile_binding_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.FloodProtectionProfileBindingMap" title="com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.FloodProtectionProfileBindingMap</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_1s.locale_services_client.FloodProtectionProfileBindings.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">flood_protection_profile_binding_id</em>, <em class="sig-param">flood_protection_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.FloodProtectionProfileBindings.patch" title="Permalink to this definition"></a></dt>
<dd><p>API will create or update Flood Protection profile binding map for
Tier-1 Logical Router LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>flood_protection_profile_binding_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>flood_protection_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap" title="com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap</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_1s.locale_services_client.FloodProtectionProfileBindings.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">flood_protection_profile_binding_id</em>, <em class="sig-param">flood_protection_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.FloodProtectionProfileBindings.update" title="Permalink to this definition"></a></dt>
<dd><p>API will create or update Flood Protection profile binding map for
Tier-1 Logical Router LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>flood_protection_profile_binding_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>flood_protection_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap" title="com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap</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.FloodProtectionProfileBindingMap" title="com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.FloodProtectionProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.FloodProtectionProfileBindingMap</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_1s.locale_services_client.GatewayFirewall">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.locale_services_client.</code><code class="sig-name descname">GatewayFirewall</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.GatewayFirewall" 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_1s.locale_services_client.GatewayFirewall.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.GatewayFirewall.list" title="Permalink to this definition"></a></dt>
<dd><p>Get filtered view of Gateway Firewall rules associated with the Tier-1
Locale Services. The gateway policies are returned in the order of
category and sequence number.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_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.GatewayPolicyListResult" title="com.vmware.nsx_policy.model_client.GatewayPolicyListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.GatewayPolicyListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.GatewayPolicyListResult</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_1s.locale_services_client.Interfaces">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.locale_services_client.</code><code class="sig-name descname">Interfaces</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces" 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_1s.locale_services_client.Interfaces.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">interface_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete Tier-1 interface</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>interface_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_1s.locale_services_client.Interfaces.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">interface_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.get" title="Permalink to this definition"></a></dt>
<dd><p>Read Tier-1 interface</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>interface_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.Tier1Interface" title="com.vmware.nsx_policy.model_client.Tier1Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Tier1Interface</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Tier1Interface</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_1s.locale_services_client.Interfaces.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.list" title="Permalink to this definition"></a></dt>
<dd><p>Paginated list of all Tier-1 interfaces</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_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>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.Tier1InterfaceListResult" title="com.vmware.nsx_policy.model_client.Tier1InterfaceListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Tier1InterfaceListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Tier1InterfaceListResult</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_1s.locale_services_client.Interfaces.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">interface_id</em>, <em class="sig-param">tier1_interface</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.patch" title="Permalink to this definition"></a></dt>
<dd><p>If an interface with the interface-id is not already present, create a
new interface. If it already exists, update the interface for specified
attributes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>tier1_interface</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier1Interface" title="com.vmware.nsx_policy.model_client.Tier1Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Tier1Interface</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_1s.locale_services_client.Interfaces.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">interface_id</em>, <em class="sig-param">tier1_interface</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.update" title="Permalink to this definition"></a></dt>
<dd><p>If an interface with the interface-id is not already present, create a
new interface. If it already exists, replace the interface 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>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>interface_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>tier1_interface</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier1Interface" title="com.vmware.nsx_policy.model_client.Tier1Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Tier1Interface</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.Tier1Interface" title="com.vmware.nsx_policy.model_client.Tier1Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Tier1Interface</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Tier1Interface</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_1s.locale_services_client.IpsecVpnServices">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.locale_services_client.</code><code class="sig-name descname">IpsecVpnServices</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.IpsecVpnServices" 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_1s.locale_services_client.IpsecVpnServices.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.IpsecVpnServices.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete IPSec VPN service for a given locale service under Tier-1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_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>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">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_1s.locale_services_client.IpsecVpnServices.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.IpsecVpnServices.get" title="Permalink to this definition"></a></dt>
<dd><p>Get IPSec VPN service for a given locale service under Tier-1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_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>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.IPSecVpnService" title="com.vmware.nsx_policy.model_client.IPSecVpnService"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.IPSecVpnService</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.IPSecVpnService</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_1s.locale_services_client.IpsecVpnServices.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.IpsecVpnServices.list" title="Permalink to this definition"></a></dt>
<dd><p>Get paginated list of all IPSec VPN services for a given locale service
under Tier-1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_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>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.IPSecVpnServiceListResult" title="com.vmware.nsx_policy.model_client.IPSecVpnServiceListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.IPSecVpnServiceListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.IPSecVpnServiceListResult</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_1s.locale_services_client.IpsecVpnServices.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_id</em>, <em class="sig-param">ip_sec_vpn_service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.IpsecVpnServices.patch" title="Permalink to this definition"></a></dt>
<dd><p>Create or patch IPSec VPN service for a given locale service under
Tier-1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_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>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>ip_sec_vpn_service</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnService" title="com.vmware.nsx_policy.model_client.IPSecVpnService"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.IPSecVpnService</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_1s.locale_services_client.IpsecVpnServices.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_id</em>, <em class="sig-param">ip_sec_vpn_service</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.IpsecVpnServices.update" title="Permalink to this definition"></a></dt>
<dd><p>Create or fully replace IPSec VPN service for a given locale service
under Tier-1. Revision is optional for creation and required for
update.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_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>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>ip_sec_vpn_service</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnService" title="com.vmware.nsx_policy.model_client.IPSecVpnService"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.IPSecVpnService</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.IPSecVpnService" title="com.vmware.nsx_policy.model_client.IPSecVpnService"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.IPSecVpnService</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.IPSecVpnService</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_1s.locale_services_client.ServiceInstances">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.locale_services_client.</code><code class="sig-name descname">ServiceInstances</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances" 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_1s.locale_services_client.ServiceInstances.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete Tier1 policy service instance</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-0 id (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>) Locale service id (required)</p></li>
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier1 Service instance id (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_1s.locale_services_client.ServiceInstances.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_instance_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.get" title="Permalink to this definition"></a></dt>
<dd><p>Read Tier1 service instance</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 id (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>) Locale service id (required)</p></li>
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Service instance id (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.PolicyServiceInstance" title="com.vmware.nsx_policy.model_client.PolicyServiceInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyServiceInstance</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PolicyServiceInstance</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_1s.locale_services_client.ServiceInstances.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.list" title="Permalink to this definition"></a></dt>
<dd><p>Read all service instance objects under a tier-1</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 id (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>) Locale service id (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>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.PolicyServiceInstanceListResult" title="com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PolicyServiceInstanceListResult</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_1s.locale_services_client.ServiceInstances.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_instance_id</em>, <em class="sig-param">policy_service_instance</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.patch" title="Permalink to this definition"></a></dt>
<dd><p>Create Tier1 Service Instance. Please note that, only display_name,
description and deployment_spec_name are allowed to be modified in an
exisiting entity. If the deployment spec name is changed, it will
trigger the upgrade operation for the SVMs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 id (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>) Locale service id (required)</p></li>
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier1 Service instance id (required)</p></li>
<li><p><strong>policy_service_instance</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyServiceInstance" title="com.vmware.nsx_policy.model_client.PolicyServiceInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyServiceInstance</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_1s.locale_services_client.ServiceInstances.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_service_id</em>, <em class="sig-param">service_instance_id</em>, <em class="sig-param">policy_service_instance</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.update" title="Permalink to this definition"></a></dt>
<dd><p>Create Tier1 service instance. Please note that, only display_name,
description and deployment_spec_name are allowed to be modified in an
exisiting entity. If the deployment spec name is changed, it will
trigger the upgrade operation for the SVMs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 id (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>) Locale service id (required)</p></li>
<li><p><strong>service_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier1 Service instance id (required)</p></li>
<li><p><strong>policy_service_instance</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyServiceInstance" title="com.vmware.nsx_policy.model_client.PolicyServiceInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyServiceInstance</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.PolicyServiceInstance" title="com.vmware.nsx_policy.model_client.PolicyServiceInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyServiceInstance</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PolicyServiceInstance</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_1s.locale_services_client.SessionTimerProfileBindings">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.locale_services_client.</code><code class="sig-name descname">SessionTimerProfileBindings</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.SessionTimerProfileBindings" 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_1s.locale_services_client.SessionTimerProfileBindings.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">session_timer_profile_binding_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.SessionTimerProfileBindings.delete" title="Permalink to this definition"></a></dt>
<dd><p>API will delete Session Timer Profile Binding for Tier-1 Logical Router
LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>session_timer_profile_binding_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_1s.locale_services_client.SessionTimerProfileBindings.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">session_timer_profile_binding_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.SessionTimerProfileBindings.get" title="Permalink to this definition"></a></dt>
<dd><p>API will get Session Timer Profile Binding Map for Tier-1 Logical
Router LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>session_timer_profile_binding_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.SessionTimerProfileBindingMap" title="com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SessionTimerProfileBindingMap</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_1s.locale_services_client.SessionTimerProfileBindings.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">session_timer_profile_binding_id</em>, <em class="sig-param">session_timer_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.SessionTimerProfileBindings.patch" title="Permalink to this definition"></a></dt>
<dd><p>API will create or update Session Timer profile binding map for Tier-1
Logical Router LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>session_timer_profile_binding_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>session_timer_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap" title="com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap</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_1s.locale_services_client.SessionTimerProfileBindings.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">locale_services_id</em>, <em class="sig-param">session_timer_profile_binding_id</em>, <em class="sig-param">session_timer_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.SessionTimerProfileBindings.update" title="Permalink to this definition"></a></dt>
<dd><p>API will create or update Session Timer profile binding map for Tier-1
Logical Router LocaleServices.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>locale_services_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>session_timer_profile_binding_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>session_timer_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap" title="com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap</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.SessionTimerProfileBindingMap" title="com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SessionTimerProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SessionTimerProfileBindingMap</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_1s.locale_services_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.locale_services_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.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 class="section" id="module-com.vmware.nsx_policy.infra.tier_1s.nat_client">
<span id="com-vmware-nsx-policy-infra-tier-1s-nat-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_1s.nat_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.tier_1s.nat_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.nat_client.</code><code class="sig-name descname">NatRules</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules" 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_1s.nat_client.NatRules.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">nat_id</em>, <em class="sig-param">nat_rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by &lt;nat-id&gt;. Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>nat_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) NAT id (required)</p></li>
<li><p><strong>nat_rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Rule ID (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_1s.nat_client.NatRules.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">nat_id</em>, <em class="sig-param">nat_rule_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.get" title="Permalink to this definition"></a></dt>
<dd><p>Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by &lt;nat-id&gt;. Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>nat_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) NAT id (required)</p></li>
<li><p><strong>nat_rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Rule ID (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.PolicyNatRule" title="com.vmware.nsx_policy.model_client.PolicyNatRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyNatRule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PolicyNatRule</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_1s.nat_client.NatRules.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">nat_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.list" title="Permalink to this definition"></a></dt>
<dd><p>List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by &lt;nat-id&gt;. Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>nat_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) NAT id (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>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.PolicyNatRuleListResult" title="com.vmware.nsx_policy.model_client.PolicyNatRuleListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyNatRuleListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PolicyNatRuleListResult</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_1s.nat_client.NatRules.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">nat_id</em>, <em class="sig-param">nat_rule_id</em>, <em class="sig-param">policy_nat_rule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.patch" title="Permalink to this definition"></a></dt>
<dd><p>If a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID,
under NAT section denoted by &lt;nat-id&gt;, create a new NAT Rule. If it
already exists, update the NAT Rule. Under tier-1 there will be 3
different NATs(sections). (INTERNAL, USER and DEFAULT) For more details
related to NAT section please refer to PolicyNAT schema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>nat_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) NAT id (required)</p></li>
<li><p><strong>nat_rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Rule ID (required)</p></li>
<li><p><strong>policy_nat_rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyNatRule" title="com.vmware.nsx_policy.model_client.PolicyNatRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyNatRule</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_1s.nat_client.NatRules.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">nat_id</em>, <em class="sig-param">nat_rule_id</em>, <em class="sig-param">policy_nat_rule</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.update" title="Permalink to this definition"></a></dt>
<dd><p>Update NAT Rule on Tier-1 denoted by Tier-1 ID, under NAT section
denoted by &lt;nat-id&gt;. Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>nat_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) NAT id (required)</p></li>
<li><p><strong>nat_rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Rule ID (required)</p></li>
<li><p><strong>policy_nat_rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyNatRule" title="com.vmware.nsx_policy.model_client.PolicyNatRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyNatRule</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.PolicyNatRule" title="com.vmware.nsx_policy.model_client.PolicyNatRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyNatRule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PolicyNatRule</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_1s.nat_client.Statistics">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.nat_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.Statistics" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<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_1s.nat_client.Statistics.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">enforcement_point_path=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.Statistics.list" title="Permalink to this definition"></a></dt>
<dd><p>List NAT Rules Statistics from Tier-1 denoted by Tier-1 ID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (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>enforcement_point_path</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>) String Path of the enforcement point (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.PolicyNatRuleStatisticsPerLogicalRouterListResult" title="com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerLogicalRouterListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerLogicalRouterListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PolicyNatRuleStatisticsPerLogicalRouterListResult</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_1s.nat_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.nat_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.nat_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.tier_1s.segments_client">
<span id="com-vmware-nsx-policy-infra-tier-1s-segments-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_1s.segments_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.tier_1s.segments_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">Ports</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports" 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_1s.segments_client.Ports.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">port_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a Tier-1 segment port by giving ID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>port_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_1s.segments_client.Ports.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">port_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.get" title="Permalink to this definition"></a></dt>
<dd><p>Get detail information on a Tier-1 segment port by giving ID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>port_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.SegmentPort" title="com.vmware.nsx_policy.model_client.SegmentPort"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentPort</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentPort</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_1s.segments_client.Ports.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.list" title="Permalink to this definition"></a></dt>
<dd><p>List all the ports for a Tier-1 segment.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_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>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.SegmentPortListResult" title="com.vmware.nsx_policy.model_client.SegmentPortListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentPortListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentPortListResult</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_1s.segments_client.Ports.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">port_id</em>, <em class="sig-param">segment_port</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.patch" title="Permalink to this definition"></a></dt>
<dd><p>Create a Tier-1 segment port if it does not exist based on the IDs, or
update existing port information by replacing the port object fields
which presents in the request body.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_port</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentPort" title="com.vmware.nsx_policy.model_client.SegmentPort"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentPort</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_1s.segments_client.Ports.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">port_id</em>, <em class="sig-param">segment_port</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.update" title="Permalink to this definition"></a></dt>
<dd><p>Create a Tier-1 segment port if it does not exist based on the IDs, or
update existing port information by replacing the port object already
exists.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>port_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_port</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentPort" title="com.vmware.nsx_policy.model_client.SegmentPort"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentPort</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.SegmentPort" title="com.vmware.nsx_policy.model_client.SegmentPort"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentPort</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentPort</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_1s.segments_client.SegmentDiscoveryProfileBindingMaps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">SegmentDiscoveryProfileBindingMaps</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentDiscoveryProfileBindingMaps" 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_1s.segments_client.SegmentDiscoveryProfileBindingMaps.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_discovery_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentDiscoveryProfileBindingMaps.delete" title="Permalink to this definition"></a></dt>
<dd><p>API will delete Segment Discovery Profile Binding Profile</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_discovery_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Discovery Profile Binding Map ID (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_1s.segments_client.SegmentDiscoveryProfileBindingMaps.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_discovery_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentDiscoveryProfileBindingMaps.get" title="Permalink to this definition"></a></dt>
<dd><p>API will get Segment Discovery Profile Binding Map</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_discovery_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Discovery Profile Binding Map ID (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.SegmentDiscoveryProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentDiscoveryProfileBindingMap</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_1s.segments_client.SegmentDiscoveryProfileBindingMaps.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentDiscoveryProfileBindingMaps.list" title="Permalink to this definition"></a></dt>
<dd><p>API will list all Segment Discovery Profile Binding Maps in current
segment id.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_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>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.SegmentDiscoveryProfileBindingMapListResult" title="com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMapListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMapListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentDiscoveryProfileBindingMapListResult</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_1s.segments_client.SegmentDiscoveryProfileBindingMaps.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_discovery_profile_binding_map_id</em>, <em class="sig-param">segment_discovery_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentDiscoveryProfileBindingMaps.patch" title="Permalink to this definition"></a></dt>
<dd><p>API will create Segment Discovery Profile Binding Map</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_discovery_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Discovery Profile Binding Map ID (required)</p></li>
<li><p><strong>segment_discovery_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap</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_1s.segments_client.SegmentDiscoveryProfileBindingMaps.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_discovery_profile_binding_map_id</em>, <em class="sig-param">segment_discovery_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentDiscoveryProfileBindingMaps.update" title="Permalink to this definition"></a></dt>
<dd><p>API will update Segment Discovery Profile Binding Map</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_discovery_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Discovery Profile Binding Map ID (required)</p></li>
<li><p><strong>segment_discovery_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap</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.SegmentDiscoveryProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentDiscoveryProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentDiscoveryProfileBindingMap</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_1s.segments_client.SegmentMonitoringProfileBindingMaps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">SegmentMonitoringProfileBindingMaps</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps" 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_1s.segments_client.SegmentMonitoringProfileBindingMaps.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_monitoring_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.delete" title="Permalink to this definition"></a></dt>
<dd><p>API will delete Segment Monitoring Profile Binding Profile.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Monitoring Profile Binding Map ID (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_1s.segments_client.SegmentMonitoringProfileBindingMaps.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_monitoring_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.get" title="Permalink to this definition"></a></dt>
<dd><p>API will get Segment Monitoring Profile Binding Map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Monitoring Profile Binding Map ID (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.SegmentMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMap</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_1s.segments_client.SegmentMonitoringProfileBindingMaps.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.list" title="Permalink to this definition"></a></dt>
<dd><p>API will list all Segment Monitoring Profile Binding Maps in current
segment id.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_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>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.SegmentMonitoringProfileBindingMapListResult" title="com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMapListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMapListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMapListResult</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_1s.segments_client.SegmentMonitoringProfileBindingMaps.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_monitoring_profile_binding_map_id</em>, <em class="sig-param">segment_monitoring_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.patch" title="Permalink to this definition"></a></dt>
<dd><p>API will create segment monitoring profile binding map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Monitoring Profile Binding Map ID (required)</p></li>
<li><p><strong>segment_monitoring_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap</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_1s.segments_client.SegmentMonitoringProfileBindingMaps.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_monitoring_profile_binding_map_id</em>, <em class="sig-param">segment_monitoring_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.update" title="Permalink to this definition"></a></dt>
<dd><p>API will update Segment Monitoring Profile Binding Map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_monitoring_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment Monitoring Profile Binding Map ID (required)</p></li>
<li><p><strong>segment_monitoring_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap</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.SegmentMonitoringProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMap</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_1s.segments_client.SegmentQosProfileBindingMaps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">SegmentQosProfileBindingMaps</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentQosProfileBindingMaps" 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_1s.segments_client.SegmentQosProfileBindingMaps.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_qos_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentQosProfileBindingMaps.delete" title="Permalink to this definition"></a></dt>
<dd><p>API will delete Segment QoS Profile Binding Profile.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_qos_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment QoS Profile Binding Map ID (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_1s.segments_client.SegmentQosProfileBindingMaps.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_qos_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentQosProfileBindingMaps.get" title="Permalink to this definition"></a></dt>
<dd><p>API will get Segment QoS Profile Binding Map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_qos_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment QoS Profile Binding Map ID (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.SegmentQosProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentQoSProfileBindingMap</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_1s.segments_client.SegmentQosProfileBindingMaps.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentQosProfileBindingMaps.list" title="Permalink to this definition"></a></dt>
<dd><p>API will list all Segment QoS Profile Binding Maps in current segment
id.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_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>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.SegmentQosProfileBindingMapListResult" title="com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMapListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMapListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentQoSProfileBindingMapListResult</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_1s.segments_client.SegmentQosProfileBindingMaps.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_qos_profile_binding_map_id</em>, <em class="sig-param">segment_qos_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentQosProfileBindingMaps.patch" title="Permalink to this definition"></a></dt>
<dd><p>API will create segment QoS profile binding map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_qos_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment QoS Profile Binding Map ID (required)</p></li>
<li><p><strong>segment_qos_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap</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_1s.segments_client.SegmentQosProfileBindingMaps.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_qos_profile_binding_map_id</em>, <em class="sig-param">segment_qos_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentQosProfileBindingMaps.update" title="Permalink to this definition"></a></dt>
<dd><p>API will update Segment QoS Profile Binding Map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Tier-1 ID (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment ID (required)</p></li>
<li><p><strong>segment_qos_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Segment QoS Profile Binding Map ID (required)</p></li>
<li><p><strong>segment_qos_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap</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.SegmentQosProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentQosProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentQoSProfileBindingMap</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>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">SegmentSecurityProfileBindingMaps</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps" 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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_security_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.delete" title="Permalink to this definition"></a></dt>
<dd><p>API will delete segment security profile binding map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) tier-1 gateway id (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment id (required)</p></li>
<li><p><strong>segment_security_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment security profile binding map id (required)</p></li>
2018-08-07 19:42:25 -04:00
</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_security_profile_binding_map_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.get" title="Permalink to this definition"></a></dt>
<dd><p>API will return details of the segment security profile binding map. If
the binding map does not exist, it will return 404.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) tier-1 gateway id (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment id (required)</p></li>
<li><p><strong>segment_security_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment security profile binding map id (required)</p></li>
2018-08-07 19:42:25 -04:00
</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.SegmentSecurityProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentSecurityProfileBindingMap</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.list" title="Permalink to this definition"></a></dt>
<dd><p>API will list all segment security profile binding maps.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) tier-1 gateway id (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment id (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>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>
2018-08-07 19:42:25 -04:00
</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.SegmentSecurityProfileBindingMapListResult" title="com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMapListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMapListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentSecurityProfileBindingMapListResult</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_security_profile_binding_map_id</em>, <em class="sig-param">segment_security_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.patch" title="Permalink to this definition"></a></dt>
<dd><p>Create a new segment security profile binding map if the given security
profile binding map does not exist. Otherwise, patch the existing
segment security profile binding map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) tier-1 gateway id (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment id (required)</p></li>
<li><p><strong>segment_security_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment security profile binding map id (required)</p></li>
<li><p><strong>segment_security_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">segment_security_profile_binding_map_id</em>, <em class="sig-param">segment_security_profile_binding_map</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentSecurityProfileBindingMaps.update" title="Permalink to this definition"></a></dt>
<dd><p>API will create or replace segment security profile binding map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) tier-1 gateway id (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment id (required)</p></li>
<li><p><strong>segment_security_profile_binding_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) segment security profile binding map id (required)</p></li>
<li><p><strong>segment_security_profile_binding_map</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</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.SegmentSecurityProfileBindingMap" title="com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentSecurityProfileBindingMap</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentSecurityProfileBindingMap</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">StaticArp</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp" 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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Configuration to be used for creating the stub.</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.delete" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Delete static ARP config</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.get" title="Permalink to this definition"></a></dt>
2018-08-07 19:42:25 -04:00
<dd><p>Read static ARP config</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</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.StaticARPConfig" title="com.vmware.nsx_policy.model_client.StaticARPConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.StaticARPConfig</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.StaticARPConfig</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">static_arp_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.patch" title="Permalink to this definition"></a></dt>
<dd><p>Create static ARP config with Tier-1 and segment IDs provided if it
2018-08-07 19:42:25 -04:00
doesnt exist, update with provided config if its already created.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>static_arp_config</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticARPConfig" title="com.vmware.nsx_policy.model_client.StaticARPConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.StaticARPConfig</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segment_id</em>, <em class="sig-param">static_arp_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.update" title="Permalink to this definition"></a></dt>
<dd><p>Create static ARP config with Tier-1 and segment IDs provided if it
2018-08-07 19:42:25 -04:00
doesnt exist, update with provided config if its already created.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segment_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>static_arp_config</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticARPConfig" title="com.vmware.nsx_policy.model_client.StaticARPConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.StaticARPConfig</span></code></a>) (required)</p></li>
2018-08-07 19:42:25 -04:00
</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.StaticARPConfig" title="com.vmware.nsx_policy.model_client.StaticARPConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.StaticARPConfig</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.StaticARPConfig</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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
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>
2018-08-07 19:42:25 -04:00
Not Found</p>
</dd>
</dl>
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.Statistics">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Statistics" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<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_1s.segments_client.Statistics.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">tier1_id</em>, <em class="sig-param">segments_id</em>, <em class="sig-param">cursor=None</em>, <em class="sig-param">edge_path=None</em>, <em class="sig-param">enforcement_point_path=None</em>, <em class="sig-param">include_mark_for_delete_objects=None</em>, <em class="sig-param">included_fields=None</em>, <em class="sig-param">page_size=None</em>, <em class="sig-param">sort_ascending=None</em>, <em class="sig-param">sort_by=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_client.Statistics.get" title="Permalink to this definition"></a></dt>
<dd><p>Get tier1 segment statistics information.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tier1_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) (required)</p></li>
<li><p><strong>segments_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>edge_path</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>) Policy path of edge node (optional)</p></li>
<li><p><strong>enforcement_point_path</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>) String Path of the enforcement point (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</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>) Include objects that are marked for deletion in results (optional,
default to false)</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>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.SegmentStatistics" title="com.vmware.nsx_policy.model_client.SegmentStatistics"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.SegmentStatistics</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SegmentStatistics</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>
2018-08-07 19:42:25 -04:00
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.tier_1s.segments_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_1s.segments_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.tier_1s.segments_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>
<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.nsx_policy.infra.tier_1s.locale_services.html" class="btn btn-neutral float-right" title="com.vmware.nsx_policy.infra.tier_1s.locale_services package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
2018-08-07 19:42:25 -04:00
<a href="com.vmware.nsx_policy.infra.tier_0s.nat.html" class="btn btn-neutral float-left" title="com.vmware.nsx_policy.infra.tier_0s.nat 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);
2018-08-07 19:42:25 -04:00
});
</script>
2018-08-07 19:42:25 -04:00
</body>
</html>