2020-01-27 14:28:46 -05:00
<!DOCTYPE html>
2021-03-31 18:40:01 -04:00
< html class = "writer-html4" lang = "en" >
2020-01-27 14:28:46 -05:00
< head >
2021-03-31 18:40:01 -04:00
< meta charset = "utf-8" / >
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
< title > com.vmware.nsx_policy.infra.tier_1s.segments package — NSX-T Policy API 3.0.3.0.0 documentation< / title >
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
2020-09-21 16:47:14 -04:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2020-01-27 14:28:46 -05:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
2021-03-31 18:40:01 -04:00
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/language_data.js" > < / script >
2020-01-27 14:28:46 -05:00
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "prev" title = "com.vmware.nsx_policy.infra.tier_1s.nat package" href = "com.vmware.nsx_policy.infra.tier_1s.nat.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2021-03-31 18:40:01 -04:00
< a href = "index.html" class = "icon icon-home" > NSX-T Policy API
2020-01-27 14:28:46 -05:00
< / a >
< div class = "version" >
2021-03-31 18:40:01 -04:00
3.0.3.0.0
2020-01-27 14:28:46 -05:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "com.html" > com package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "com.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "com.vmware.html" > com.vmware package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "com.vmware.html#subpackages" > Subpackages< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client" > com.vmware.nsx_policy_client module< / a > < / li >
2020-06-05 18:48:31 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module" > com.vmware.nsx_policy_client_for_vmc module< / a > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
2020-09-21 16:47:14 -04:00
2020-01-27 14:28:46 -05:00
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > NSX-T Policy API< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
2020-09-21 16:47:14 -04:00
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
2020-01-27 14:28:46 -05:00
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.html" > com.vmware.nsx_policy.infra package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.tier_1s.html" > com.vmware.nsx_policy.infra.tier_1s package< / a > » < / li >
< li > com.vmware.nsx_policy.infra.tier_1s.segments package< / li >
< li class = "wy-breadcrumbs-aside" >
2021-03-31 18:40:01 -04:00
2020-01-27 14:28:46 -05:00
< a href = "_sources/com.vmware.nsx_policy.infra.tier_1s.segments.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.segments" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-segments-package" > < / span > < h1 > com.vmware.nsx_policy.infra.tier_1s.segments package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.segments" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-09-21 16:47:14 -04:00
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-segments-dhcp-static-bindings-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.State" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.< / code > < code class = "descname" > State< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.State" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.State.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > binding_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.State.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Read DHCP static binding state< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > binding_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DhcpStaticBindingState" title = "com.vmware.nsx_policy.model_client.DhcpStaticBindingState" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.DhcpStaticBindingState< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.DhcpStaticBindingState< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.dhcp_static_bindings_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-segments-inter-site-forwarder-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.SiteSpanInfo" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.< / code > < code class = "descname" > SiteSpanInfo< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.SiteSpanInfo" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.SiteSpanInfo.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > cursor=None< / em > , < em > edge_path=None< / em > , < em > enforcement_point_path=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.SiteSpanInfo.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get segment cross site forwarder placement and HA statuss.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / li >
< li > < strong > edge_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > enforcement_point_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / li >
< li > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentL2ForwarderSiteSpanInfo" title = "com.vmware.nsx_policy.model_client.SegmentL2ForwarderSiteSpanInfo" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentL2ForwarderSiteSpanInfo< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.SegmentL2ForwarderSiteSpanInfo< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.Status" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.< / code > < code class = "descname" > Status< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.Status" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.Status.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > cursor=None< / em > , < em > edge_path=None< / em > , < em > enforcement_point_path=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.Status.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get segment cross site traffic statistics.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / li >
< li > < strong > edge_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > enforcement_point_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / li >
< li > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
2020-09-21 16:47:14 -04:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentCrossSiteTrafficStats" title = "com.vmware.nsx_policy.model_client.SegmentCrossSiteTrafficStats" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentCrossSiteTrafficStats< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.SegmentCrossSiteTrafficStats< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-09-21 16:47:14 -04:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-09-21 16:47:14 -04:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-09-21 16:47:14 -04:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-09-21 16:47:14 -04:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-09-21 16:47:14 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.inter_site_forwarder_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
2020-01-27 14:28:46 -05:00
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.tier_1s.segments.ports_client" >
< span id = "com-vmware-nsx-policy-infra-tier-1s-segments-ports-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.tier_1s.segments.ports_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.tier_1s.segments.ports_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.< / code > < code class = "descname" > PortMonitoringProfileBindingMaps< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > port_id< / em > , < em > port_monitoring_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will delete Port Monitoring Profile Binding Profile.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > port_id< / em > , < em > port_monitoring_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will get Port Monitoring Profile Binding Map.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.PortMonitoringProfileBindingMap< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > port_id< / em > , < em > cursor=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will list all Port Monitoring Profile Binding Maps in current port
id.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / li >
< li > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / li >
< li > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMapListResult" title = "com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMapListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMapListResult< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.PortMonitoringProfileBindingMapListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > port_id< / em > , < em > port_monitoring_profile_binding_map_id< / em > , < em > port_monitoring_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will create Port Monitoring Profile Binding Map.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_monitoring_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap< / span > < / code > < / a > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segment_id< / em > , < em > port_id< / em > , < em > port_monitoring_profile_binding_map_id< / em > , < em > port_monitoring_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.PortMonitoringProfileBindingMaps.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will update Port Monitoring Profile Binding Map.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segment_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_monitoring_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap< / span > < / code > < / a > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMonitoringProfileBindingMap< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.PortMonitoringProfileBindingMap< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.Statistics" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.< / code > < code class = "descname" > Statistics< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.Statistics" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.Statistics.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > tier1_id< / em > , < em > segments_id< / em > , < em > port_id< / em > , < em > cursor=None< / em > , < em > edge_path=None< / em > , < em > enforcement_point_path=None< / em > , < em > include_mark_for_delete_objects=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.Statistics.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get tier-1 segment port statistics information.< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < ul class = "first simple" >
< li > < strong > tier1_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > segments_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > port_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
by current result page) (optional)< / li >
< li > < strong > edge_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > enforcement_point_path< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > include_mark_for_delete_objects< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
default to false)< / li >
< li > < strong > included_fields< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) –
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – < / li >
2020-01-27 14:28:46 -05:00
< / ul >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.SegmentPortStatistics" title = "com.vmware.nsx_policy.model_client.SegmentPortStatistics" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SegmentPortStatistics< / span > < / code > < / a > < / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Returns:< / th > < td class = "field-body" > < p class = "first" > com.vmware.nsx_policy.model.SegmentPortStatistics< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2020-01-27 14:28:46 -05:00
Service Unavailable< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
2020-01-27 14:28:46 -05:00
Bad Request, Precondition Failed< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2020-01-27 14:28:46 -05:00
Internal Server Error< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
2020-01-27 14:28:46 -05:00
Forbidden< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2020-01-27 14:28:46 -05:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "class" >
2020-01-27 14:28:46 -05:00
< dt id = "com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.< / code > < code class = "descname" > StubFactory< / code > < span class = "sig-paren" > (< / span > < em > stub_config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.tier_1s.segments.ports_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
< p > Initialize StubFactoryBase< / p >
2021-03-31 18:40:01 -04:00
< table class = "docutils field-list" frame = "void" rules = "none" >
< col class = "field-name" / >
< col class = "field-body" / >
< tbody valign = "top" >
< tr class = "field-odd field" > < th class = "field-name" > Parameters:< / th > < td class = "field-body" > < strong > stub_config< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubConfiguration< / span > < / code > ) – < / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2021-03-31 18:40:01 -04:00
< a href = "com.vmware.nsx_policy.infra.tier_1s.nat.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx_policy.infra.tier_1s.nat package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2020-01-27 14:28:46 -05:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2021-03-31 18:40:01 -04:00
© Copyright 2021, VMware, Inc..
2020-01-27 14:28:46 -05:00
< / p >
< / div >
2020-09-21 16:47:14 -04:00
2021-03-31 18:40:01 -04:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
2020-09-21 16:47:14 -04:00
2021-03-31 18:40:01 -04:00
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
2020-09-21 16:47:14 -04:00
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2020-01-27 14:28:46 -05:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
