2019-05-29 14:05:24 -04:00
<!DOCTYPE html>
2020-09-21 16:47:14 -04:00
< html class = "writer-html5" lang = "en" >
2019-05-29 14:05:24 -04:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2020-09-21 16:47:14 -04:00
< title > com.vmware.nsx_policy.infra.tier_0s package — NSX-T Policy API 3.0.2.0.0 documentation< / title >
2019-05-29 14:05:24 -04:00
2020-09-21 16:47:14 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2019-05-29 14:05:24 -04:00
2020-09-21 16:47:14 -04:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2019-05-29 14:05:24 -04:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
2020-06-05 18:48:31 -04:00
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< script src = "_static/language_data.js" > < / script >
2019-05-29 14:05:24 -04:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2020-01-27 14:28:46 -05:00
< link rel = "next" title = "com.vmware.nsx_policy.infra.tier_0s.groups package" href = "com.vmware.nsx_policy.infra.tier_0s.groups.html" / >
2020-09-21 16:47:14 -04:00
< link rel = "prev" title = "com.vmware.nsx_policy.infra.tags package" href = "com.vmware.nsx_policy.infra.tags.html" / >
2019-05-29 14:05:24 -04:00
< / 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" >
2020-09-21 16:47:14 -04:00
< a href = "index.html" class = "icon icon-home" alt = "Documentation Home" > NSX-T Policy API
2019-05-29 14:05:24 -04:00
< / a >
< div class = "version" >
2020-09-21 16:47:14 -04:00
3.0.2.0.0
2019-05-29 14:05:24 -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 >
2020-09-21 16:47:14 -04:00
2019-05-29 14:05:24 -04:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "com.html" > com package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "com.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "com.vmware.html" > com.vmware package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "com.vmware.html#subpackages" > Subpackages< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client" > com.vmware.nsx_policy_client module< / a > < / li >
2020-06-05 18:48:31 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module" > com.vmware.nsx_policy_client_for_vmc module< / a > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
2020-09-21 16:47:14 -04:00
2019-05-29 14:05:24 -04:00
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > NSX-T Policy API< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
2020-09-21 16:47:14 -04:00
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
2019-05-29 14:05:24 -04:00
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.html" > com.vmware.nsx_policy.infra package< / a > » < / li >
< li > 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 >
2020-01-27 14:28:46 -05:00
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.groups.html" > com.vmware.nsx_policy.infra.tier_0s.groups package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.groups.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.groups.html#module-com.vmware.nsx_policy.infra.tier_0s.groups.members_client" > com.vmware.nsx_policy.infra.tier_0s.groups.members_client module< / a > < / li >
< / ul >
< / li >
2019-05-29 14:05:24 -04:00
< 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.bgp.html" > com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp package< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp.neighbors_client module< / a > < / li >
< / ul >
< / li >
2020-09-21 16:47:14 -04:00
< li class = "toctree-l3" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces.html" > com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces package< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces.statistics_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces.statistics_client module< / a > < / li >
< / ul >
< / li >
2020-01-27 14:28:46 -05:00
< li class = "toctree-l3" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services.html" > com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services package< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services.sessions_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services.sessions_client module< / a > < / li >
< / ul >
< / li >
2019-05-29 14:05:24 -04:00
< 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 >
2020-01-27 14:28:46 -05:00
< li class = "toctree-l3" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.html" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services package< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.html#module-com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.sessions_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.sessions_client module< / a > < / li >
< / ul >
< / li >
2019-05-29 14:05:24 -04:00
< / 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 >
2020-09-21 16:47:14 -04:00
< 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.inter_site_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.inter_site_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.interfaces_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.interfaces_client module< / a > < / li >
2020-01-27 14:28:46 -05:00
< 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.ipsec_vpn_services_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.ipsec_vpn_services_client module< / a > < / li >
2019-05-29 14:05:24 -04:00
< 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 >
2020-01-27 14:28:46 -05:00
< 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_services_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services_client module< / a > < / li >
2019-05-29 14:05:24 -04:00
< 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 >
2020-09-21 16:47:14 -04:00
< 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.multicast_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.multicast_client module< / a > < / li >
2020-01-27 14:28:46 -05:00
< 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.service_instances_client" > com.vmware.nsx_policy.infra.tier_0s.locale_services.service_instances_client module< / a > < / li >
< / ul >
< / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / div >
< / div >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
2020-01-27 14:28:46 -05:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-dns-forwarder-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Statistics" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.< / code > < code class = "sig-name descname" > Statistics< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Statistics.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcement_point_path< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get statistics of tier-0 DNS forwarder. - no enforcement point path
specified: Statistics will be evaluated on each enforcement point. -
{enforcement_point_path}: Statistics are evaluated only on the given
enforcement point.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-01-27 14:28:46 -05:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcement_point_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics" title = "com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatistics< / span > < / code > < / a > < / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.AggregateDNSForwarderStatistics< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Status" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.< / code > < code class = "sig-name descname" > Status< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Status" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-05-29 14:05:24 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Status.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcement_point_path< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.Status.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get current status of tier-0 DNS forwarder. - no enforcement point path
specified: Status will be evaluated on each enforcement point. -
{enforcement_point_path}: Status will be evaluated only on the given
enforcement point.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-01-27 14:28:46 -05:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > enforcement_point_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus" title = "com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.AggregateDNSForwarderStatus< / span > < / code > < / a > < / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.AggregateDNSForwarderStatus< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.StubFactory" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.< / code > < code class = "sig-name descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > stub_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.dns_forwarder_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
< / dd > < / dl >
< / 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 >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > Bgp< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / 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 >
2019-05-29 14:05:24 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-09-21 16:47:14 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > override< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Deletes the specified overridden BgpRoutingConfig. If the
BgpRoutingConfig is not overridden, it won’ < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > override< / 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.get" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dd > < p > Read BGP routing config< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-even" > < p > < 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 >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.BgpRoutingConfig< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-09-21 16:47:14 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > bgp_routing_config< / span > < / em > , < em class = "sig-param" > < span class = "n" > override< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < strong > override< / 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Bgp.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > bgp_routing_config< / span > < / em > , < em class = "sig-param" > < span class = "n" > override< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < strong > override< / 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.BgpRoutingConfig< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2019-05-29 14:05:24 -04:00
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > Interfaces< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / 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 >
2019-05-29 14:05:24 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > override< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > override< / 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 > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / 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 >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < 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 >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Tier0Interface< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > cursor< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > include_mark_for_delete_objects< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > included_fields< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > page_size< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_ascending< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_by< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< li > < p > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / p > < / li >
2020-01-27 14:28:46 -05:00
< li > < p > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / p > < / li >
2019-05-29 14:05:24 -04:00
< li > < p > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / p > < / li >
< li > < p > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < 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 >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Tier0InterfaceListResult< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > tier0_interface< / span > < / em > , < em class = "sig-param" > < span class = "n" > override< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < strong > override< / 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 > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Interfaces.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > tier0_interface< / span > < / em > , < em class = "sig-param" > < span class = "n" > override< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < strong > override< / 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 > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < 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 >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Tier0Interface< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > IpsecVpnServices< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete IPSec VPN service for given locale service under Tier-0.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Get IPSec VPN service for given locale service under Tier-0.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / dd >
2020-06-05 18:48:31 -04:00
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnService" title = "com.vmware.nsx_policy.model_client.IPSecVpnService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnService< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.IPSecVpnService< / p >
< / dd >
2019-05-29 14:05:24 -04:00
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > cursor< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > include_mark_for_delete_objects< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > included_fields< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > page_size< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_ascending< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_by< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Get paginated list of all IPSec VPN services for given locale service
under Tier-0.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / p > < / li >
< li > < p > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / p > < / li >
< li > < p > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / p > < / li >
< li > < p > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnServiceListResult" title = "com.vmware.nsx_policy.model_client.IPSecVpnServiceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnServiceListResult< / span > < / code > < / a > < / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.IPSecVpnServiceListResult< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > ip_sec_vpn_service< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create or patch IPSec VPN service for given locale service under
Tier-0.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > ip_sec_vpn_service< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnService" title = "com.vmware.nsx_policy.model_client.IPSecVpnService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnService< / span > < / code > < / a > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > ip_sec_vpn_service< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.IpsecVpnServices.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create or fully replace IPSec VPN service for given locale service
under Tier-0. Revision is optional for creation and required for
update.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > ip_sec_vpn_service< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnService" title = "com.vmware.nsx_policy.model_client.IPSecVpnService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnService< / span > < / code > < / a > ) – < / p > < / li >
2019-05-29 14:05:24 -04:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPSecVpnService" title = "com.vmware.nsx_policy.model_client.IPSecVpnService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPSecVpnService< / span > < / code > < / a > < / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.IPSecVpnService< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > L2vpnContext< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnContext.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / 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 > < dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < 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 >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L2VpnContext< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > L2vpnServices< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete L2VPN service for given Tier-0 locale service.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get L2VPN service for given Tier-0 locale service.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNService" title = "com.vmware.nsx_policy.model_client.L2VPNService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNService< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L2VPNService< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > cursor< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > include_mark_for_delete_objects< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > included_fields< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > page_size< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_ascending< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_by< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get paginated list of all L2VPN services under Tier-0.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / p > < / li >
< li > < p > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / p > < / li >
< li > < p > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / p > < / li >
< li > < p > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNServiceListResult" title = "com.vmware.nsx_policy.model_client.L2VPNServiceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNServiceListResult< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L2VPNServiceListResult< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l2_vpn_service< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Create or patch L2VPN service for given Tier-0 locale service.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > l2_vpn_service< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNService" title = "com.vmware.nsx_policy.model_client.L2VPNService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNService< / span > < / code > < / a > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l2_vpn_service< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L2vpnServices.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Create or fully replace L2VPN service for given Tier-0 locale service.
2020-06-05 18:48:31 -04:00
Revision is optional for creation and required for update.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > l2_vpn_service< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNService" title = "com.vmware.nsx_policy.model_client.L2VPNService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNService< / span > < / code > < / a > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.L2VPNService" title = "com.vmware.nsx_policy.model_client.L2VPNService" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.L2VPNService< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L2VPNService< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > L3vpnContext< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpnContext.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / 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 > < dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< / ul >
< / dd >
2020-06-05 18:48:31 -04:00
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L3VpnContext< / p >
< / dd >
2020-01-27 14:28:46 -05:00
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< / dd > < / dl >
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > L3vpns< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
< dl class = "py attribute" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_POLICYBASEDL3VPNSESSION" >
< code class = "sig-name 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 = "py attribute" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.LIST_L3VPN_SESSION_ROUTEBASEDL3VPNSESSION" >
< code class = "sig-name 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 = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3vpn_id< / span > < / 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 > < dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
2020-01-27 14:28:46 -05:00
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3vpn_id< / span > < / 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 > < dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < 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 >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L3Vpn< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > cursor< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > include_mark_for_delete_objects< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > included_fields< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3vpn_session< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > page_size< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_ascending< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_by< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 > < dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / p > < / li >
< li > < p > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / p > < / li >
< li > < p > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < 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 > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< li > < p > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < 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 >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L3VpnListResult< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3vpn_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3_vpn< / span > < / 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 > < dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.showsensitivedata" >
< code class = "sig-name descname" > showsensitivedata< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3vpn_id< / span > < / 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 > < dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < 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 >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L3Vpn< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.L3vpns.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3vpn_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > l3_vpn< / span > < / 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 > < dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-06-05 18:48:31 -04:00
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > l3vpn_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-even" > < p > < 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 >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-06-05 18:48:31 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.L3Vpn< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > Multicast< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read Multicast Configuration.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_services_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
2020-09-21 16:47:14 -04:00
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyMulticastConfig" title = "com.vmware.nsx_policy.model_client.PolicyMulticastConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyMulticastConfig< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyMulticastConfig< / p >
< / dd >
2020-01-27 14:28:46 -05:00
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_multicast_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create or update a Tier-0 multicast configuration defining the
multicast replication range, the IGMP or a PIM profile. It will update
the configuration if there is already one in place.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_services_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > policy_multicast_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyMulticastConfig" title = "com.vmware.nsx_policy.model_client.PolicyMulticastConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyMulticastConfig< / span > < / code > < / a > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_multicast_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.locale_services_client.Multicast.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create or update a Tier-0 multicast configuration defining the
multicast replication range, the IGMP or a PIM profile. It will update
the configuration if there is already one in place.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_services_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > policy_multicast_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyMulticastConfig" title = "com.vmware.nsx_policy.model_client.PolicyMulticastConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyMulticastConfig< / span > < / code > < / a > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyMulticastConfig" title = "com.vmware.nsx_policy.model_client.PolicyMulticastConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyMulticastConfig< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyMulticastConfig< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > ServiceInterfaces< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.ServiceInterface< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > cursor< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > include_mark_for_delete_objects< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > included_fields< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > page_size< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_ascending< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_by< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< li > < p > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / p > < / li >
< li > < p > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / p > < / li >
< li > < p > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / p > < / li >
< li > < p > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < 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 >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.ServiceInterfaceListResult< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_interface< / span > < / 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 >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.ServiceInterfaces.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_interface< / span > < / 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 >
< dl class = "field-list simple" >
2020-01-27 14:28:46 -05:00
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > locale_service_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
2020-09-21 16:47:14 -04:00
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.ServiceInterface< / p >
< / dd >
2020-01-27 14:28:46 -05:00
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.locale_services_client.StubFactory" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.locale_services_client.< / code > < code class = "sig-name descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > stub_config< / span > < / 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
< / dd > < / dl >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_0s.static_routes_client" >
< span id = "com-vmware-nsx-policy-infra-tier-0s-static-routes-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_0s.static_routes_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_0s.static_routes_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.static_routes_client.< / code > < code class = "sig-name descname" > BfdPeers< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers" 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > bfd_peer_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete this StaticRouteBfdPeer and all the entities contained by it.< / p >
2020-01-27 14:28:46 -05:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2020-09-21 16:47:14 -04:00
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > bfd_peer_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > bfd_peer_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read a StaticRouteBfdPeer with the bfd-peer-id.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > bfd_peer_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" title = "com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticRouteBfdPeer< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
2020-09-21 16:47:14 -04:00
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.StaticRouteBfdPeer< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > cursor< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > include_mark_for_delete_objects< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > included_fields< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > page_size< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_ascending< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > sort_by< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Paginated list of all StaticRouteBfdPeers.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / p > < / li >
< li > < p > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / p > < / li >
< li > < p > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / p > < / li >
< li > < p > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< li > < p > < 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticRouteBfdPeerListResult" title = "com.vmware.nsx_policy.model_client.StaticRouteBfdPeerListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticRouteBfdPeerListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.StaticRouteBfdPeerListResult< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > bfd_peer_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > static_route_bfd_peer< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If a StaticRouteBfdPeer with the bfd-peer-id is not already present,
create a new StaticRouteBfdPeer. If it already exists, update the
StaticRouteBfdPeer. This is a full replace.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > bfd_peer_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > static_route_bfd_peer< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" title = "com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticRouteBfdPeer< / span > < / code > < / a > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py method" >
< dt id = "com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier0_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > bfd_peer_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > static_route_bfd_peer< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.static_routes_client.BfdPeers.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If a StaticRouteBfdPeer with the bfd-peer-id is not already present,
create a new StaticRouteBfdPeer. If it already exists, update the
StaticRouteBfdPeer. This operation will fully replace the object.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier0_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > bfd_peer_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > static_route_bfd_peer< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" title = "com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticRouteBfdPeer< / span > < / code > < / a > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Return type< / dt >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" title = "com.vmware.nsx_policy.model_client.StaticRouteBfdPeer" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticRouteBfdPeer< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.StaticRouteBfdPeer< / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < 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 >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < 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 >
< / dd >
< dt class = "field-odd" > Raise< / dt >
< dd class = "field-odd" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_0s.static_routes_client.StubFactory" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_0s.static_routes_client.< / code > < code class = "sig-name descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > stub_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_0s.static_routes_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-05-29 14:05:24 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < p > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / p >
< / dd >
< / dl >
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2020-01-27 14:28:46 -05:00
< a href = "com.vmware.nsx_policy.infra.tier_0s.groups.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.infra.tier_0s.groups package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2019-05-29 14:05:24 -04:00
2020-09-21 16:47:14 -04:00
< a href = "com.vmware.nsx_policy.infra.tags.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx_policy.infra.tags package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2019-05-29 14:05:24 -04:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
© Copyright 2020, VMware, Inc.
2019-05-29 14:05:24 -04:00
< / p >
< / div >
2020-09-21 16:47:14 -04:00
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 > .
2019-05-29 14:05:24 -04:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
