<spanid="com-vmware-nsx-logical-routers-routing-bgp-package"></span><h1>com.vmware.nsx.logical_routers.routing.bgp package<aclass="headerlink"href="#module-com.vmware.nsx.logical_routers.routing.bgp"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-nsx-logical-routers-routing-bgp-neighbors-client-module"></span><h2>com.vmware.nsx.logical_routers.routing.bgp.neighbors_client module<aclass="headerlink"href="#module-com.vmware.nsx.logical_routers.routing.bgp.neighbors_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><codeclass="descname">AdvertisedRoutes</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.AdvertisedRoutes"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>logical_router_id</em>, <em>neighbor_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.AdvertisedRoutes.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns routes advertised by BGP neighbor from all edge transport nodes
on which this neighbor is currently enabled. It always returns realtime
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><codeclass="descname">Routes</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Routes"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>logical_router_id</em>, <em>neighbor_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Routes.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns routes learned by BGP neighbor from all edge transport nodes on
which this neighbor is currently enabled. It always returns realtime
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="descname">LIST_SOURCE_CACHED</code><emclass="property"> = 'cached'</em><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.LIST_SOURCE_CACHED"title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <codeclass="docutils literal notranslate"><spanclass="pre">source</span></code> of method <aclass="reference internal"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list"title="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Status.list()</span></code></a>.</p>
<codeclass="descname">LIST_SOURCE_REALTIME</code><emclass="property"> = 'realtime'</em><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.LIST_SOURCE_REALTIME"title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <codeclass="docutils literal notranslate"><spanclass="pre">source</span></code> of method <aclass="reference internal"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list"title="com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.Status.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Status.list()</span></code></a>.</p>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of results to return in this page (server may return
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
<li><p><strong>source</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Data source type. (optional)</p></li>
<li><p><strong>transport_node_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Transport node id (optional)</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx.logical_routers.routing.bgp.neighbors_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.