2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
2021-03-31 18:40:01 -04:00
< html class = "writer-html4" lang = "en" >
2018-08-07 19:42:25 -04:00
< head >
2021-03-31 18:40:01 -04:00
< meta charset = "utf-8" / >
2018-08-07 19:42:25 -04:00
2021-03-31 18:40:01 -04:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2018-08-07 19:42:25 -04:00
2021-03-31 18:40:01 -04:00
< title > com.vmware.nsx_policy.global_infra.domains package — NSX-T Policy SDK 3.0.3.0.0 documentation< / title >
2018-08-07 19:42:25 -04:00
2020-09-21 16:47:14 -04:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2018-08-07 19:42:25 -04:00
2021-03-31 18:40:01 -04:00
2018-08-07 19:42:25 -04:00
2021-03-31 18:40:01 -04:00
2018-08-07 19:42:25 -04:00
2020-09-21 16:47:14 -04:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
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 >
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 >
2019-05-29 14:05:24 -04:00
< 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
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2020-09-21 16:47:14 -04:00
< link rel = "next" title = "com.vmware.nsx_policy.global_infra.domains.gateway_policies package" href = "com.vmware.nsx_policy.global_infra.domains.gateway_policies.html" / >
< link rel = "prev" title = "com.vmware.nsx_policy.global_infra package" href = "com.vmware.nsx_policy.global_infra.html" / >
2018-08-07 19:42:25 -04:00
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
2019-05-29 14:05:24 -04:00
< div class = "wy-side-nav-search" >
2018-08-07 19:42:25 -04:00
2021-03-31 18:40:01 -04:00
< a href = "index.html" class = "icon icon-home" > NSX-T Policy SDK
2018-08-07 19:42:25 -04:00
< / a >
< div class = "version" >
2021-03-31 18:40:01 -04:00
3.0.3.0.0
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 >
2020-09-21 16:47:14 -04:00
2018-08-07 19:42:25 -04:00
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "reference internal" href = "com.html" > com package< / a > < ul class = "current" >
< li class = "toctree-l2 current" > < a class = "reference internal" href = "com.html#subpackages" > Subpackages< / a > < ul class = "current" >
< li class = "toctree-l3 current" > < a class = "reference internal" href = "com.vmware.html" > com.vmware package< / a > < ul class = "current" >
< li class = "toctree-l4 current" > < a class = "reference internal" href = "com.vmware.html#subpackages" > Subpackages< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#module-com.vmware.nsx_policy_client" > com.vmware.nsx_policy_client module< / a > < / li >
2020-06-05 18:48:31 -04:00
< li class = "toctree-l4" > < a class = "reference internal" href = "com.vmware.html#com-vmware-nsx-policy-client-for-vmc-module" > com.vmware.nsx_policy_client_for_vmc module< / a > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
2020-09-21 16:47:14 -04:00
2018-08-07 19:42:25 -04:00
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > NSX-T Policy SDK< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2021-03-31 18:40:01 -04:00
2018-08-07 19:42:25 -04: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 >
2018-08-07 19:42:25 -04:00
< li > < a href = "com.html" > com package< / a > » < / li >
< li > < a href = "com.vmware.html" > com.vmware package< / a > » < / li >
< li > < a href = "com.vmware.nsx_policy.html" > com.vmware.nsx_policy package< / a > » < / li >
2020-09-21 16:47:14 -04:00
< li > < a href = "com.vmware.nsx_policy.global_infra.html" > com.vmware.nsx_policy.global_infra package< / a > » < / li >
2018-08-07 19:42:25 -04:00
2020-09-21 16:47:14 -04:00
< li > com.vmware.nsx_policy.global_infra.domains package< / li >
2018-08-07 19:42:25 -04:00
< li class = "wy-breadcrumbs-aside" >
2021-03-31 18:40:01 -04:00
2020-09-21 16:47:14 -04:00
< a href = "_sources/com.vmware.nsx_policy.global_infra.domains.rst.txt" rel = "nofollow" > View page source< / a >
2018-08-07 19:42:25 -04:00
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains" >
< span id = "com-vmware-nsx-policy-global-infra-domains-package" > < / span > < h1 > com.vmware.nsx_policy.global_infra.domains package< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains" title = "Permalink to this headline" > ¶< / a > < / h1 >
2018-08-07 19:42:25 -04:00
< div class = "section" id = "subpackages" >
< h2 > Subpackages< a class = "headerlink" href = "#subpackages" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "toctree-wrapper compound" >
< ul >
2020-09-21 16:47:14 -04:00
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.gateway_policies.html" > com.vmware.nsx_policy.global_infra.domains.gateway_policies package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.gateway_policies.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.gateway_policies.html#module-com.vmware.nsx_policy.global_infra.domains.gateway_policies.rules_client" > com.vmware.nsx_policy.global_infra.domains.gateway_policies.rules_client module< / a > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / li >
2020-09-21 16:47:14 -04:00
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.groups.html" > com.vmware.nsx_policy.global_infra.domains.groups package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.groups.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.groups.html#module-com.vmware.nsx_policy.global_infra.domains.groups.members_client" > com.vmware.nsx_policy.global_infra.domains.groups.members_client module< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.groups.html#module-com.vmware.nsx_policy.global_infra.domains.groups.statistics_client" > com.vmware.nsx_policy.global_infra.domains.groups.statistics_client module< / a > < / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / li >
2020-09-21 16:47:14 -04:00
< li class = "toctree-l1" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.security_policies.html" > com.vmware.nsx_policy.global_infra.domains.security_policies package< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.security_policies.html#submodules" > Submodules< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "com.vmware.nsx_policy.global_infra.domains.security_policies.html#module-com.vmware.nsx_policy.global_infra.domains.security_policies.rules_client" > com.vmware.nsx_policy.global_infra.domains.security_policies.rules_client module< / a > < / li >
2020-01-27 14:28:46 -05:00
< / ul >
< / li >
2018-08-07 19:42:25 -04:00
< / ul >
< / div >
< / div >
< div class = "section" id = "submodules" >
< h2 > Submodules< a class = "headerlink" href = "#submodules" title = "Permalink to this headline" > ¶< / a > < / h2 >
< / div >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.communication_maps_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-communication-maps-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.communication_maps_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.communication_maps_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.global_infra.domains.communication_maps_client.CommunicationEntries" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_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.global_infra.domains.communication_maps_client.CommunicationEntries" 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 >
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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_AFTER" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_AFTER< / code > < em class = "property" > = 'insert_after'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_AFTER" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.global_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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BEFORE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BEFORE< / code > < em class = "property" > = 'insert_before'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BEFORE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.global_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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BOTTOM" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BOTTOM< / code > < em class = "property" > = 'insert_bottom'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BOTTOM" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.global_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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_TOP" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_TOP< / code > < em class = "property" > = 'insert_top'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_TOP" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.revise" title = "com.vmware.nsx_policy.global_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 >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.delete" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete CommunicationEntry This API is deprecated. Please use the
following API instead. DELETE
/infra/domains/domain-id/security-policies/security-policy-id/rules/rule-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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
2018-08-07 19:42:25 -04: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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.get" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read CommunicationEntry This API is deprecated. Please use the
following API instead. GET
/infra/domains/domain-id/security-policies/security-policy-id/rules/rule-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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.CommunicationEntry< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > communication_map_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.global_infra.domains.communication_maps_client.CommunicationEntries.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List CommunicationEntries This API is deprecated. Please use the
following API instead. GET
/infra/domains/domain-id/security-policies/security-policy-id/rules< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.CommunicationEntryListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.patch" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Patch the CommunicationEntry. If a communication entry for the given
communication-entry-id is not present, the object will get created and
if it is present it will be updated. This is a full replace This API is
deprecated. Please use the following API instead. PATCH
/infra/domains/domain-id/security-policies/security-policy-id/rules/rule-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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / li >
2018-08-07 19:42:25 -04: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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.revise" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.revise" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > This is used to re-order a communictation entry within a communication
2020-01-27 14:28:46 -05:00
map. This API is deprecated. Please use the following API instead. POST
/infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id?action=revise< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / li >
< li > < 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 > ) – The communication map/communication entry path if operation is
‘ insert_after’ or ‘ insert_before’ (optional)< / li >
< li > < 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 > ) – Operation (optional, default to insert_top)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.CommunicationEntry< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.communication_maps_client.CommunicationEntries.update" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.communication_maps_client.CommunicationEntries.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2018-08-07 19:42:25 -04:00
< dd > < p > Update the CommunicationEntry. If a CommunicationEntry with the
communication-entry-id is not already present, this API fails with a
2020-01-27 14:28:46 -05:00
404. Creation of CommunicationEntries is not allowed using this API.
This API is deprecated. Please use the following API instead PUT
/infra/domains/domain-id/security-policies/securit-policy-id/rules/rule-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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > communication_entry_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / li >
2018-08-07 19:42:25 -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.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 >
< / 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.CommunicationEntry< / 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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -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.global_infra.domains.communication_maps_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_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.global_infra.domains.communication_maps_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 >
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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-endpoint-policies-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.endpoint_policies_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.global_infra.domains.endpoint_policies_client.EndpointRules" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.< / code > < code class = "descname" > EndpointRules< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules" 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 >
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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > endpoint_policy_id< / em > , < em > endpoint_rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete EndpointRule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > endpoint_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – EndpointPolicy ID (required)< / li >
< li > < strong > endpoint_rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – EndpointRule ID (required)< / li >
2018-08-07 19:42:25 -04: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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > endpoint_policy_id< / em > , < em > endpoint_rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read Endpoint rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > endpoint_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Endpoint policy id (required)< / li >
< li > < strong > endpoint_rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Endpoint rule id (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.EndpointRule" title = "com.vmware.nsx_policy.model_client.EndpointRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.EndpointRule< / 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.EndpointRule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > endpoint_policy_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.global_infra.domains.endpoint_policies_client.EndpointRules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List Endpoint rules< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > endpoint_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Endpoint policy id (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.EndpointRuleListResult" title = "com.vmware.nsx_policy.model_client.EndpointRuleListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.EndpointRuleListResult< / 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.EndpointRuleListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > endpoint_policy_id< / em > , < em > endpoint_rule_id< / em > , < em > endpoint_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a Endpoint rule with the endpoint-rule-id is not already
present, otherwise update the Endpoint Rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > endpoint_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Endpoint policy id (required)< / li >
< li > < strong > endpoint_rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Endpoint rule id (required)< / li >
< li > < strong > endpoint_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.EndpointRule" title = "com.vmware.nsx_policy.model_client.EndpointRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.EndpointRule< / span > < / code > < / a > ) – (required)< / li >
2018-08-07 19:42:25 -04: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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > endpoint_policy_id< / em > , < em > endpoint_rule_id< / em > , < em > endpoint_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.endpoint_policies_client.EndpointRules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a Endpoint rule with the endpoint-rule-id is not already
present, otherwise update the Endpoint Rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > endpoint_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Endpoint policy id (required)< / li >
< li > < strong > endpoint_rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Endpoint rule id (required)< / li >
< li > < strong > endpoint_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.EndpointRule" title = "com.vmware.nsx_policy.model_client.EndpointRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.EndpointRule< / span > < / code > < / a > ) – (required)< / li >
2018-08-07 19:42:25 -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.EndpointRule" title = "com.vmware.nsx_policy.model_client.EndpointRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.EndpointRule< / 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.EndpointRule< / 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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -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.global_infra.domains.endpoint_policies_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.endpoint_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.global_infra.domains.endpoint_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 >
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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
< / div >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-forwarding-policies-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.forwarding_policies_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.global_infra.domains.forwarding_policies_client.Rules" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.forwarding_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.global_infra.domains.forwarding_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 >
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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > forwarding_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete ForwardingRule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > forwarding_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Forwarding Map ID (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – ForwardingRule ID (required)< / li >
2018-08-07 19:42:25 -04: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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > forwarding_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > forwarding_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Forwarding map id (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule id (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ForwardingRule" title = "com.vmware.nsx_policy.model_client.ForwardingRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ForwardingRule< / 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.ForwardingRule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > forwarding_policy_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.global_infra.domains.forwarding_policies_client.Rules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List rules< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > forwarding_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Forwarding map id (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ForwardingRuleListResult" title = "com.vmware.nsx_policy.model_client.ForwardingRuleListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ForwardingRuleListResult< / 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.ForwardingRuleListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > forwarding_policy_id< / em > , < em > rule_id< / em > , < em > forwarding_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a rule with the rule-id is not already present, otherwise update
the rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > forwarding_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Forwarding map id (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule id (required)< / li >
< li > < strong > forwarding_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ForwardingRule" title = "com.vmware.nsx_policy.model_client.ForwardingRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ForwardingRule< / span > < / code > < / a > ) – (required)< / li >
2018-08-07 19:42:25 -04: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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -04:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > forwarding_policy_id< / em > , < em > rule_id< / em > , < em > forwarding_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.forwarding_policies_client.Rules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a rule with the rule-id is not already present, otherwise update
the rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > forwarding_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Forwarding map id (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – rule id (required)< / li >
< li > < strong > forwarding_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ForwardingRule" title = "com.vmware.nsx_policy.model_client.ForwardingRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ForwardingRule< / span > < / code > < / a > ) – (required)< / li >
2018-08-07 19:42:25 -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.ForwardingRule" title = "com.vmware.nsx_policy.model_client.ForwardingRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ForwardingRule< / 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.ForwardingRule< / 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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -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 >
2018-08-07 19:42:25 -04:00
Not Found< / p >
2021-03-31 18:40:01 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-07 19:42:25 -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.global_infra.domains.forwarding_policies_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.forwarding_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.global_infra.domains.forwarding_policies_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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / div >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.gateway_policies_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-gateway-policies-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.gateway_policies_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.gateway_policies_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.global_infra.domains.gateway_policies_client.Rules" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_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.global_infra.domains.gateway_policies_client.Rules" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_AFTER" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_AFTER< / code > < em class = "property" > = 'insert_after'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_AFTER" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BEFORE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BEFORE< / code > < em class = "property" > = 'insert_before'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BEFORE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BOTTOM" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BOTTOM< / code > < em class = "property" > = 'insert_bottom'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BOTTOM" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_TOP" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_TOP< / code > < em class = "property" > = 'insert_top'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_TOP" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.delete" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.get" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.Rule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_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.global_infra.domains.gateway_policies_client.Rules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List rules< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.RuleListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.patch" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Update the gateway rule. Create new rule if a rule with the rule-id is
not already present.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.revise" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > revise< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_id< / em > , < em > rule_id< / em > , < em > rule< / em > , < em > anchor_path=None< / em > , < em > operation=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.revise" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > This is used to re-order a gateway rule within a gateway policy.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / li >
< li > < 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 > ) – The security policy/rule path if operation is ‘ insert_after’ or
‘ insert_before’ (optional)< / li >
< li > < 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 > ) – Operation (optional, default to insert_top)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.Rule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Rules.update" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.gateway_policies_client.Rules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Update the gateway rule. Create new rule if a rule with the rule-id is
not already present.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / 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.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 >
< / 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.Rule< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Statistics" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.gateway_policies_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.global_infra.domains.gateway_policies_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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Statistics.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > gateway_policy_id< / em > , < em > enforcement_point_path=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.Statistics.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get statistics of a gateay policy. - no enforcement point path
specified: Stats will be evaluated on each enforcement. point. -
{enforcement_point_path}: Stats are evaluated only on the given
enforcement point.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > gateway_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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 > ) – String Path of the enforcement point (optional)< / 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.SecurityPolicyStatisticsListResult" title = "com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsListResult< / 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.SecurityPolicyStatisticsListResult< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.gateway_policies_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_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.global_infra.domains.gateway_policies_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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / div >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.groups_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-groups-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.groups_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.groups_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.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > DnsSecurityProfileBindingMaps< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > dns_security_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will delete DNS security 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > dns_security_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – DNS security profile binding map ID (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > dns_security_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will get DNS security 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > dns_security_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – DNS security profile binding map ID (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap" title = "com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap< / 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.DnsSecurityProfileBindingMap< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_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.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will get DNS security 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMapListResult" title = "com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMapListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMapListResult< / 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.DnsSecurityProfileBindingMapListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > dns_security_profile_binding_map_id< / em > , < em > dns_security_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will create or update DNS security 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > dns_security_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – DNS security profile binding map ID (required)< / li >
< li > < strong > dns_security_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap" title = "com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > dns_security_profile_binding_map_id< / em > , < em > dns_security_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.DnsSecurityProfileBindingMaps.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will update DNS security 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > dns_security_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – DNS security profile binding map ID (required)< / li >
< li > < strong > dns_security_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap" title = "com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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.DnsSecurityProfileBindingMap" title = "com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.DnsSecurityProfileBindingMap< / 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.DnsSecurityProfileBindingMap< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > ExternalIdExpressions< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_ADD" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_ADD< / code > < em class = "property" > = 'add'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_ADD" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > ExternalIdExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_REMOVE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_REMOVE< / code > < em class = "property" > = 'remove'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_REMOVE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > ExternalIdExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.create" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > create< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > group_member_list< / em > , < em > action< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.create" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > It will add or remove the specified members having external ID for a
given expression of a group.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_member_list< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.GroupMemberList" title = "com.vmware.nsx_policy.model_client.GroupMemberList" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMemberList< / span > < / code > < / a > ) – (required)< / li >
< li > < strong > action< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Add or Remove group members. (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete Group External ID Expression< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – ExternalIDExpression ID (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > external_id_expression< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.ExternalIdExpressions.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > If a group ExternalIDexpression with the expression-id is not already
present, create a new ExternalIDexpresison. If it already exists,
replace the existing ExternalIDexpression.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – ExternalIDExpression ID (required)< / li >
< li > < strong > external_id_expression< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.ExternalIDExpression" title = "com.vmware.nsx_policy.model_client.ExternalIDExpression" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.ExternalIDExpression< / span > < / code > < / a > ) – (required)< / 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" > 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.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > FirewallFloodProtectionProfileBindingMaps< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_flood_protection_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will delete Firewall Flood Protection Profile Binding< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_flood_protection_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Flood Protection Profile Binding Map ID (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_flood_protection_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will get Firewall Flood Protection 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain-ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_flood_protection_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Flood Protection Profile Binding Map ID (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap< / 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.PolicyFirewallFloodProtectionProfileBindingMap< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_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.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will list all Firewall Flood Protection Profile Binding Maps in
current group 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMapListResult" title = "com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMapListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMapListResult< / 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.PolicyFirewallFloodProtectionProfileBindingMapListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_flood_protection_profile_binding_map_id< / em > , < em > policy_firewall_flood_protection_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will create or update Firewall Flood Protection 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_flood_protection_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Flood Protection Profile Binding Map ID (required)< / li >
< li > < strong > policy_firewall_flood_protection_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_flood_protection_profile_binding_map_id< / em > , < em > policy_firewall_flood_protection_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallFloodProtectionProfileBindingMaps.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will update Firewall Flood Protection 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – DomainID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_flood_protection_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Flood Protection Profile Binding Map ID (required)< / li >
< li > < strong > policy_firewall_flood_protection_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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.PolicyFirewallFloodProtectionProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallFloodProtectionProfileBindingMap< / 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.PolicyFirewallFloodProtectionProfileBindingMap< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > FirewallSessionTimerProfileBindingMaps< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_session_timer_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will delete Firewall Session Timer Profile Binding< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_session_timer_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Session Timer Profile Binding Map ID (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_session_timer_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will get Firewall Session Timer 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain-ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_session_timer_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Session Timer Profile Binding Map ID (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap< / 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.PolicyFirewallSessionTimerProfileBindingMap< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_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.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will list all Firewall Session Timer Profile Binding Maps in
current group 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMapListResult" title = "com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMapListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMapListResult< / 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.PolicyFirewallSessionTimerProfileBindingMapListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_session_timer_profile_binding_map_id< / em > , < em > policy_firewall_session_timer_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will create or update Firewall Session Timer 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_session_timer_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Session Timer Profile Binding Map ID (required)< / li >
< li > < strong > policy_firewall_session_timer_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > firewall_session_timer_profile_binding_map_id< / em > , < em > policy_firewall_session_timer_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.FirewallSessionTimerProfileBindingMaps.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will update Firewall Session Timer 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – DomainID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > firewall_session_timer_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Firewall Session Timer Profile Binding Map ID (required)< / li >
< li > < strong > policy_firewall_session_timer_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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.PolicyFirewallSessionTimerProfileBindingMap" title = "com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PolicyFirewallSessionTimerProfileBindingMap< / 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.PolicyFirewallSessionTimerProfileBindingMap< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > GroupMonitoringProfileBindingMaps< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > group_monitoring_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will delete Group Monitoring Profile Binding< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > group_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group Monitoring Profile Binding Map ID (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > group_monitoring_profile_binding_map_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will get Group 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain-ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > group_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group Monitoring Profile Binding Map ID (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap< / 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.GroupMonitoringProfileBindingMap< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_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.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will list all Group Monitoring Profile Binding Maps in current
group 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMapListResult" title = "com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMapListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMapListResult< / 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.GroupMonitoringProfileBindingMapListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > group_monitoring_profile_binding_map_id< / em > , < em > group_monitoring_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will create group 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > group_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group Monitoring Profile Binding Map ID (required)< / li >
< li > < strong > group_monitoring_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > group_monitoring_profile_binding_map_id< / em > , < em > group_monitoring_profile_binding_map< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.GroupMonitoringProfileBindingMaps.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > API will update Group 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – DomainID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > group_monitoring_profile_binding_map_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group Monitoring Profile Binding Map ID (required)< / li >
< li > < strong > group_monitoring_profile_binding_map< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap< / span > < / code > < / a > ) – (required)< / 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.GroupMonitoringProfileBindingMap" title = "com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMonitoringProfileBindingMap< / 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.GroupMonitoringProfileBindingMap< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > IpAddressExpressions< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_ADD" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_ADD< / code > < em class = "property" > = 'add'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_ADD" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > IpAddressExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_REMOVE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_REMOVE< / code > < em class = "property" > = 'remove'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_REMOVE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > IpAddressExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.create" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > create< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > ip_address_list< / em > , < em > action< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.create" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > It will add or remove the specified IP Addresses from a given
expression of a group.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > ip_address_list< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPAddressList" title = "com.vmware.nsx_policy.model_client.IPAddressList" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPAddressList< / span > < / code > < / a > ) – (required)< / li >
< li > < strong > action< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Add or Remove group members. (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete Group IPAddressExpression< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – IPAddressExpression ID (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > ip_address_expression< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.IpAddressExpressions.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > If a group IPAddressExpression with the expression-id is not already
present, create a new IPAddressExpression. If it already exists,
replace the existing IPAddressExpression.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – IPAddressExpression ID (required)< / li >
< li > < strong > ip_address_expression< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IPAddressExpression" title = "com.vmware.nsx_policy.model_client.IPAddressExpression" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IPAddressExpression< / span > < / code > < / a > ) – (required)< / 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 >
2020-09-21 16:47:14 -04:00
< / 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.global_infra.domains.groups_client.MacAddressExpressions" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > MacAddressExpressions< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_ADD" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_ADD< / code > < em class = "property" > = 'add'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_ADD" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > MacAddressExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_REMOVE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_REMOVE< / code > < em class = "property" > = 'remove'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_REMOVE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > MacAddressExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.create" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > create< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > m_ac_address_list< / em > , < em > action< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.create" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > It will add or remove the specified MAC Addresses from a given
expression of a group.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > m_ac_address_list< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.MACAddressList" title = "com.vmware.nsx_policy.model_client.MACAddressList" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.MACAddressList< / span > < / code > < / a > ) – (required)< / li >
< li > < strong > action< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Add or Remove group members. (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete Group MACAddressExpression< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – MACAddressExpression ID (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > m_ac_address_expression< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MacAddressExpressions.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > If a group MACAddressExpression with the expression-id is not already
present, create a new MACAddressExpression. If it already exists,
replace the existing MACAddressExpression.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – MACAddressExpression ID (required)< / li >
< li > < strong > m_ac_address_expression< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.MACAddressExpression" title = "com.vmware.nsx_policy.model_client.MACAddressExpression" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.MACAddressExpression< / span > < / code > < / a > ) – (required)< / 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" > 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-01-27 14:28:46 -05:00
< / dd > < / dl >
2020-09-21 16:47:14 -04:00
< / 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.global_infra.domains.groups_client.MemberTypes" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > MemberTypes< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MemberTypes" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.MemberTypes.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.MemberTypes.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > It retrieves member types for a given group. In case of nested groups,
it calculates member types of child groups as well. Considers member
type for members added via static members and dynamic membership
criteria.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / 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.GroupMemberTypeListResult" title = "com.vmware.nsx_policy.model_client.GroupMemberTypeListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMemberTypeListResult< / 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.GroupMemberTypeListResult< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > PathExpressions< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.CREATE_ACTION_ADD" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_ADD< / code > < em class = "property" > = 'add'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.CREATE_ACTION_ADD" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > PathExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.CREATE_ACTION_REMOVE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > CREATE_ACTION_REMOVE< / code > < em class = "property" > = 'remove'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.CREATE_ACTION_REMOVE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Possible value for < code class = "docutils literal notranslate" > < span class = "pre" > action< / span > < / code > of method < a class = "reference internal" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.create" title = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.create" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > PathExpressions.create()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.create" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > create< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > group_member_list< / em > , < em > action< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.create" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > It will add or remove the specified members having path for a given
expression of a group.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > group_member_list< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.GroupMemberList" title = "com.vmware.nsx_policy.model_client.GroupMemberList" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupMemberList< / span > < / code > < / a > ) – (required)< / li >
< li > < strong > action< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Add or Remove group members. (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete Group Path Expression< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – PathExpression ID (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > , < em > expression_id< / em > , < em > path_expression< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.PathExpressions.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > If a group path_expression with the expression-id is not already
present, create a new pathexpresison. If it already exists, replace the
existing pathexpression.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > expression_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – PathExpression ID (required)< / li >
< li > < strong > path_expression< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PathExpression" title = "com.vmware.nsx_policy.model_client.PathExpression" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.PathExpression< / span > < / code > < / a > ) – (required)< / 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" > 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.global_infra.domains.groups_client.PortMirroringInstances" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_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.global_infra.domains.groups_client.PortMirroringInstances" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PortMirroringInstances.delete" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.groups_client.PortMirroringInstances.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > API will delete port mirroring instance. Mirroring from source to
destination ports will be stopped. This API is deprecated. Please use
the following API:
< a class = "reference external" href = "https:/" > https:/< / a > /< policy-mgr> /policy/api/v1/infra/port-mirroring-profiles< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Port Mirroring Instance Id (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PortMirroringInstances.get" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.groups_client.PortMirroringInstances.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > API will return details of port mirroring instance. If instance does
not exist, it will return 404. This API is deprecated. Please use the
following API:
< a class = "reference external" href = "https:/" > https:/< / a > /< policy-mgr> /policy/api/v1/infra/port-mirroring-profiles< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Port Mirroring Instance Id (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.PortMirroringInstance< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PortMirroringInstances.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_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.global_infra.domains.groups_client.PortMirroringInstances.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > API will list all port mirroring instances active on current group.
This API is deprecated. Please use the following API:
< a class = "reference external" href = "https:/" > https:/< / a > /< policy-mgr> /policy/api/v1/infra/port-mirroring-profiles< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.PortMirroringInstanceListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PortMirroringInstances.patch" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.groups_client.PortMirroringInstances.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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. This API is deprecated. Please use the following
API: < a class = "reference external" href = "https:/" > https:/< / a > /< policy-mgr> /policy/api/v1/infra/port-mirroring-profiles< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Port Mirroring Instance Id (required)< / li >
< li > < 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 > ) – (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.PortMirroringInstances.update" >
2021-03-31 18:40:01 -04:00
< 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.global_infra.domains.groups_client.PortMirroringInstances.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Create or Replace port mirroring instance. Packets will be mirrored
from source group to destination group. This API is deprecated. Please
use the following API:
< a class = "reference external" href = "https:/" > https:/< / a > /< policy-mgr> /policy/api/v1/infra/port-mirroring-profiles< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group ID (required)< / li >
< li > < strong > port_mirroring_instance_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Port Mirroring Instance Id (required)< / li >
< li > < 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 > ) – (required)< / 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.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 >
< / 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.PortMirroringInstance< / 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.global_infra.domains.groups_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_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.global_infra.domains.groups_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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / 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.global_infra.domains.groups_client.Tags" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.groups_client.< / code > < code class = "descname" > Tags< / code > < span class = "sig-paren" > (< / span > < em > config< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.Tags" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.groups_client.Tags.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > group_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.groups_client.Tags.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Get tags used to define conditions inside a Group. Also includes tags
inside nested groups.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > group_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Group Id (required)< / 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.GroupTagsList" title = "com.vmware.nsx_policy.model_client.GroupTagsList" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.GroupTagsList< / 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.GroupTagsList< / 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 >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-intrusion-service-policies-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_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.global_infra.domains.intrusion_service_policies_client.Rules" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.intrusion_service_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.global_infra.domains.intrusion_service_policies_client.Rules" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_AFTER" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_AFTER< / code > < em class = "property" > = 'insert_after'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_AFTER" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.intrusion_service_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BEFORE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BEFORE< / code > < em class = "property" > = 'insert_before'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BEFORE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.intrusion_service_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BOTTOM" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BOTTOM< / code > < em class = "property" > = 'insert_bottom'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BOTTOM" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.intrusion_service_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_TOP" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_TOP< / code > < em class = "property" > = 'insert_top'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_TOP" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.intrusion_service_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete intrusion detection rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Policy ID (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule ID (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Read intrusion detection rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Policy ID (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule ID (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IdsRule" title = "com.vmware.nsx_policy.model_client.IdsRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IdsRule< / 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.IdsRule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > policy_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.global_infra.domains.intrusion_service_policies_client.Rules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > List intrusion detection rules.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Policy ID (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IdsRuleListResult" title = "com.vmware.nsx_policy.model_client.IdsRuleListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IdsRuleListResult< / 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.IdsRuleListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > policy_id< / em > , < em > rule_id< / em > , < em > ids_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Patch intrusion detection system rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Policy ID (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule ID (required)< / li >
< li > < strong > ids_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IdsRule" title = "com.vmware.nsx_policy.model_client.IdsRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IdsRule< / span > < / code > < / a > ) – (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.revise" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > revise< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > policy_id< / em > , < em > rule_id< / em > , < em > ids_rule< / em > , < em > anchor_path=None< / em > , < em > operation=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.revise" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > This is used to re-order a rule within a security policy.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > ids_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IdsRule" title = "com.vmware.nsx_policy.model_client.IdsRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IdsRule< / span > < / code > < / a > ) – (required)< / li >
< li > < 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 > ) – The security policy/rule path if operation is ‘ insert_after’ or
‘ insert_before’ (optional)< / li >
< li > < 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 > ) – Operation (optional, default to insert_top)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IdsRule" title = "com.vmware.nsx_policy.model_client.IdsRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IdsRule< / 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.IdsRule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > policy_id< / em > , < em > rule_id< / em > , < em > ids_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.intrusion_service_policies_client.Rules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Update intrusion detection system rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Policy ID (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule ID (required)< / li >
< li > < strong > ids_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.IdsRule" title = "com.vmware.nsx_policy.model_client.IdsRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IdsRule< / span > < / code > < / a > ) – (required)< / 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.IdsRule" title = "com.vmware.nsx_policy.model_client.IdsRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.IdsRule< / 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.IdsRule< / 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.global_infra.domains.intrusion_service_policies_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.intrusion_service_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.global_infra.domains.intrusion_service_policies_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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
2020-09-21 16:47:14 -04:00
< / dd > < / dl >
< / div >
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.redirection_policies_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-redirection-policies-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.redirection_policies_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.redirection_policies_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.global_infra.domains.redirection_policies_client.Rules" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.redirection_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.global_infra.domains.redirection_policies_client.Rules" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > redirection_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Delete RedirectionRule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain ID (required)< / li >
< li > < strong > redirection_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Redirection Map ID (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – RedirectionRule ID (required)< / 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" > 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 >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > redirection_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< dd > < p > Read rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > redirection_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Redirection map id (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule id (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RedirectionRule" title = "com.vmware.nsx_policy.model_client.RedirectionRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.RedirectionRule< / 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.RedirectionRule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > redirection_policy_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.global_infra.domains.redirection_policies_client.Rules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List rules< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > redirection_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Redirection map id (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RedirectionRuleListResult" title = "com.vmware.nsx_policy.model_client.RedirectionRuleListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.RedirectionRuleListResult< / 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.RedirectionRuleListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > redirection_policy_id< / em > , < em > rule_id< / em > , < em > redirection_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a rule with the rule-id is not already present, otherwise update
the rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > redirection_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – RedirectionPolicy id (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – rule id (required)< / li >
< li > < strong > redirection_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RedirectionRule" title = "com.vmware.nsx_policy.model_client.RedirectionRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.RedirectionRule< / span > < / code > < / a > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > redirection_policy_id< / em > , < em > rule_id< / em > , < em > redirection_rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.Rules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Create a rule with the rule-id is not already present, otherwise update
the rule.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > redirection_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Redirection map id (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Rule id (required)< / li >
< li > < strong > redirection_rule< / strong > (< a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RedirectionRule" title = "com.vmware.nsx_policy.model_client.RedirectionRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.RedirectionRule< / span > < / code > < / a > ) – (required)< / 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.RedirectionRule" title = "com.vmware.nsx_policy.model_client.RedirectionRule" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.RedirectionRule< / 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.RedirectionRule< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.redirection_policies_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.redirection_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.global_infra.domains.redirection_policies_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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
< / div >
2020-09-21 16:47:14 -04:00
< div class = "section" id = "module-com.vmware.nsx_policy.global_infra.domains.security_policies_client" >
< span id = "com-vmware-nsx-policy-global-infra-domains-security-policies-client-module" > < / span > < h2 > com.vmware.nsx_policy.global_infra.domains.security_policies_client module< a class = "headerlink" href = "#module-com.vmware.nsx_policy.global_infra.domains.security_policies_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.global_infra.domains.security_policies_client.Rules" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.security_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.global_infra.domains.security_policies_client.Rules" 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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_AFTER" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_AFTER< / code > < em class = "property" > = 'insert_after'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_AFTER" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.security_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_BEFORE" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BEFORE< / code > < em class = "property" > = 'insert_before'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_BEFORE" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.security_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_BOTTOM" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_BOTTOM< / code > < em class = "property" > = 'insert_bottom'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_BOTTOM" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.security_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "attribute" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_TOP" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > REVISE_OPERATION_TOP< / code > < em class = "property" > = 'insert_top'< / em > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.REVISE_OPERATION_TOP" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-09-21 16:47:14 -04:00
< 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.global_infra.domains.security_policies_client.Rules.revise" title = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.revise" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > Rules.revise()< / span > < / code > < / a > .< / p >
2020-01-27 14:28:46 -05:00
< / dd > < / dl >
2021-03-31 18:40:01 -04:00
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.delete" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > delete< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > security_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.delete" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Delete rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > security_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.get" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > get< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > security_policy_id< / em > , < em > rule_id< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.get" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Read rule< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > security_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.Rule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > security_policy_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.global_infra.domains.security_policies_client.Rules.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > List rules< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > security_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > cursor< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)< / li >
< li > < strong > 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 > ) – Include objects that are marked for deletion in results (optional,
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 > ) – Comma separated list of fields that should be included in query
result (optional)< / li >
< li > < strong > page_size< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > long< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)< / li >
< li > < strong > sort_ascending< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > bool< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – (optional)< / li >
< li > < strong > sort_by< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > or < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ) – Field by which records are sorted (optional)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.RuleListResult< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.patch" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > patch< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > security_policy_id< / em > , < em > rule_id< / em > , < em > rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.patch" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Patch the rule. If Rule corresponding to the the given rule-id is not
present, the object will get created and if it is present it will be
updated. This is a full replace< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > security_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.revise" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > revise< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > security_policy_id< / em > , < em > rule_id< / em > , < em > rule< / em > , < em > anchor_path=None< / em > , < em > operation=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.revise" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > This is used to re-order a rule within a security policy.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > security_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / li >
< li > < 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 > ) – The security policy/rule path if operation is ‘ insert_after’ or
‘ insert_before’ (optional)< / li >
< li > < 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 > ) – Operation (optional, default to insert_top)< / li >
< / ul >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Return type:< / th > < td class = "field-body" > < p class = "first" > < a class = "reference internal" href = "com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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 >
< / 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.Rule< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.ServiceUnavailable< / span > < / code >
Service Unavailable< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InvalidRequest< / span > < / code >
Bad Request, Precondition Failed< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.InternalServerError< / span > < / code >
Internal Server Error< / p >
< / td >
< / tr >
< tr class = "field-odd field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.Unauthorized< / span > < / code >
Forbidden< / p >
< / td >
< / tr >
< tr class = "field-even field" > < th class = "field-name" > Raise:< / th > < td class = "field-body" > < p class = "first last" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.vapi.std.errors_client.NotFound< / span > < / code >
Not Found< / p >
< / td >
< / tr >
< / tbody >
< / table >
< / dd > < / dl >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.update" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > update< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > security_policy_id< / em > , < em > rule_id< / em > , < em > rule< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Rules.update" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Update the rule. Create new rule if a rule with the rule-id is not
already present.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > security_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < strong > rule_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – (required)< / li >
< li > < 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 > ) – (required)< / 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.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 >
< / 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.Rule< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Statistics" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.security_policies_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.global_infra.domains.security_policies_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 > ) – Configuration to be used for creating the stub.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "method" >
2020-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.Statistics.list" >
2021-03-31 18:40:01 -04:00
< code class = "descname" > list< / code > < span class = "sig-paren" > (< / span > < em > domain_id< / em > , < em > security_policy_id< / em > , < em > enforcement_point_path=None< / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#com.vmware.nsx_policy.global_infra.domains.security_policies_client.Statistics.list" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-01-27 14:28:46 -05:00
< dd > < p > Get statistics of a security policy. - no enforcement point path
specified: Stats will be evaluated on each enforcement point. -
{enforcement_point_path}: Stats are evaluated only on the given
enforcement point.< / 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 > domain_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Domain id (required)< / li >
< li > < strong > security_policy_id< / strong > (< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > str< / span > < / code > ) – Security policy id (required)< / 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 > ) – String Path of the enforcement point (optional)< / 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.SecurityPolicyStatisticsListResult" title = "com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsListResult" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > com.vmware.nsx_policy.model_client.SecurityPolicyStatisticsListResult< / 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.SecurityPolicyStatisticsListResult< / 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-09-21 16:47:14 -04:00
< dt id = "com.vmware.nsx_policy.global_infra.domains.security_policies_client.StubFactory" >
2021-03-31 18:40:01 -04:00
< em class = "property" > class < / em > < code class = "descclassname" > com.vmware.nsx_policy.global_infra.domains.security_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.global_infra.domains.security_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 >
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 > ) – Stub config instance< / td >
< / tr >
< / tbody >
< / table >
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" >
2021-03-31 18:40:01 -04:00
< a href = "com.vmware.nsx_policy.global_infra.domains.gateway_policies.html" class = "btn btn-neutral float-right" title = "com.vmware.nsx_policy.global_infra.domains.gateway_policies package" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< a href = "com.vmware.nsx_policy.global_infra.html" class = "btn btn-neutral float-left" title = "com.vmware.nsx_policy.global_infra package" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2018-08-07 19:42:25 -04:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2021-03-31 18:40:01 -04:00
© Copyright 2021, VMware, Inc..
2018-08-07 19:42:25 -04: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 > .
2018-08-07 19:42:25 -04:00
< / 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 >