2018-11-01 14:01:54 -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 package — NSX-T Policy SDK 2.3.0.0.2 documentation< / title >
2018-11-01 14:01:54 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< 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" / >
< link rel = "next" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services package" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html" / >
< link rel = "prev" title = "com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops package" href = "com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.html" / >
< 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-11-01 14:01:54 -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 >
< 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 >
< / 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 >
< li > com.vmware.nsx_policy.infra.tier_0s package< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/com.vmware.nsx_policy.infra.tier_0s.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-package" > < / span > < h1 > com.vmware.nsx_policy.infra.tier_0s package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "subpackages" >
< h2 > Subpackages< a class = "headerlink" href = "#subpackages" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html" > com.vmware.nsx_policy.infra.tier_0s.locale_services package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html#subpackages" > Subpackages< / a > < ul >
< li class = "toctree-l3" > < 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-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < 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 >
< / ul >
< / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client module< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client module< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module< / a > < / li >
< / 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 >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.locale_services_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-locale-services-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.locale_services_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.locale_services_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > Bgp< / 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_client.Bgp" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read BGP routing 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" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.BgpRoutingConfig" title = "com.vmware.nsx_policy.model_client.BgpRoutingConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpRoutingConfig< / 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.BgpRoutingConfig< / 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_client.Bgp.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > bgp_routing_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If an BGP routing config not present, create BGP routing config. If it
already exists, update the routing 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" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > bgp_routing_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpRoutingConfig" title = "com.vmware.nsx_policy.model_client.BgpRoutingConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpRoutingConfig< / span > < / code > < / a > ) – (required)< / 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_client.Bgp.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > bgp_routing_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If BGP routing config is not already present, create BGP routing
config. If it already exists, replace the BGP routing 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" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > bgp_routing_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.BgpRoutingConfig" title = "com.vmware.nsx_policy.model_client.BgpRoutingConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpRoutingConfig< / span > < / code > < / a > ) – (required)< / 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.BgpRoutingConfig" title = "com.vmware.nsx_policy.model_client.BgpRoutingConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.BgpRoutingConfig< / 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.BgpRoutingConfig< / 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_client.ByodServiceInstances" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > ByodServiceInstances< / 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_client.ByodServiceInstances" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ByodServiceInstances.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 > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ByodServiceInstances.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete BYOD policy service instance< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / 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_client.ByodServiceInstances.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 > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ByodServiceInstances.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read byod service instance< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / 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.ByodPolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance< / 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.ByodPolicyServiceInstance< / 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_client.ByodServiceInstances.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_client.ByodServiceInstances.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read all BYOD service instance objects under a 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / 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 > ) – Opaque cursor to be used for getting next page of records (supplied
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 > ) – Comma separated list of fields that should be included in query
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 > ) – Maximum number of results to return in this page (server may return
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 > ) – (optional)< / 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 > ) – Field by which records are sorted (optional)< / 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.ByodPolicyServiceInstanceListResult" title = "com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult< / 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.ByodPolicyServiceInstanceListResult< / 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_client.ByodServiceInstances.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 > byod_policy_service_instance< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ByodServiceInstances.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create BYOD Service Instance which represent instance of service
definition created on manager.< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / li >
< li > < strong > byod_policy_service_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance< / span > < / code > < / a > ) – (required)< / 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_client.ByodServiceInstances.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 > byod_policy_service_instance< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ByodServiceInstances.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create BYOD Service Instance which represent instance of service
definition created on manager.< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Byod service instance id (required)< / li >
< li > < strong > byod_policy_service_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance< / span > < / code > < / a > ) – (required)< / 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.ByodPolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance< / 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.ByodPolicyServiceInstance< / 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_client.Interfaces" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > Interfaces< / 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_client.Interfaces" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete tier-0 interface< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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_client.Interfaces.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read tier-0 interface< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.Tier0Interface" title = "com.vmware.nsx_policy.model_client.Tier0Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0Interface< / 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.Tier0Interface< / 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_client.Interfaces.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_client.Interfaces.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Paginated list of all Tier-0 Interfaces< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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 > ) – Opaque cursor to be used for getting next page of records (supplied
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 > ) – Comma separated list of fields that should be included in query
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 > ) – Maximum number of results to return in this page (server may return
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 > ) – (optional)< / 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 > ) – Field by which records are sorted (optional)< / 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.Tier0InterfaceListResult" title = "com.vmware.nsx_policy.model_client.Tier0InterfaceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0InterfaceListResult< / 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.Tier0InterfaceListResult< / 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_client.Interfaces.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > , < em > tier0_interface< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If an interface with the interface-id is not already present, create a
new interface. If it already exists, update the interface for specified
attributes.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_interface< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier0Interface" title = "com.vmware.nsx_policy.model_client.Tier0Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0Interface< / span > < / code > < / a > ) – (required)< / 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_client.Interfaces.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > , < em > tier0_interface< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If an interface with the interface-id is not already present, create a
new interface. If it already exists, replace the interface 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" >
< li > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_interface< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier0Interface" title = "com.vmware.nsx_policy.model_client.Tier0Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0Interface< / span > < / code > < / a > ) – (required)< / 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.Tier0Interface" title = "com.vmware.nsx_policy.model_client.Tier0Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0Interface< / 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.Tier0Interface< / 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_client.L2vpnContext" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > L2vpnContext< / 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_client.L2vpnContext" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read L2Vpn Context.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.L2VpnContext" title = "com.vmware.nsx_policy.model_client.L2VpnContext" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VpnContext< / 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.L2VpnContext< / 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_client.L3vpnContext" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > L3vpnContext< / 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_client.L3vpnContext" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read the L3Vpn Context under 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.L3VpnContext" title = "com.vmware.nsx_policy.model_client.L3VpnContext" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3VpnContext< / 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.L3VpnContext< / 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_client.L3vpnContext.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3_vpn_context< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create the new L3Vpn Context under tier-0 if it does not exist. If the
L3Vpn Context already exists under tier-0, merge with the the existing
one. This is a patch. If the passed L3VpnContext has new L3VpnRules,
add them to the existing L3VpnContext. If the passed L3VpnContext also
has existing L3VpnRules, update the existing L3VpnRules.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3_vpn_context< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3VpnContext" title = "com.vmware.nsx_policy.model_client.L3VpnContext" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3VpnContext< / span > < / code > < / a > ) – (required)< / 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_client.L3vpnContext.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3_vpn_context< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create the new L3Vpn Context under tier-0 if it does not exist. If the
L3Vpn Context already exists under tier-0, replace the the existing
one. 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3_vpn_context< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3VpnContext" title = "com.vmware.nsx_policy.model_client.L3VpnContext" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3VpnContext< / span > < / code > < / a > ) – (required)< / 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.L3VpnContext" title = "com.vmware.nsx_policy.model_client.L3VpnContext" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3VpnContext< / 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.L3VpnContext< / 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_client.L3vpns" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > L3vpns< / 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_client.L3vpns" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION" >
< code class = "descname" > LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION< / code > < em class = "property" > = 'PolicyBasedL3VpnSession'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > l3vpnSession< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > L3vpns.list()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION" >
< code class = "descname" > LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION< / code > < em class = "property" > = 'RouteBasedL3VpnSession'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > l3vpnSession< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > L3vpns.list()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3vpn_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete the L3Vpn with the given id.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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_client.L3vpns.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3vpn_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read the L3Vpn with the given id. No sensitive data is returned as part
of the response.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.L3Vpn" title = "com.vmware.nsx_policy.model_client.L3Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3Vpn< / 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.L3Vpn< / 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_client.L3vpns.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 > l3vpn_session=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_client.L3vpns.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Paginated list of L3Vpns.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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 > ) – Opaque cursor to be used for getting next page of records (supplied
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > l3vpn_session< / 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 > ) – Resource type of L3Vpn Session (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 > ) – Maximum number of results to return in this page (server may return
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 > ) – (optional)< / 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 > ) – Field by which records are sorted (optional)< / 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.L3VpnListResult" title = "com.vmware.nsx_policy.model_client.L3VpnListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3VpnListResult< / 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.L3VpnListResult< / 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_client.L3vpns.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3vpn_id< / em > , < em > l3_vpn< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create the new L3Vpn if it does not exist. If the L3Vpn already exists,
merge with the the existing one. This is a patch. - If the passed L3Vpn
is a policy-based one and has new L3VpnRules, add them to the existing
L3VpnRules. - If the passed L3Vpn is a policy-based one and also has
existing L3VpnRules, update the existing L3VpnRules.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3_vpn< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3Vpn" title = "com.vmware.nsx_policy.model_client.L3Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3Vpn< / span > < / code > < / a > ) – (required)< / 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_client.L3vpns.showsensitivedata" >
< code class = "descname" > showsensitivedata< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3vpn_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.showsensitivedata" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read the L3Vpn with the given id. Sensitive data is returned as part of
the response.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.L3Vpn" title = "com.vmware.nsx_policy.model_client.L3Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3Vpn< / 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.L3Vpn< / 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_client.L3vpns.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > l3vpn_id< / em > , < em > l3_vpn< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create a new L3Vpn if the L3Vpn with given id does not already exist.
If the L3Vpn with the given id already exists, replace the existing
L3Vpn. This 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > l3_vpn< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L3Vpn" title = "com.vmware.nsx_policy.model_client.L3Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3Vpn< / span > < / code > < / a > ) – (required)< / 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.L3Vpn" title = "com.vmware.nsx_policy.model_client.L3Vpn" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L3Vpn< / 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.L3Vpn< / 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_client.ServiceInstances" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > ServiceInstances< / 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_client.ServiceInstances" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances.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 > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete policy service instance< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / 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_client.ServiceInstances.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 > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read service instance< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / 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.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / 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.PolicyServiceInstance< / 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_client.ServiceInstances.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_client.ServiceInstances.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read all service instance objects under a 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / 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 > ) – Opaque cursor to be used for getting next page of records (supplied
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 > ) – Comma separated list of fields that should be included in query
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 > ) – Maximum number of results to return in this page (server may return
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 > ) – (optional)< / 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 > ) – Field by which records are sorted (optional)< / 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.PolicyServiceInstanceListResult" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult< / 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.PolicyServiceInstanceListResult< / 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_client.ServiceInstances.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 > policy_service_instance< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create Service Instance.< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / li >
< li > < strong > policy_service_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / span > < / code > < / a > ) – (required)< / 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_client.ServiceInstances.reauth" >
< code class = "descname" > reauth< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > service_instance_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances.reauth" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / 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_client.ServiceInstances.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 > policy_service_instance< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInstances.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create service instance.< / 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 > ) – Tier-0 id (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Locale service id (required)< / li >
< li > < strong > service_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Service instance id (required)< / li >
< li > < strong > policy_service_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / span > < / code > < / a > ) – (required)< / 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.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / 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.PolicyServiceInstance< / 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_client.ServiceInterfaces" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > ServiceInterfaces< / 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_client.ServiceInterfaces" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete service interface< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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_client.ServiceInterfaces.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read service interface< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.ServiceInterface" title = "com.vmware.nsx_policy.model_client.ServiceInterface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInterface< / 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.ServiceInterface< / 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_client.ServiceInterfaces.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_client.ServiceInterfaces.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Paginated list of all Service Interfaces< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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 > ) – Opaque cursor to be used for getting next page of records (supplied
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 > ) – Comma separated list of fields that should be included in query
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 > ) – Maximum number of results to return in this page (server may return
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 > ) – (optional)< / 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 > ) – Field by which records are sorted (optional)< / 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.ServiceInterfaceListResult" title = "com.vmware.nsx_policy.model_client.ServiceInterfaceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInterfaceListResult< / 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.ServiceInterfaceListResult< / 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_client.ServiceInterfaces.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > , < em > service_interface< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If an interface with the interface-id is not already present, create a
new interface. If it already exists, update the interface for specified
attributes.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > service_interface< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ServiceInterface" title = "com.vmware.nsx_policy.model_client.ServiceInterface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInterface< / span > < / code > < / a > ) – (required)< / 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_client.ServiceInterfaces.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > interface_id< / em > , < em > service_interface< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If an interface with the interface-id is not already present, create a
new interface. Modification of service interface is not allowed.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > service_interface< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ServiceInterface" title = "com.vmware.nsx_policy.model_client.ServiceInterface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInterface< / span > < / code > < / a > ) – (required)< / 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.ServiceInterface" title = "com.vmware.nsx_policy.model_client.ServiceInterface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ServiceInterface< / 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.ServiceInterface< / 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_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Tier0DeploymentMaps" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "descname" > Tier0DeploymentMaps< / 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_client.Tier0DeploymentMaps" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Tier0DeploymentMaps.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > tier0_deployment_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Tier0DeploymentMaps.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete Tier-0 Deployment Map< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_deployment_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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_client.Tier0DeploymentMaps.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > tier0_deployment_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Tier0DeploymentMaps.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read a Tier-0 Deployment Map< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_deployment_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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.Tier0DeploymentMap" title = "com.vmware.nsx_policy.model_client.Tier0DeploymentMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0DeploymentMap< / 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.Tier0DeploymentMap< / 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_client.Tier0DeploymentMaps.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_client.Tier0DeploymentMaps.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Paginated list of all Tier-0 Deployment Entries.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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 > ) – Opaque cursor to be used for getting next page of records (supplied
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 > ) – Comma separated list of fields that should be included in query
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 > ) – Maximum number of results to return in this page (server may return
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 > ) – (optional)< / 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 > ) – Field by which records are sorted (optional)< / 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.Tier0DeploymentMapListResult" title = "com.vmware.nsx_policy.model_client.Tier0DeploymentMapListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0DeploymentMapListResult< / 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.Tier0DeploymentMapListResult< / 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_client.Tier0DeploymentMaps.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > tier0_deployment_map_id< / em > , < em > tier0_deployment_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Tier0DeploymentMaps.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If the passed Tier-0 Deployment Map does not already exist, create a
new Tier-0 Deployment Map. If it already exists, patch it.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_deployment_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_deployment_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier0DeploymentMap" title = "com.vmware.nsx_policy.model_client.Tier0DeploymentMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0DeploymentMap< / span > < / code > < / a > ) – (required)< / 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.Tier0DeploymentMap" title = "com.vmware.nsx_policy.model_client.Tier0DeploymentMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0DeploymentMap< / 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.Tier0DeploymentMap< / 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_client.Tier0DeploymentMaps.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier0_id< / em > , < em > locale_service_id< / em > , < em > tier0_deployment_map_id< / em > , < em > tier0_deployment_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Tier0DeploymentMaps.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If the passed Tier-0 Deployment Map does not already exist, create a
new Tier-0 Deployment Map. If it already exists, replace it.< / 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 > ) – (required)< / li >
< li > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_deployment_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > tier0_deployment_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier0DeploymentMap" title = "com.vmware.nsx_policy.model_client.Tier0DeploymentMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0DeploymentMap< / span > < / code > < / a > ) – (required)< / 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.Tier0DeploymentMap" title = "com.vmware.nsx_policy.model_client.Tier0DeploymentMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier0DeploymentMap< / 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.Tier0DeploymentMap< / 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 >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops.html" class = "btn btn-neutral" title = "com.vmware.nsx_policy.infra.realized_state.enforcement_points.ops package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2018, VMware, Inc.
< / 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 >
< 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 >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >