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" >
2019-01-25 18:19:42 -05:00
< title > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package — NSX-T Policy SDK 2.3.0.0.2 documentation< / title >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -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" / >
2018-11-01 14:01:54 -04:00
< link rel = "next" title = "com.vmware.nsx_policy.infra.tier_1s package" href = "com.vmware.nsx_policy.infra.tier_1s.html" / >
< link rel = "prev" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services package" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html" / >
2018-08-07 19:42:25 -04:00
< script src = "_static/js/modernizr.min.js" > < / script >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "index.html" class = "icon icon-home" > NSX-T Policy SDK
< / a >
< div class = "version" >
2019-01-25 18:19:42 -05:00
2.3.0.0.2
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 >
2018-11-01 14:01:54 -04:00
< 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 > » < / li >
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.html" > com.vmware.nsx_policy.infra package< / a > » < / li >
2018-11-01 14:01:54 -04:00
< li > < a href = "com.vmware.nsx_policy.infra.tier_0s.html" > com.vmware.nsx_policy.infra.tier_0s package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html" > com.vmware.nsx_policy.infra.tier_0s.locale_services package< / a > » < / li >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< li > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package< / li >
2018-08-07 19:42:25 -04:00
< li class = "wy-breadcrumbs-aside" >
2018-11-01 14:01:54 -04:00
< a href = "_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.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" >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-l2vpn-context-package" > < / span > < h1 > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context" title = "Permalink to this headline" > ¶< / a > < / h1 >
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 >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-l2vpn-context-l2vpns-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.PeerConfig" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.< / code > < code class = "descname" > PeerConfig< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.PeerConfig" 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 >
2018-11-01 14:01:54 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.PeerConfig.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l2vpn_id< / em > , < em > enforcement_point_path=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.PeerConfig.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Get peer config for the L2Vpn to configure the remote side of the
tunnel. - no enforcement point path specified: L2Vpn Peer Codes will be
evaluated on each enforcement point. - {enforcement_point_path}: L2Vpn
Peer Codes are evaluated only on the given enforcement point.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< li > < 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 > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.AggregateL2VpnPeerConfig" title = "com.vmware.nsx_policy.model_client.AggregateL2VpnPeerConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.AggregateL2VpnPeerConfig< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.AggregateL2VpnPeerConfig< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < 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 >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < 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 >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.Statistics" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.< / code > < code class = "descname" > Statistics< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.Statistics.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l2vpn_id< / em > , < em > enforcement_point_path=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Get statistics of an L2Vpn. - no enforcement point path specified:
Stats will be evaluated on each enforcement point. -
{enforcement_point_path}: Stats are evaluated only on the given
enforcement point.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< li > < 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 > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.AggregateL2VpnStatistics" title = "com.vmware.nsx_policy.model_client.AggregateL2VpnStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.AggregateL2VpnStatistics< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.AggregateL2VpnStatistics< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < 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 >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < 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 >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_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 >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
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" >
2018-11-01 14:01:54 -04:00
< a href = "com.vmware.nsx_policy.infra.tier_1s.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.infra.tier_1s package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< a href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html" class = "btn btn-neutral" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services 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 >
2018-11-01 14:01:54 -04:00
© Copyright 2018, 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 >
2018-11-01 14:01:54 -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 >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
2018-08-07 19:42:25 -04:00
< script type = "text/javascript" >
jQuery(function () {
2018-11-01 14:01:54 -04:00
SphinxRtdTheme.Navigation.enable(true);
2018-08-07 19:42:25 -04:00
});
< / script >
< / body >
< / html >
