2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2019-05-29 14:05:24 -04:00
< title > com.vmware.nsx_policy.infra.domains package — NSX-T Policy SDK 2.3.0.0.3 documentation< / title >
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04:00
< script type = "text/javascript" src = "_static/js/modernizr.min.js" > < / script >
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/language_data.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04:00
2018-08-07 19:42:25 -04:00
2019-05-29 14:05:24 -04:00
2018-11-01 14:01:54 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
2018-08-07 19:42:25 -04:00
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "com.vmware.nsx_policy.infra.domains.groups package" href = "com.vmware.nsx_policy.infra.domains.groups.html" / >
< link rel = "prev" title = "com.vmware.nsx_policy.infra package" href = "com.vmware.nsx_policy.infra.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" >
2019-05-29 14:05:24 -04:00
< div class = "wy-side-nav-search" >
2018-08-07 19:42:25 -04:00
< a href = "index.html" class = "icon icon-home" > NSX-T Policy SDK
< / a >
< div class = "version" >
2019-05-29 14:05:24 -04:00
2.3.0.0.3
2018-08-07 19:42:25 -04:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "com.html" > com package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "com.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "com.vmware.html" > com.vmware package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "com.vmware.html#subpackages" > Subpackages< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client" > com.vmware.nsx_policy_client module< / a > < / li >
2018-11-01 14:01:54 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client_for_vmc" > com.vmware.nsx_policy_client_for_vmc module< / a > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > NSX-T Policy SDK< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.infra.html" > com.vmware.nsx_policy.infra package< / a > » < / li >
< li > com.vmware.nsx_policy.infra.domains package< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/com.vmware.nsx_policy.infra.domains.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.domains" >
< span id = "com-vmware-nsx-policy-infra-domains-package" > < / span > < h1 > com.vmware.nsx_policy.infra.domains package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.domains" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "subpackages" >
< h2 > Subpackages< a class = "headerlink" href = "#subpackages" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.domains.groups.html" > com.vmware.nsx_policy.infra.domains.groups package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.domains.groups.html#submodules" > Submodules< / a > < / li >
2018-11-01 14:01:54 -04:00
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.domains.groups.html#module-com.vmware.nsx_policy.infra.domains.groups.members_client" > com.vmware.nsx_policy.infra.domains.groups.members_client module< / a > < / li >
2018-08-07 19:42:25 -04:00
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.infra.domains.groups.html#module-com.vmware.nsx_policy.infra.domains.groups.statistics_client" > com.vmware.nsx_policy.infra.domains.groups.statistics_client module< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.domains.communication_maps_client" >
< span id = "com-vmware-nsx-policy-infra-domains-communication-maps-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.domains.communication_maps_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.domains.communication_maps_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.domains.communication_maps_client.< / code > < code class = "descname" > CommunicationEntries< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries" 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 >
2019-05-29 14:05:24 -04: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 >
2018-08-07 19:42:25 -04:00
< dl class = "attribute" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_AFTER" >
< code class = "descname" > REVISE_OPERATION_AFTER< / code > < em class = "property" > = 'insert_after'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_AFTER" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > operation< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > CommunicationEntries.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BEFORE" >
< code class = "descname" > REVISE_OPERATION_BEFORE< / code > < em class = "property" > = 'insert_before'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BEFORE" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > operation< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > CommunicationEntries.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BOTTOM" >
< code class = "descname" > REVISE_OPERATION_BOTTOM< / code > < em class = "property" > = 'insert_bottom'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BOTTOM" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > operation< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > CommunicationEntries.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
< dl class = "attribute" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_TOP" >
< code class = "descname" > REVISE_OPERATION_TOP< / code > < em class = "property" > = 'insert_top'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_TOP" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > operation< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > CommunicationEntries.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > communication_map_id< / em > , < em > communication_entry_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete CommunicationEntry< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > communication_map_id< / em > , < em > communication_entry_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read CommunicationEntry< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.CommunicationEntry" title = "com.vmware.nsx_policy.model_client.CommunicationEntry" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.CommunicationEntry< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.CommunicationEntry< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.list" >
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > communication_map_id< / em > , < em > cursor=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > List CommunicationEntries< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_map_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 > 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 >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.CommunicationEntryListResult" title = "com.vmware.nsx_policy.model_client.CommunicationEntryListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.CommunicationEntryListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.CommunicationEntryListResult< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > communication_map_id< / em > , < em > communication_entry_id< / em > , < em > communication_entry< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Patch the CommunicationEntry.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title = "com.vmware.nsx_policy.model_client.CommunicationEntry" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.CommunicationEntry< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" >
< code class = "descname" > revise< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > communication_map_id< / em > , < em > communication_entry_id< / em > , < em > communication_entry< / em > , < em > anchor_path=None< / em > , < em > operation=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > This is used to re-order a communictation entry within a communication
map.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title = "com.vmware.nsx_policy.model_client.CommunicationEntry" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.CommunicationEntry< / span > < / code > < / a > ) – < / p > < / li >
< li > < p > < strong > anchor_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 > operation< / 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 >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.CommunicationEntry" title = "com.vmware.nsx_policy.model_client.CommunicationEntry" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.CommunicationEntry< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.CommunicationEntry< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > communication_map_id< / em > , < em > communication_entry_id< / em > , < em > communication_entry< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Update the CommunicationEntry. If a CommunicationEntry with the
communication-entry-id is not already present, this API fails with a
404. Creation of CommunicationEntries is not allowed using this API.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > communication_entry< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title = "com.vmware.nsx_policy.model_client.CommunicationEntry" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.CommunicationEntry< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.CommunicationEntry" title = "com.vmware.nsx_policy.model_client.CommunicationEntry" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.CommunicationEntry< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.CommunicationEntry< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.domains.communication_maps_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.domains.communication_maps_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.domains.communication_maps_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 >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
2019-05-29 14:05:24 -04:00
< 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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
2018-11-01 14:01:54 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.infra.domains.gateway_policies_client" >
< span id = "com-vmware-nsx-policy-infra-domains-gateway-policies-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.domains.gateway_policies_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.domains.gateway_policies_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
2018-08-07 19:42:25 -04:00
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.domains.gateway_policies_client.< / code > < code class = "descname" > Rules< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.VapiInterface< / span > < / code > < / p >
2019-05-29 14:05:24 -04: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 >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Delete Rule< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Read rule< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.Rule" title = "com.vmware.nsx_policy.model_client.Rule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Rule< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Rule< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.list" >
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_id< / em > , < em > cursor=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > List Rules< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > gateway_policy_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 > 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 >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.RuleListResult" title = "com.vmware.nsx_policy.model_client.RuleListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.RuleListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.RuleListResult< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_id< / em > , < em > rule_id< / em > , < em > rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Update the gateway rule. If a rule with the rule-id is not already
present, then create new rule.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title = "com.vmware.nsx_policy.model_client.Rule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Rule< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_id< / em > , < em > rule_id< / em > , < em > rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Update the gateway rule. If a rule with the rule-id is not already
present, create new rule.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title = "com.vmware.nsx_policy.model_client.Rule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Rule< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.Rule" title = "com.vmware.nsx_policy.model_client.Rule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.Rule< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.Rule< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
2018-11-01 14:01:54 -04:00
< dt id = "com.vmware.nsx_policy.infra.domains.gateway_policies_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.domains.gateway_policies_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.domains.gateway_policies_client.StubFactory" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > vmware.vapi.bindings.stub.StubFactoryBase< / span > < / code > < / p >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
2019-05-29 14:05:24 -04:00
< 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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.infra.domains.groups_client" >
< span id = "com-vmware-nsx-policy-infra-domains-groups-client-module" > < / span > < h2 > com.vmware.nsx_policy.infra.domains.groups_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.infra.domains.groups_client" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.domains.groups_client.< / code > < code class = "descname" > PortMirroringInstances< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances" 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 >
2019-05-29 14:05:24 -04: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 >
2018-08-07 19:42:25 -04:00
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.delete" >
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > port_mirroring_instance_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will delete port mirroring instance. Mirroring from source to
destination ports will be stopped.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.get" >
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > port_mirroring_instance_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.get" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will return details of port mirroring instance. If instance does
not exist, it will return 404.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.PortMirroringInstance" title = "com.vmware.nsx_policy.model_client.PortMirroringInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMirroringInstance< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PortMirroringInstance< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.list" >
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > cursor=None< / em > , < em > included_fields=None< / em > , < em > page_size=None< / em > , < em > sort_ascending=None< / em > , < em > sort_by=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.list" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > API will list all port mirroring instances active on current group.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > group_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 > 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 >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.PortMirroringInstanceListResult" title = "com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PortMirroringInstanceListResult< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.patch" >
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > port_mirroring_instance_id< / em > , < em > port_mirroring_instance< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create a new Port Mirroring Instance if the Port Mirroring Instance
with given id does not already exist. If the Port Mirroring Instance
with the given id already exists, patch with the existing Port
Mirroring Instance.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_mirroring_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMirroringInstance" title = "com.vmware.nsx_policy.model_client.PortMirroringInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMirroringInstance< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< dl class = "method" >
< dt id = "com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.update" >
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > port_mirroring_instance_id< / em > , < em > port_mirroring_instance< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.update" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Create or Replace port mirroring instance. Packets will be mirrored
from source group to destination group.< / p >
2019-05-29 14:05:24 -04:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – < / p > < / li >
< li > < p > < strong > port_mirroring_instance< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMirroringInstance" title = "com.vmware.nsx_policy.model_client.PortMirroringInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMirroringInstance< / span > < / code > < / a > ) – < / p > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
2019-05-29 14:05:24 -04:00
< / 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.PortMirroringInstance" title = "com.vmware.nsx_policy.model_client.PortMirroringInstance" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PortMirroringInstance< / span > < / code > < / a > < / p >
< / dd >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > com.vmware.nsx_policy.model.PortMirroringInstance< / 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 >
2018-08-07 19:42:25 -04:00
Service Unavailable< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
2018-08-07 19:42:25 -04:00
Internal Server Error< / p >
2019-05-29 14:05:24 -04:00
< / 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 >
2018-08-07 19:42:25 -04:00
Forbidden< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< dt class = "field-even" > Raise< / dt >
< dd class = "field-even" > < p > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2019-05-29 14:05:24 -04:00
< / dd >
< / dl >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / dd > < / dl >
< dl class = "class" >
< dt id = "com.vmware.nsx_policy.infra.domains.groups_client.StubFactory" >
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.infra.domains.groups_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.domains.groups_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 >
2018-11-01 14:01:54 -04:00
< p > Initialize StubFactoryBase< / p >
2019-05-29 14:05:24 -04:00
< 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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "com.vmware.nsx_policy.infra.domains.groups.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.infra.domains.groups package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2019-05-29 14:05:24 -04:00
< a href = "com.vmware.nsx_policy.infra.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx_policy.infra package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2018-08-07 19:42:25 -04:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2019-05-29 14:05:24 -04:00
© Copyright 2019, VMware, Inc.
2018-08-07 19:42:25 -04:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
2018-11-01 14:01:54 -04:00
SphinxRtdTheme.Navigation.enable(true);
2018-08-07 19:42:25 -04:00
});
2019-05-29 14:05:24 -04:00
< / script >
2018-08-07 19:42:25 -04:00
< / body >
< / html >
