2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2019-01-25 18:19:42 -05:00
< title > com.vmware.nsx_policy.infra.tier_0s.locale_services package — NSX-T Policy SDK 2.3.0.0.2 documentation< / title >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
2018-08-07 19:42:25 -04:00
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2018-11-01 14:01:54 -04:00
< link rel = "next" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html" / >
< link rel = "prev" title = "com.vmware.nsx_policy.infra.tier_0s package" href = "com.vmware.nsx_policy.infra.tier_0s.html" / >
2018-08-07 19:42:25 -04:00
< script src = "_static/js/modernizr.min.js" > < / script >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "index.html" class = "icon icon-home" > NSX-T Policy SDK
< / a >
< div class = "version" >
2019-01-25 18:19:42 -05:00
2.3.0.0.2
2018-08-07 19:42:25 -04:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "com.html" > com package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "com.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "com.vmware.html" > com.vmware package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "com.vmware.html#subpackages" > Subpackages< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client" > com.vmware.nsx_policy_client module< / a > < / li >
2018-11-01 14:01:54 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client_for_vmc" > com.vmware.nsx_policy_client_for_vmc module< / a > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > NSX-T Policy SDK< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.html" > com.vmware.nsx_policy.infra package< / a > » < / li >
2018-11-01 14:01:54 -04:00
< li > < a href = "com.vmware.nsx_policy.infra.tier_0s.html" > com.vmware.nsx_policy.infra.tier_0s package< / a > » < / li >
< li > com.vmware.nsx_policy.infra.tier_0s.locale_services package< / li >
2018-08-07 19:42:25 -04:00
< li class = "wy-breadcrumbs-aside" >
2018-11-01 14:01:54 -04:00
< a href = "_sources/com.vmware.nsx_policy.infra.tier_0s.locale_services.rst.txt" rel = "nofollow" > View page source< / a >
2018-08-07 19:42:25 -04:00
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-package" > < / span > < h1 > com.vmware.nsx_policy.infra.tier_0s.locale_services package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services" title = "Permalink to this headline" > ¶< / a > < / h1 >
2018-08-07 19:42:25 -04:00
< 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 >
2018-11-01 14:01:54 -04:00
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.l2vpns_client module< / a > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-bgp-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.< / code > < code class = "descname" > Neighbors< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > neighbor_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Delete BGP neighbor config< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< li > < strong > neighbor_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > neighbor_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Read BGP neighbor config< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< li > < strong > neighbor_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpNeighborConfig" title = "com.vmware.nsx_policy.model_client.BgpNeighborConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpNeighborConfig< / 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.BgpNeighborConfig< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.list" >
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > cursor=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_0s.locale_services.bgp_client.Neighbors.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Paginated list of all BGP neighbor configurations< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< 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 > 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 >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpNeighborConfigListResult" title = "com.vmware.nsx_policy.model_client.BgpNeighborConfigListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpNeighborConfigListResult< / 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.BgpNeighborConfigListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > neighbor_id< / em > , < em > bgp_neighbor_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > If BGP neighbor config with the neighbor-id is not already present,
create a new neighbor config. If it already exists, replace the BGP
neighbor config with this object.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< li > < strong > neighbor_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > bgp_neighbor_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpNeighborConfig" title = "com.vmware.nsx_policy.model_client.BgpNeighborConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpNeighborConfig< / span > < / code > < / a > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > neighbor_id< / em > , < em > bgp_neighbor_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.Neighbors.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > If BGP neighbor config with the neighbor-id is not already present,
create a new neighbor config. If it already exists, replace the BGP
neighbor config with this object.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< li > < strong > neighbor_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > bgp_neighbor_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpNeighborConfig" title = "com.vmware.nsx_policy.model_client.BgpNeighborConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpNeighborConfig< / span > < / code > < / a > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpNeighborConfig" title = "com.vmware.nsx_policy.model_client.BgpNeighborConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpNeighborConfig< / 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.BgpNeighborConfig< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-byod-service-instances-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.< / code > < code class = "descname" > ServiceInstanceEndpoints< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > service_instance_id< / em > , < em > service_instance_endpoint_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete policy service instance endpoint< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > service_instance_id< / em > , < em > service_instance_endpoint_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read service instance endpoint< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< 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.ServiceInstanceEndpoint" title = "com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint< / span > < / code > < / a > < / p >
2018-08-07 19:42:25 -04:00
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.ServiceInstanceEndpoint< / p >
2018-08-07 19:42:25 -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 >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.list" >
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > service_instance_id< / em > , < em > cursor=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_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > List all service instance endpoint< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< li > < strong > 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 > 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 >
< / ul >
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< 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.ServiceInstanceEndpointListResult" title = "com.vmware.nsx_policy.model_client.ServiceInstanceEndpointListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInstanceEndpointListResult< / span > < / code > < / a > < / p >
2018-08-07 19:42:25 -04:00
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.ServiceInstanceEndpointListResult< / p >
2018-08-07 19:42:25 -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 >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > service_instance_id< / em > , < em > service_instance_endpoint_id< / em > , < em > service_instance_endpoint< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create Service instance endpoint.< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_endpoint< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint" title = "com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint< / span > < / code > < / a > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > service_instance_id< / em > , < em > service_instance_endpoint_id< / em > , < em > service_instance_endpoint< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.ServiceInstanceEndpoints.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create service instance endpoint with given request if not exist.
Modification of service instance endpoint is not allowed.< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > service_instance_endpoint< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint" title = "com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint< / span > < / code > < / a > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< 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.ServiceInstanceEndpoint" title = "com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint< / span > < / code > < / a > < / p >
2018-08-07 19:42:25 -04:00
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.ServiceInstanceEndpoint< / p >
2018-08-07 19:42:25 -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 >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_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_0s.locale_services.byod_service_instances_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-endpoints-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
< 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 >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.< / code > < code class = "descname" > VirtualEndpoints< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > virtual_endpoint_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete virtual endpoint< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > virtual_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
2018-08-07 19:42:25 -04:00
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > virtual_endpoint_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read virtual endpoint with given id under given tier-0.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > virtual_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.VirtualEndpoint" title = "com.vmware.nsx_policy.model_client.VirtualEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.VirtualEndpoint< / 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.VirtualEndpoint< / p >
2018-08-07 19:42:25 -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 >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
2018-11-01 14:01:54 -04:00
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.list" >
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > cursor=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_0s.locale_services.endpoints_client.VirtualEndpoints.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > List all virtual endpoints< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > 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 > 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 >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.VirtualEndpointListResult" title = "com.vmware.nsx_policy.model_client.VirtualEndpointListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.VirtualEndpointListResult< / 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.VirtualEndpointListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > virtual_endpoint_id< / em > , < em > virtual_endpoint< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create or update virtual endpoint.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > virtual_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > virtual_endpoint< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.VirtualEndpoint" title = "com.vmware.nsx_policy.model_client.VirtualEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.VirtualEndpoint< / span > < / code > < / a > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > virtual_endpoint_id< / em > , < em > virtual_endpoint< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client.VirtualEndpoints.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create or update virtual endpoint.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > virtual_endpoint_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > virtual_endpoint< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.VirtualEndpoint" title = "com.vmware.nsx_policy.model_client.VirtualEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.VirtualEndpoint< / span > < / code > < / a > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.VirtualEndpoint" title = "com.vmware.nsx_policy.model_client.VirtualEndpoint" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.VirtualEndpoint< / 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.VirtualEndpoint< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
< / div >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-l2vpn-context-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.< / code > < code class = "descname" > L2vpns< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l2vpn_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete the L2Vpn with the given id.< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l2vpn_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read the L2Vpn with the given id.< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< 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.L2Vpn" title = "com.vmware.nsx_policy.model_client.L2Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2Vpn< / span > < / code > < / a > < / p >
2018-08-07 19:42:25 -04:00
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.L2Vpn< / p >
2018-08-07 19:42:25 -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 >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.list" >
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > cursor=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_0s.locale_services.l2vpn_context_client.L2vpns.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Paginated list of L2Vpns.< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > 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 > 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 >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< 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.L2VpnListResult" title = "com.vmware.nsx_policy.model_client.L2VpnListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VpnListResult< / 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.L2VpnListResult< / p >
< / td >
< / tr >
2018-08-07 19:42:25 -04:00
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l2vpn_id< / em > , < em > l2_vpn< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create a new L2Vpn if the L2Vpn with given id does not already exist.
If the L2Vpn with the given id already exists, merge with the existing
L2Vpn. This is a patch.< / p >
2018-08-07 19:42:25 -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" >
2018-11-01 14:01:54 -04:00
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2_vpn< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2Vpn" title = "com.vmware.nsx_policy.model_client.L2Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2Vpn< / span > < / code > < / a > ) – < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
2018-08-07 19:42:25 -04:00
< / td >
< / tr >
2018-11-01 14:01:54 -04:00
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l2vpn_id< / em > , < em > l2_vpn< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.L2vpns.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create a new L2Vpn if the L2Vpn with given id does not already exist.
If the L2Vpn with the given id already exists, update the existing
L2Vpn. This is a full replace.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l2_vpn< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2Vpn" title = "com.vmware.nsx_policy.model_client.L2Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2Vpn< / span > < / code > < / a > ) – < / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2Vpn" title = "com.vmware.nsx_policy.model_client.L2Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2Vpn< / 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.L2Vpn< / p >
2018-08-07 19:42:25 -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 >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-l3vpns-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.Statistics" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.< / code > < code class = "descname" > Statistics< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< 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" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.Statistics.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3vpn_id< / em > , < em > enforcement_point_path=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Get statistics of an L3Vpn. - no enforcement point path specified:
Stats will be evaluated on each enforcement point. -
{enforcement_point_path}: Stats are evaluated only on the given
enforcement point.< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > l3vpn_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 >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.AggregateL3VpnStatistics" title = "com.vmware.nsx_policy.model_client.AggregateL3VpnStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.AggregateL3VpnStatistics< / 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.AggregateL3VpnStatistics< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2018-11-01 14:01:54 -04:00
< a href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< a href = "com.vmware.nsx_policy.infra.tier_0s.html" class = "btn btn-neutral" title = "com.vmware.nsx_policy.infra.tier_0s package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2018-08-07 19:42:25 -04:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2018-11-01 14:01:54 -04:00
© Copyright 2018, VMware, Inc.
2018-08-07 19:42:25 -04:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
2018-11-01 14:01:54 -04:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
2018-08-07 19:42:25 -04:00
2018-11-01 14:01:54 -04:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
2018-08-07 19:42:25 -04:00
< script type = "text/javascript" >
jQuery(function () {
2018-11-01 14:01:54 -04:00
SphinxRtdTheme.Navigation.enable(true);
2018-08-07 19:42:25 -04:00
});
< / script >
< / body >
< / html >
