2019-05-29 14:05:24 -04:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2020-06-05 18:48:31 -04:00
< title > com.vmware.nsx_policy.infra.tier_1s package — NSX-T Policy API 2.5.1.0.5 documentation< / title >
2019-05-29 14:05:24 -04:00
< script type = "text/javascript" src = "_static/js/modernizr.min.js" > < / script >
< 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 = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2020-01-27 14:28:46 -05:00
< link rel = "next" title = "com.vmware.nsx_policy.infra.tier_1s.locale_services package" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.html" / >
2020-06-05 18:48:31 -04:00
< link rel = "prev" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services package" href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.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" >
< a href = "index.html" class = "icon icon-home" > NSX-T Policy API
< / a >
< div class = "version" >
2020-06-05 18:48:31 -04:00
2.5.1.0.5
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 >
< 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 >
< / 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" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.html" > com.vmware.nsx_policy.infra package< / a > » < / li >
< li > com.vmware.nsx_policy.infra.tier_1s package< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/com.vmware.nsx_policy.infra.tier_1s.rst.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-package" > < / span > < h1 > com.vmware.nsx_policy.infra.tier_1s package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-01-27 14:28:46 -05:00
< div class = "section" id = "subpackages" >
< h2 > Subpackages< a class = "headerlink" href = "#subpackages" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.html" > com.vmware.nsx_policy.infra.tier_1s.locale_services package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.html#subpackages" > Subpackages< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.html" > com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services package< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.sessions_client" > com.vmware.nsx_policy.infra.tier_1s.locale_services.ipsec_vpn_services.sessions_client module< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client" > com.vmware.nsx_policy.infra.tier_1s.locale_services.interfaces_client module< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.locale_services.html#module-com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client" > com.vmware.nsx_policy.infra.tier_1s.locale_services.service_instances_client module< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.nat.html" > com.vmware.nsx_policy.infra.tier_1s.nat package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.nat.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.nat.html#module-com.vmware.nsx_policy.infra.tier_1s.nat.nat_rules_client" > com.vmware.nsx_policy.infra.tier_1s.nat.nat_rules_client module< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.segments.html" > com.vmware.nsx_policy.infra.tier_1s.segments package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.segments.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.tier_1s.segments.html#module-com.vmware.nsx_policy.infra.tier_1s.segments.ports_client" > com.vmware.nsx_policy.infra.tier_1s.segments.ports_client module< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
2019-05-29 14:05:24 -04:00
< 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_1s.dns_forwarder_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-dns-forwarder-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.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_1s.dns_forwarder_client.Nslookup" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.< / code > < code class = "sig-name descname" > Nslookup< / 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_1s.dns_forwarder_client.Nslookup" 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-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.dns_forwarder_client.Nslookup.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" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > address< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / 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_1s.dns_forwarder_client.Nslookup.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Query the nameserver for an ip-address or a FQDN of the given an
address optionally using an specified DNS server. If the address is a
fqdn, nslookup will resolve ip-address with it. If the address is an
ip-address, do a reverse lookup and answer fqdn(s). If enforcement
point is specified, then DNS forwarder nslookup answer will get fetched
from specified enforcement point. Otherwise from all enforcement
points.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > address< / 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 >
< 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 >
< / 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.AggregatePolicyDnsAnswer" title = "com.vmware.nsx_policy.model_client.AggregatePolicyDnsAnswer" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.AggregatePolicyDnsAnswer< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.AggregatePolicyDnsAnswer< / 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 >
< / 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_1s.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_1s.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_1s.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 >
< 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_1s.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" > tier1_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_1s.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-1 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 >
< / 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.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 >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.AggregateDNSForwarderStatistics< / 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 >
< / 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_1s.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_1s.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_1s.dns_forwarder_client.Status" 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-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.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" > tier1_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_1s.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-1 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 >
< / 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.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 >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.AggregateDNSForwarderStatus< / 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 >
< / 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_1s.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_1s.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_1s.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_1s.locale_services_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-locale-services-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.locale_services_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.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_1s.locale_services_client.GatewayFirewall" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services_client.< / code > < code class = "sig-name descname" > GatewayFirewall< / 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_1s.locale_services_client.GatewayFirewall" 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-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services_client.GatewayFirewall.list" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_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_1s.locale_services_client.GatewayFirewall.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get filtered view of Gateway Firewall rules associated with the Tier-1
Locale Services. The gateway policies are returned in the order of
category and sequence number.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 >
< / 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.GatewayPolicyListResult" title = "com.vmware.nsx_policy.model_client.GatewayPolicyListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GatewayPolicyListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.GatewayPolicyListResult< / 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 >
< / 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_1s.locale_services_client.Interfaces" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.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_1s.locale_services_client.Interfaces" 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-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.delete" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_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_1s.locale_services_client.Interfaces.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete Tier-1 interface< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 > 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 >
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_1s.locale_services_client.Interfaces.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" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_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_1s.locale_services_client.Interfaces.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read Tier-1 interface< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 > 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.Tier1Interface" title = "com.vmware.nsx_policy.model_client.Tier1Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier1Interface< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Tier1Interface< / 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 >
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_1s.locale_services_client.Interfaces.list" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_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_1s.locale_services_client.Interfaces.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Paginated list of all Tier-1 interfaces< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 > 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.Tier1InterfaceListResult" title = "com.vmware.nsx_policy.model_client.Tier1InterfaceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier1InterfaceListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Tier1InterfaceListResult< / 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 >
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_1s.locale_services_client.Interfaces.patch" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > tier1_interface< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > tier1_interface< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier1Interface" title = "com.vmware.nsx_policy.model_client.Tier1Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier1Interface< / 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 >
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_1s.locale_services_client.Interfaces.update" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_services_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > interface_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > tier1_interface< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.Interfaces.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< 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 >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 > interface_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > tier1_interface< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Tier1Interface" title = "com.vmware.nsx_policy.model_client.Tier1Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier1Interface< / 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.Tier1Interface" title = "com.vmware.nsx_policy.model_client.Tier1Interface" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Tier1Interface< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Tier1Interface< / 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 >
< / 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_1s.locale_services_client.ServiceInstances" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.locale_services_client.< / code > < code class = "sig-name descname" > ServiceInstances< / 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_1s.locale_services_client.ServiceInstances" 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-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.delete" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_instance_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete Tier1 policy service instance< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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_instance_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 >
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_1s.locale_services_client.ServiceInstances.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" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_instance_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read Tier1 service instance< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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_instance_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.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyServiceInstance< / 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 >
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_1s.locale_services_client.ServiceInstances.list" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_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_1s.locale_services_client.ServiceInstances.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read all service instance objects under a tier-1< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyServiceInstanceListResult< / 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 >
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_1s.locale_services_client.ServiceInstances.patch" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_instance_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_service_instance< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create Tier1 Service Instance. Please note that, only display_name,
description and deployment_spec_name are allowed to be modified in an
exisiting entity. If the deployment spec name is changed, it will
trigger the upgrade operation for the SVMs.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > policy_service_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / span > < / code > < / a > ) – < / 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_1s.locale_services_client.ServiceInstances.update" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > locale_service_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > service_instance_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_service_instance< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.locale_services_client.ServiceInstances.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create Tier1 service instance. Please note that, only display_name,
description and deployment_spec_name are allowed to be modified in an
exisiting entity. If the deployment spec name is changed, it will
trigger the upgrade operation for the SVMs.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > policy_service_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / span > < / code > < / a > ) – < / 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.PolicyServiceInstance" title = "com.vmware.nsx_policy.model_client.PolicyServiceInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyServiceInstance< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyServiceInstance< / 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 >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_1s.locale_services_client.StubFactory" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.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_1s.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_1s.nat_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-nat-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.nat_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.nat_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.nat_client.< / code > < code class = "sig-name descname" > NatRules< / 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_1s.nat_client.NatRules" 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_1s.nat_client.NatRules.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_rule_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by < nat-id> . Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.< / 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-06-05 18:48:31 -04:00
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_rule_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_1s.nat_client.NatRules.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_rule_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by < nat-id> . Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.< / 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-06-05 18:48:31 -04:00
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_rule_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.PolicyNatRule" title = "com.vmware.nsx_policy.model_client.PolicyNatRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyNatRule< / 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.PolicyNatRule< / 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_1s.nat_client.NatRules.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_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_1s.nat_client.NatRules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by < nat-id> . Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.< / 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-06-05 18:48:31 -04:00
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_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 >
2020-01-27 14:28:46 -05: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.PolicyNatRuleListResult" title = "com.vmware.nsx_policy.model_client.PolicyNatRuleListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyNatRuleListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyNatRuleListResult< / 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" >
< dt id = "com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_rule_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_nat_rule< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > If a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID,
under NAT section denoted by < nat-id> , create a new NAT Rule. If it
already exists, update the NAT Rule. Under tier-1 there will be 3
different NATs(sections). (INTERNAL, USER and DEFAULT) For more details
related to NAT section please refer to PolicyNAT schema.< / 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-06-05 18:48:31 -04:00
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > policy_nat_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyNatRule" title = "com.vmware.nsx_policy.model_client.PolicyNatRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyNatRule< / 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_1s.nat_client.NatRules.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > nat_rule_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > policy_nat_rule< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.nat_client.NatRules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Update NAT Rule on Tier-1 denoted by Tier-1 ID, under NAT section
2020-01-27 14:28:46 -05:00
denoted by < nat-id> . Under tier-1 there will be 3 different
NATs(sections). (INTERNAL, USER and DEFAULT) For more details related
to NAT section please refer to PolicyNAT schema.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > nat_rule_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 > policy_nat_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyNatRule" title = "com.vmware.nsx_policy.model_client.PolicyNatRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyNatRule< / span > < / code > < / a > ) – < / p > < / li >
2020-01-27 14:28:46 -05: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.PolicyNatRule" title = "com.vmware.nsx_policy.model_client.PolicyNatRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyNatRule< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyNatRule< / 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_1s.nat_client.Statistics" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.nat_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_1s.nat_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2020-01-27 14:28:46 -05:00
< 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_1s.nat_client.Statistics.list" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_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" > enforcement_point_path< / 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_1s.nat_client.Statistics.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List NAT Rules Statistics from Tier-1 denoted by Tier-1 ID.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_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 > 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 >
< 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.PolicyNatRuleStatisticsPerLogicalRouterListResult" title = "com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerLogicalRouterListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyNatRuleStatisticsPerLogicalRouterListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PolicyNatRuleStatisticsPerLogicalRouterListResult< / 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 >
< / 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_1s.nat_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_1s.nat_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_1s.nat_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_1s.segments_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-segments-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.segments_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.segments_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_1s.segments_client.Ports" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments_client.< / code > < code class = "sig-name descname" > Ports< / 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_1s.segments_client.Ports" 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-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.delete" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > port_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete a Tier-1 segment port by giving ID.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_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 >
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_1s.segments_client.Ports.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" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > port_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get detail information on a Tier-1 segment port by giving ID.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_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.SegmentPort" title = "com.vmware.nsx_policy.model_client.SegmentPort" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentPort< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.SegmentPort< / 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 >
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_1s.segments_client.Ports.list" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_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_1s.segments_client.Ports.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List all the ports for a Tier-1 segment.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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.SegmentPortListResult" title = "com.vmware.nsx_policy.model_client.SegmentPortListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentPortListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.SegmentPortListResult< / 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 >
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_1s.segments_client.Ports.patch" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > port_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_port< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a Tier-1 segment port if it does not exist based on the IDs, or
update existing port information by replacing the port object fields
which presents in the request body.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_port< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentPort" title = "com.vmware.nsx_policy.model_client.SegmentPort" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentPort< / 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 >
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_1s.segments_client.Ports.update" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > port_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_port< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.Ports.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a Tier-1 segment port if it does not exist based on the IDs, or
update existing port information by replacing the port object already
exists.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_port< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentPort" title = "com.vmware.nsx_policy.model_client.SegmentPort" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentPort< / 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.SegmentPort" title = "com.vmware.nsx_policy.model_client.SegmentPort" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentPort< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.SegmentPort< / 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 >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments_client.< / code > < code class = "sig-name descname" > SegmentMonitoringProfileBindingMaps< / 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_1s.segments_client.SegmentMonitoringProfileBindingMaps" 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_1s.segments_client.SegmentMonitoringProfileBindingMaps.delete" >
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_monitoring_profile_binding_map_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will delete Segment Monitoring Profile Binding Profile.< / 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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 > segment_monitoring_profile_binding_map_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_1s.segments_client.SegmentMonitoringProfileBindingMaps.get" >
< code class = "sig-name descname" > get< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_monitoring_profile_binding_map_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will get Segment Monitoring Profile Binding Map.< / 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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 > segment_monitoring_profile_binding_map_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.SegmentMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap< / 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.SegmentMonitoringProfileBindingMap< / 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_1s.segments_client.SegmentMonitoringProfileBindingMaps.list" >
< code class = "sig-name descname" > list< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_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_1s.segments_client.SegmentMonitoringProfileBindingMaps.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will list all Segment Monitoring Profile Binding Maps in current
2020-01-27 14:28:46 -05:00
segment id.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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.SegmentMonitoringProfileBindingMapListResult" title = "com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMapListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMapListResult< / 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.SegmentMonitoringProfileBindingMapListResult< / 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_1s.segments_client.SegmentMonitoringProfileBindingMaps.patch" >
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_monitoring_profile_binding_map_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_monitoring_profile_binding_map< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will create segment monitoring profile binding map.< / 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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 > segment_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_monitoring_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap< / 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_1s.segments_client.SegmentMonitoringProfileBindingMaps.update" >
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_monitoring_profile_binding_map_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_monitoring_profile_binding_map< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.SegmentMonitoringProfileBindingMaps.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will update Segment Monitoring Profile Binding Map.< / 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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 > segment_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_monitoring_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap< / 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.SegmentMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentMonitoringProfileBindingMap< / span > < / code > < / a > < / p >
2020-01-27 14:28:46 -05:00
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.SegmentMonitoringProfileBindingMap< / 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 >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2019-05-29 14:05:24 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp" >
2020-06-05 18:48:31 -04:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments_client.< / code > < code class = "sig-name descname" > StaticArp< / 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_1s.segments_client.StaticArp" 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" >
2019-05-29 14:05:24 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.delete" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > delete< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-05-29 14:05:24 -04:00
< dd > < p > Delete static ARP config< / p >
< 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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" > 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" >
2019-05-29 14:05:24 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.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" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2019-05-29 14:05:24 -04:00
< dd > < p > Read static ARP config< / p >
< 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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 >
< dd class = "field-even" > < p > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticARPConfig" title = "com.vmware.nsx_policy.model_client.StaticARPConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticARPConfig< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.StaticARPConfig< / 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 >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2019-05-29 14:05:24 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.patch" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > patch< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > static_arp_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create static ARP config with Tier-1 and segment IDs provided if it
2019-05-29 14:05:24 -04:00
doesn’ ’ < / p >
< 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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 > static_arp_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticARPConfig" title = "com.vmware.nsx_policy.model_client.StaticARPConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticARPConfig< / 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 >
2020-06-05 18:48:31 -04:00
< dl class = "py method" >
2019-05-29 14:05:24 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.update" >
2020-06-05 18:48:31 -04:00
< code class = "sig-name descname" > update< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segment_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > static_arp_config< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments_client.StaticArp.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create static ARP config with Tier-1 and segment IDs provided if it
2019-05-29 14:05:24 -04:00
doesn’ ’ < / p >
< 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 > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segment_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 > static_arp_config< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.StaticARPConfig" title = "com.vmware.nsx_policy.model_client.StaticARPConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticARPConfig< / 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.StaticARPConfig" title = "com.vmware.nsx_policy.model_client.StaticARPConfig" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.StaticARPConfig< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.StaticARPConfig< / 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 >
< / 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_1s.segments_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_1s.segments_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_1s.segments_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 >
< 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_1s.segments_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" > tier1_id< / span > < / em > , < em class = "sig-param" > < span class = "n" > segments_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" > edge_path< / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > enforcement_point_path< / 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_1s.segments_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get tier1 segment statistics information.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > segments_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 > edge_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / 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 >
< 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.SegmentStatistics" title = "com.vmware.nsx_policy.model_client.SegmentStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentStatistics< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.SegmentStatistics< / 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 >
< / dd > < / dl >
2020-06-05 18:48:31 -04:00
< dl class = "py class" >
2019-05-29 14:05:24 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments_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_1s.segments_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_1s.segments_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_1s.locale_services.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.infra.tier_1s.locale_services package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2019-05-29 14:05:24 -04:00
2020-06-05 18:48:31 -04:00
< a href = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_services 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-01-27 14:28:46 -05:00
© Copyright 2020, VMware, Inc.
2019-05-29 14:05:24 -04:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
