<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-package"></span><h1>com.vmware.nsx_policy.infra.tier_0s.locale_services package<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-bgp-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.</code><codeclass="sig-name descname">Neighbors</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors"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="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">neighbor_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">neighbor_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.get"title="Permalink to this definition">¶</a></dt>
<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
<li><p><strong>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
<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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">neighbor_id</em>, <emclass="sig-param">bgp_neighbor_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.patch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">neighbor_id</em>, <emclass="sig-param">bgp_neighbor_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-byod-service-instances-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.</code><codeclass="sig-name descname">ServiceInstanceEndpoints</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints"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="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_instance_id</em>, <emclass="sig-param">service_instance_endpoint_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete policy service instance endpoint</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_instance_id</em>, <emclass="sig-param">service_instance_endpoint_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.get"title="Permalink to this definition">¶</a></dt>
<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
<li><p><strong>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
<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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_instance_id</em>, <emclass="sig-param">service_instance_endpoint_id</em>, <emclass="sig-param">service_instance_endpoint</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.patch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_instance_id</em>, <emclass="sig-param">service_instance_endpoint_id</em>, <emclass="sig-param">service_instance_endpoint</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Create service instance endpoint with given request if not exist.
Modification of service instance endpoint is not allowed.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-endpoints-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.</code><codeclass="sig-name descname">VirtualEndpoints</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints"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="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">virtual_endpoint_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">virtual_endpoint_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Read virtual endpoint with given id under given Tier0.</p>
<li><p><strong>locale_service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Locale service id (required)</p></li>
<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>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">virtual_endpoint_id</em>, <emclass="sig-param">virtual_endpoint</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.patch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">virtual_endpoint_id</em>, <emclass="sig-param">virtual_endpoint</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.update"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-interfaces-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client.</code><codeclass="sig-name descname">Statistics</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client.Statistics"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>
<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>edge_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Policy path of edge node (optional)</p></li>
<li><p><strong>enforcement_point_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-ipsec-vpn-services-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.</code><codeclass="sig-name descname">LocalEndpoints</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.LocalEndpoints"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="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">local_endpoint_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.LocalEndpoints.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete IPSec VPN local endpoint for a given locale service under
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">local_endpoint_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.LocalEndpoints.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get IPSec VPN local endpoint for a given locale service under Tier-0.</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>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">local_endpoint_id</em>, <emclass="sig-param">ip_sec_vpn_local_endpoint</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.LocalEndpoints.patch"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or patch a custom IPSec VPN local endpoint for a given locale
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">local_endpoint_id</em>, <emclass="sig-param">ip_sec_vpn_local_endpoint</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.LocalEndpoints.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or fully replace IPSec VPN local endpoint for a given locale
service under Tier-0. Revision is optional for creation and required
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.</code><codeclass="sig-name descname">Sessions</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.Sessions"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="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.Sessions.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete IPSec VPN session for a given locale service under Tier-0.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.Sessions.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get IPSec VPN session without sensitive data for a given locale service
<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>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em>, <emclass="sig-param">ip_sec_vpn_session</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.Sessions.patch"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or patch an IPSec VPN session for a given locale service under
<codeclass="sig-name descname">showsensitivedata</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.Sessions.showsensitivedata"title="Permalink to this definition">¶</a></dt>
<dd><p>Get IPSec VPN session with senstive data for a given locale service
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em>, <emclass="sig-param">ip_sec_vpn_session</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.Sessions.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or fully replace IPSec VPN session for a given locale service
under Tier-0. Revision is optional for creation and required for
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-l2vpn-context-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.</code><codeclass="sig-name descname">L2vpns</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns"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="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">l2vpn_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">l2vpn_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.get"title="Permalink to this definition">¶</a></dt>
<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>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">l2vpn_id</em>, <emclass="sig-param">l2_vpn</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.patch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">l2vpn_id</em>, <emclass="sig-param">l2_vpn</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.update"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-l2vpn-services-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.</code><codeclass="sig-name descname">Sessions</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.Sessions"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="sig-name descname">createwithpeercode</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em>, <emclass="sig-param">l2_vpn_session_data</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.Sessions.createwithpeercode"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or patch an L2VPN session from Peer Codes. In addition to the
L2VPN Session, the IPSec VPN Session, along with the IKE, Tunnel, and
DPD Profiles are created and owned by the system. IPSec VPN Service and
Local Endpoint are created only when required, i.e., an IPSec VPN
Service does not already exist, or an IPSec VPN Local Endpoint with
same local address does not already exist. Updating the L2VPN Session
can be performed only through this API by specifying new peer codes.
Use of specific APIs to update the L2VPN Session and the different
resources associated with it is not allowed, except for IPSec VPN
Service and Local Endpoint, resources that are not system owned. API
supported only when L2VPN Service is in Client Mode.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.Sessions.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete L2VPN session. When L2VPN Service is in CLIENT Mode, the L2VPN
Session is deleted along with its transpot tunnels and related
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.Sessions.get"title="Permalink to this definition">¶</a></dt>
<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>include_mark_for_delete_objects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em>, <emclass="sig-param">l2_vpn_session</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.Sessions.patch"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or patch an L2VPN session. API supported only when L2VPN Service
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_id</em>, <emclass="sig-param">session_id</em>, <emclass="sig-param">l2_vpn_session</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.Sessions.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or fully replace L2VPN session. API supported only when L2VPN
Service is in Server Mode. Revision is optional for creation and
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-l3vpns-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.</code><codeclass="sig-name descname">Statistics</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.Statistics"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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">l3vpn_id</em>, <emclass="sig-param">enforcement_point_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.Statistics.get"title="Permalink to this definition">¶</a></dt>
<li><p><strong>enforcement_point_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-nsx-policy-infra-tier-0s-locale-services-service-instances-client-module"></span><h2>com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client.</code><codeclass="sig-name descname">Statistics</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client.Statistics"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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">tier0_id</em>, <emclass="sig-param">locale_service_id</em>, <emclass="sig-param">service_instance_id</em>, <emclass="sig-param">enforcement_point_path=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client.Statistics.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get statistics for all data NICs on all runtimes associated with this
<li><p><strong>locale_service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Locale service id (required)</p></li>
<li><p><strong>service_instance_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Service instance id (required)</p></li>
<li><p><strong>enforcement_point_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_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>.
