2020-01-27 14:28:46 -05:00
<!DOCTYPE html>
2021-03-31 18:40:01 -04:00
< html class = "writer-html4" lang = "en" >
2020-01-27 14:28:46 -05:00
< head >
2021-03-31 18:40:01 -04:00
< meta charset = "utf-8" / >
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
< title > com.vmware.nsx_policy.infra.tier_1s.locale_services package — NSX-T Policy SDK 3.0.3.0.0 documentation< / title >
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2020-01-27 14:28:46 -05:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
2021-03-31 18:40:01 -04:00
< 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 >
2020-01-27 14:28:46 -05:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2020-09-21 16:47:14 -04:00
< link rel = "next" title = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces package" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces.html" / >
2020-01-27 14:28:46 -05:00
< link rel = "prev" title = "com.vmware.nsx_policy.infra.tier_1s package" href = "com.vmware.nsx_policy.infra.tier_1s.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2021-03-31 18:40:01 -04:00
< a href = "index.html" class = "icon icon-home" > NSX-T Policy SDK
2020-01-27 14:28:46 -05:00
< / a >
< div class = "version" >
2021-03-31 18:40:01 -04:00
3.0.3.0.0
2020-01-27 14:28:46 -05: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 >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
< 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 >
2020-06-05 18:48:31 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module" > com.vmware.nsx_policy_client_for_vmc module< / a > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
< / 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" >
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
2020-09-21 16:47:14 -04:00
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
2020-01-27 14:28:46 -05:00
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.html" > com.vmware.nsx_policy.infra package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.tier_1s.html" > com.vmware.nsx_policy.infra.tier_1s package< / a > » < / li >
< li > com.vmware.nsx_policy.infra.tier_1s.locale_services package< / li >
< li class = "wy-breadcrumbs-aside" >
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
< a href = "_sources/com.vmware.nsx_policy.infra.tier_1s.locale_services.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.locale_services" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-locale-services-package" > < / span > < h1 > com.vmware.nsx_policy.infra.tier_1s.locale_services package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.locale_services" 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 >
2020-09-21 16:47:14 -04:00
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces.html" > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces.statistics_client" > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces.statistics_client module< / a > < / li >
< / ul >
< / li >
2020-01-27 14:28:46 -05:00
< li class = "toctree-l1" > < 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-l2" > < 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-l2" > < 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 >
2020-09-21 16:47:14 -04:00
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services.html" > com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services.sessions_client" > com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services.sessions_client module< / a > < / li >
< / ul >
< / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / div >
< / div >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-locale-services-interfaces-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.ArpTable" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.< / code > < code class = "descname" > ArpTable< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.ArpTable" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -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 >
2021-03-31 18:40:01 -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 >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.ArpTable.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > , < em > cursor=None< / em > , < em > edge_path=None< / em > , < em > enforcement_point_path=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.ArpTable.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
tier-1 interface, on a edge node specified in edge_path parameter. The
edge_path parameter is mandatory.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < 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 > ) –
by current result page) (optional)< / li >
< li > < 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 > ) – < / li >
< 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 >
< li > < 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 > ) –
result (optional)< / li >
< li > < 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 > ) –
fewer) (optional, default to 1000)< / li >
< li > < 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 > ) – < / li >
< li > < 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 > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.InterfaceArpTable" title = "com.vmware.nsx_policy.model_client.InterfaceArpTable" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.InterfaceArpTable< / 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.InterfaceArpTable< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.DadState" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.< / code > < code class = "descname" > DadState< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.DadState" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -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 >
2021-03-31 18:40:01 -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 >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.DadState.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > , < em > enforcement_point_path=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.DadState.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get tier-1 interface DAD state information.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< 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 >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.InterfaceDADState" title = "com.vmware.nsx_policy.model_client.InterfaceDADState" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.InterfaceDADState< / 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.InterfaceDADState< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.Statistics" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_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_1s.locale_services.interfaces_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -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 >
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.Statistics.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > , < em > cursor=None< / em > , < em > edge_path=None< / em > , < em > enforcement_point_path=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get tier-1 interface statistics information.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < 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 > ) –
by current result page) (optional)< / li >
< li > < 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 > ) – < / li >
< 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 >
< li > < 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 > ) –
default to false)< / li >
< li > < 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 > ) –
result (optional)< / li >
< li > < 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 > ) –
fewer) (optional, default to 1000)< / li >
< li > < 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 > ) – < / li >
< li > < 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 > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.PolicyInterfaceStatistics" title = "com.vmware.nsx_policy.model_client.PolicyInterfaceStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyInterfaceStatistics< / 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.PolicyInterfaceStatistics< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_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_1s.locale_services.interfaces_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05: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 >
2021-03-31 18:40:01 -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 > 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 >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-locale-services-ipsec-vpn-services-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.< / code > < code class = "descname" > LocalEndpoints< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -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 >
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > local_endpoint_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete IPSec VPN local endpoint for a given locale service under
Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > local_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > local_endpoint_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get IPSec VPN local endpoint for a given locale service under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > local_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.IPSecVpnLocalEndpoint" title = "com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint< / 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.IPSecVpnLocalEndpoint< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > cursor=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get paginated list of all IPSec VPN local endpoints for a given locale
service under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < 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 > ) –
by current result page) (optional)< / li >
< li > < 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 > ) –
default to false)< / li >
< li > < 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 > ) –
result (optional)< / li >
< li > < 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 > ) –
fewer) (optional, default to 1000)< / li >
< li > < 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 > ) – < / li >
< li > < 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 > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.IPSecVpnLocalEndpointListResult" title = "com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpointListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpointListResult< / 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.IPSecVpnLocalEndpointListResult< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > local_endpoint_id< / em > , < em > ip_sec_vpn_local_endpoint< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create or patch a custom IPSec VPN local endpoint for a given locale
service under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > local_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > ip_sec_vpn_local_endpoint< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint" title = "com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint< / span > < / code > < / a > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > local_endpoint_id< / em > , < em > ip_sec_vpn_local_endpoint< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.LocalEndpoints.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create or fully replace IPSec VPN local endpoint for a given locale
service under Tier-1. Revision is optional for creation and required
for update.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > local_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > ip_sec_vpn_local_endpoint< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint" title = "com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint< / span > < / code > < / a > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.IPSecVpnLocalEndpoint" title = "com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnLocalEndpoint< / 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.IPSecVpnLocalEndpoint< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.< / code > < code class = "descname" > Sessions< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -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 >
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete IPSec VPN session for a given locale service under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get IPSec VPN session without sensitive data for a given locale service
under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.struct.VapiStruct< / span > < / code > < / 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.IPSecVpnSession
2020-01-27 14:28:46 -05:00
The return value will contain all the attributes defined in
< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnSession" title = "com.vmware.nsx_policy.model_client.IPSecVpnSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnSession< / span > < / code > < / a > .< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > cursor=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get paginated list of all IPSec VPN sessions for a given locale service
under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < 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 > ) –
by current result page) (optional)< / li >
< li > < 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 > ) –
default to false)< / li >
< li > < 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 > ) –
result (optional)< / li >
< li > < 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 > ) –
fewer) (optional, default to 1000)< / li >
< li > < 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 > ) – < / li >
< li > < 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 > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.IPSecVpnSessionListResult" title = "com.vmware.nsx_policy.model_client.IPSecVpnSessionListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnSessionListResult< / 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.IPSecVpnSessionListResult< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > , < em > ip_sec_vpn_session< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create or patch an IPSec VPN session for a given locale service under
Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > ip_sec_vpn_session< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.struct.VapiStruct< / span > < / code > ) –
2020-01-27 14:28:46 -05:00
The parameter must contain all the attributes defined in
2021-03-31 18:40:01 -04:00
< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnSession" title = "com.vmware.nsx_policy.model_client.IPSecVpnSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnSession< / span > < / code > < / a > .< / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.showsensitivedata" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > showsensitivedata< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.showsensitivedata" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get IPSec VPN session with senstive data for a given locale service
under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.struct.VapiStruct< / span > < / code > < / 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.IPSecVpnSession
2020-01-27 14:28:46 -05:00
The return value will contain all the attributes defined in
< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnSession" title = "com.vmware.nsx_policy.model_client.IPSecVpnSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnSession< / span > < / code > < / a > .< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > , < em > ip_sec_vpn_session< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.Sessions.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create or fully replace IPSec VPN session for a given locale service
under Tier-1. Revision is optional for creation and required for
update.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > ip_sec_vpn_session< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.struct.VapiStruct< / span > < / code > ) –
2020-01-27 14:28:46 -05:00
The parameter must contain all the attributes defined in
2021-03-31 18:40:01 -04:00
< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnSession" title = "com.vmware.nsx_policy.model_client.IPSecVpnSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnSession< / span > < / code > < / a > .< / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.struct.VapiStruct< / span > < / code > < / 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.IPSecVpnSession
2020-01-27 14:28:46 -05:00
The return value will contain all the attributes defined in
< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnSession" title = "com.vmware.nsx_policy.model_client.IPSecVpnSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnSession< / span > < / code > < / a > .< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05: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 >
2021-03-31 18:40:01 -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 > 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 >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2020-09-21 16:47:14 -04:00
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-locale-services-l2vpn-services-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.< / code > < code class = "descname" > Sessions< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -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 >
2021-03-31 18:40:01 -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 >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.createwithpeercode" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > createwithpeercode< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > , < em > l2_vpn_session_data< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.createwithpeercode" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Create or patch an L2VPN session under Tier-1 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 >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2_vpn_session_data< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNSessionData" title = "com.vmware.nsx_policy.model_client.L2VPNSessionData" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNSessionData< / span > < / code > < / a > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete L2VPN session under Tier-1. When L2VPN Service is in CLIENT
Mode, the L2VPN Session is deleted along with its transpot tunnels and
related resources.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get L2VPN session under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.L2VPNSession" title = "com.vmware.nsx_policy.model_client.L2VPNSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNSession< / 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.L2VPNSession< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > cursor=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get paginated list of all L2VPN sessions under Tier-1.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < 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 > ) –
by current result page) (optional)< / li >
< li > < 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 > ) –
default to false)< / li >
< li > < 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 > ) –
result (optional)< / li >
< li > < 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 > ) –
fewer) (optional, default to 1000)< / li >
< li > < 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 > ) – < / li >
< li > < 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 > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.L2VPNSessionListResult" title = "com.vmware.nsx_policy.model_client.L2VPNSessionListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNSessionListResult< / 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.L2VPNSessionListResult< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > , < em > l2_vpn_session< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Create or patch an L2VPN session under Tier-1. API supported only when
L2VPN Service is in Server Mode.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2_vpn_session< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNSession" title = "com.vmware.nsx_policy.model_client.L2VPNSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNSession< / span > < / code > < / a > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_id< / em > , < em > session_id< / em > , < em > l2_vpn_session< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.Sessions.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Create or fully replace L2VPN session under Tier-1. API supported only
when L2VPN Service is in Server Mode. Revision is optional for creation
and required for update.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > session_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2_vpn_session< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNSession" title = "com.vmware.nsx_policy.model_client.L2VPNSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNSession< / span > < / code > < / a > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.L2VPNSession" title = "com.vmware.nsx_policy.model_client.L2VPNSession" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNSession< / 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.L2VPNSession< / 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 >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.l2vpn_services_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -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 >
2021-03-31 18:40:01 -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 > 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 >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
2020-01-27 14:28:46 -05:00
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-locale-services-service-instances-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client.Statistics" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_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_1s.locale_services.service_instances_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -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 >
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client.Statistics.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > locale_service_id< / em > , < em > service_instance_id< / em > , < em > enforcement_point_path=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get statistics for all data NICs on all runtimes associated with this
Tier1 PolicyServiceInstance.< / p >
2021-03-31 18:40:01 -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" > < ul class = "first simple" >
< li > < strong > tier1_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 > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< 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 >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / 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.PolicyServiceInstanceStatistics" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstanceStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstanceStatistics< / 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.PolicyServiceInstanceStatistics< / 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 >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / 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 >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_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_1s.locale_services.service_instances_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05: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 >
2021-03-31 18:40:01 -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 > 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 >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2021-03-31 18:40:01 -04:00
< a href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< a href = "com.vmware.nsx_policy.infra.tier_1s.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx_policy.infra.tier_1s package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2020-01-27 14:28:46 -05:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2021-03-31 18:40:01 -04:00
© Copyright 2021, VMware, Inc..
2020-01-27 14:28:46 -05:00
< / p >
< / div >
2020-09-21 16:47:14 -04:00
2021-03-31 18:40:01 -04:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
2020-09-21 16:47:14 -04:00
2021-03-31 18:40:01 -04:00
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
2020-09-21 16:47:14 -04:00
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2020-01-27 14:28:46 -05:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
