Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 20:09:58 -05:00
Code
faf9ea381c
vsphere-automation-sdk-python/nsx/nsx_vmc_policy/com.vmware.nsx_policy.infra.domains.html

2693 lines
214 KiB
HTML
Raw Normal View History

add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<!DOCTYPE html>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<html class="writer-html5" lang="en" >
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<title>com.vmware.nsx_policy.infra.domains package &mdash; NSX-T Policy API 3.0.2.0.0 documentation</title>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
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" />
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<script type="text/javascript" src="_static/js/theme.js"></script>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<link rel="next" title="com.vmware.nsx_policy.infra.domains.gateway_policies package" href="com.vmware.nsx_policy.infra.domains.gateway_policies.html" />
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<link rel="prev" title="com.vmware.nsx_policy.infra package" href="com.vmware.nsx_policy.infra.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<div class="wy-side-nav-search" >
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<a href="index.html" class="icon icon-home" alt="Documentation Home"> NSX-T Policy API
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</a>
<div class="version">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
3.0.2.0.0
add vsphere, vmc and nsx API docs
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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
add vsphere, vmc and nsx API docs
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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
add vsphere, vmc and nsx API docs
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>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<a href="index.html">NSX-T Policy API</a>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.nsx_policy.html">com.vmware.nsx_policy package</a> &raquo;</li>
<li><a href="com.vmware.nsx_policy.infra.html">com.vmware.nsx_policy.infra package</a> &raquo;</li>
<li>com.vmware.nsx_policy.infra.domains package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.nsx_policy.infra.domains.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.nsx_policy.infra.domains">
<span id="com-vmware-nsx-policy-infra-domains-package"></span><h1>com.vmware.nsx_policy.infra.domains package<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.domains" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li class="toctree-l1"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.gateway_policies.html">com.vmware.nsx_policy.infra.domains.gateway_policies package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.gateway_policies.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.gateway_policies.html#module-com.vmware.nsx_policy.infra.domains.gateway_policies.rules_client">com.vmware.nsx_policy.infra.domains.gateway_policies.rules_client module</a></li>
</ul>
</li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<li class="toctree-l1"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.groups.html">com.vmware.nsx_policy.infra.domains.groups package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.groups.html#submodules">Submodules</a></li>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.groups.html#module-com.vmware.nsx_policy.infra.domains.groups.members_client">com.vmware.nsx_policy.infra.domains.groups.members_client module</a></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.groups.html#module-com.vmware.nsx_policy.infra.domains.groups.statistics_client">com.vmware.nsx_policy.infra.domains.groups.statistics_client module</a></li>
</ul>
</li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li class="toctree-l1"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.security_policies.html">com.vmware.nsx_policy.infra.domains.security_policies package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.security_policies.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.domains.security_policies.html#module-com.vmware.nsx_policy.infra.domains.security_policies.rules_client">com.vmware.nsx_policy.infra.domains.security_policies.rules_client module</a></li>
</ul>
</li>
add vsphere, vmc and nsx API docs
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>
<div class="section" id="module-com.vmware.nsx_policy.infra.domains.communication_maps_client">
<span id="com-vmware-nsx-policy-infra-domains-communication-maps-client-module"></span><h2>com.vmware.nsx_policy.infra.domains.communication_maps_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.domains.communication_maps_client" title="Permalink to this headline"></a></h2>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.communication_maps_client.</code><code class="sig-name descname">CommunicationEntries</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_AFTER">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">REVISE_OPERATION_AFTER</code><em class="property"> = 'insert_after'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_AFTER" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -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.infra.domains.communication_maps_client.CommunicationEntries.revise" title="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise"><code class="xref py py-func docutils literal notranslate"><span class="pre">CommunicationEntries.revise()</span></code></a>.</p>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BEFORE">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">REVISE_OPERATION_BEFORE</code><em class="property"> = 'insert_before'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BEFORE" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -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.infra.domains.communication_maps_client.CommunicationEntries.revise" title="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise"><code class="xref py py-func docutils literal notranslate"><span class="pre">CommunicationEntries.revise()</span></code></a>.</p>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BOTTOM">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">REVISE_OPERATION_BOTTOM</code><em class="property"> = 'insert_bottom'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_BOTTOM" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -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.infra.domains.communication_maps_client.CommunicationEntries.revise" title="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise"><code class="xref py py-func docutils literal notranslate"><span class="pre">CommunicationEntries.revise()</span></code></a>.</p>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_TOP">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<code class="sig-name descname">REVISE_OPERATION_TOP</code><em class="property"> = 'insert_top'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.REVISE_OPERATION_TOP" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -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.infra.domains.communication_maps_client.CommunicationEntries.revise" title="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise"><code class="xref py py-func docutils literal notranslate"><span class="pre">CommunicationEntries.revise()</span></code></a>.</p>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.delete">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">communication_map_id</span></em>, <em class="sig-param"><span class="n">communication_entry_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.delete" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.get">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">communication_map_id</span></em>, <em class="sig-param"><span class="n">communication_entry_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.get" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title="com.vmware.nsx_policy.model_client.CommunicationEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CommunicationEntry</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.CommunicationEntry</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.list">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">communication_map_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.list" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntryListResult" title="com.vmware.nsx_policy.model_client.CommunicationEntryListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CommunicationEntryListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.CommunicationEntryListResult</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.patch">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">communication_map_id</span></em>, <em class="sig-param"><span class="n">communication_entry_id</span></em>, <em class="sig-param"><span class="n">communication_entry</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.patch" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title="com.vmware.nsx_policy.model_client.CommunicationEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CommunicationEntry</span></code></a>) – (required)</p></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">revise</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">communication_map_id</span></em>, <em class="sig-param"><span class="n">communication_entry_id</span></em>, <em class="sig-param"><span class="n">communication_entry</span></em>, <em class="sig-param"><span class="n">anchor_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.revise" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dd><p>This is used to re-order a communictation entry within a communication
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title="com.vmware.nsx_policy.model_client.CommunicationEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CommunicationEntry</span></code></a>) – (required)</p></li>
<li><p><strong>anchor_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The communication map/communication entry path if operation is
‘insert_after’ or ‘insert_before’ (optional)</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</p></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title="com.vmware.nsx_policy.model_client.CommunicationEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CommunicationEntry</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.CommunicationEntry</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.update">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">communication_map_id</span></em>, <em class="sig-param"><span class="n">communication_entry_id</span></em>, <em class="sig-param"><span class="n">communication_entry</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.CommunicationEntries.update" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_map_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>communication_entry</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title="com.vmware.nsx_policy.model_client.CommunicationEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CommunicationEntry</span></code></a>) – (required)</p></li>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</ul>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.CommunicationEntry" title="com.vmware.nsx_policy.model_client.CommunicationEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.CommunicationEntry</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.CommunicationEntry</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Service Unavailable</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Bad Request, Precondition Failed</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Internal Server Error</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Forbidden</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Not Found</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.communication_maps_client.StubFactory">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.communication_maps_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.communication_maps_client.StubFactory" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<p>Initialize StubFactoryBase</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</dd></dl>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.domains.gateway_policies_client">
<span id="com-vmware-nsx-policy-infra-domains-gateway-policies-client-module"></span><h2>com.vmware.nsx_policy.infra.domains.gateway_policies_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.domains.gateway_policies_client" title="Permalink to this headline"></a></h2>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.gateway_policies_client.</code><code class="sig-name descname">Rules</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_AFTER">
<code class="sig-name descname">REVISE_OPERATION_AFTER</code><em class="property"> = 'insert_after'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_AFTER" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BEFORE">
<code class="sig-name descname">REVISE_OPERATION_BEFORE</code><em class="property"> = 'insert_before'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BEFORE" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BOTTOM">
<code class="sig-name descname">REVISE_OPERATION_BOTTOM</code><em class="property"> = 'insert_bottom'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_BOTTOM" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_TOP">
<code class="sig-name descname">REVISE_OPERATION_TOP</code><em class="property"> = 'insert_top'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.REVISE_OPERATION_TOP" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.delete">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">gateway_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.delete" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Delete rule</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>gateway_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.get">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">gateway_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.get" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Read rule</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>gateway_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Rule</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.list">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">gateway_policy_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.list" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>List rules</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>gateway_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RuleListResult" title="com.vmware.nsx_policy.model_client.RuleListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RuleListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.RuleListResult</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.patch">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">gateway_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">rule</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.patch" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>gateway_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.revise">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">revise</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">gateway_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">rule</span></em>, <em class="sig-param"><span class="n">anchor_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.revise" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>This is used to re-order a gateway rule within a gateway policy.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>gateway_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a>) – (required)</p></li>
<li><p><strong>anchor_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The security policy/rule path if operation is ‘insert_after’ or
‘insert_before’ (optional)</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Rule</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.update">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">gateway_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">rule</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Rules.update" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>gateway_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Rule</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Statistics">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.gateway_policies_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Statistics" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.Statistics.list">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">gateway_policy_id</span></em>, <em class="sig-param"><span class="n">enforcement_point_path</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.Statistics.list" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>gateway_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>enforcement_point_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SecurityPolicyStatisticsListResult</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.gateway_policies_client.StubFactory">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.gateway_policies_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.gateway_policies_client.StubFactory" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.domains.groups_client">
<span id="com-vmware-nsx-policy-infra-domains-groups-client-module"></span><h2>com.vmware.nsx_policy.infra.domains.groups_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.domains.groups_client" title="Permalink to this headline"></a></h2>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">ExternalIdExpressions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_ADD">
<code class="sig-name descname">CREATE_ACTION_ADD</code><em class="property"> = 'add'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_ADD" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.ExternalIdExpressions.create" title="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalIdExpressions.create()</span></code></a>.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd></dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_REMOVE">
<code class="sig-name descname">CREATE_ACTION_REMOVE</code><em class="property"> = 'remove'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.CREATE_ACTION_REMOVE" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.ExternalIdExpressions.create" title="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">ExternalIdExpressions.create()</span></code></a>.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd></dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dl class="py method">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">group_member_list</span></em>, <em class="sig-param"><span class="n">action</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.create" title="Permalink to this definition"></a></dt>
<dd><p>It will add or remove the specified members having external ID for a
given expression of a group.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><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)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add or Remove group members. (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete Group External ID Expression</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ExternalIDExpression ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">external_id_expression</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.ExternalIdExpressions.patch" title="Permalink to this definition"></a></dt>
<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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ExternalIDExpression ID (required)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">GroupMonitoringProfileBindingMaps</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">group_monitoring_profile_binding_map_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.delete" title="Permalink to this definition"></a></dt>
<dd><p>API will delete Group Monitoring Profile Binding</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">group_monitoring_profile_binding_map_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.get" title="Permalink to this definition"></a></dt>
<dd><p>API will get Group Monitoring Profile Binding Map</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain-ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Return type</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-odd">Returns</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-odd"><p>com.vmware.nsx_policy.model.GroupMonitoringProfileBindingMap</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.list" title="Permalink to this definition"></a></dt>
<dd><p>API will list all Group Monitoring Profile Binding Maps in current
group id.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-odd">Returns</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-odd"><p>com.vmware.nsx_policy.model.GroupMonitoringProfileBindingMapListResult</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">group_monitoring_profile_binding_map_id</span></em>, <em class="sig-param"><span class="n">group_monitoring_profile_binding_map</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.patch" title="Permalink to this definition"></a></dt>
<dd><p>API will create group monitoring profile binding map</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><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)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">group_monitoring_profile_binding_map_id</span></em>, <em class="sig-param"><span class="n">group_monitoring_profile_binding_map</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.GroupMonitoringProfileBindingMaps.update" title="Permalink to this definition"></a></dt>
<dd><p>API will update Group Monitoring Profile Binding Map</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – DomainID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><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)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Return type</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-odd">Returns</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-odd"><p>com.vmware.nsx_policy.model.GroupMonitoringProfileBindingMap</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">IpAddressExpressions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_ADD">
<code class="sig-name descname">CREATE_ACTION_ADD</code><em class="property"> = 'add'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_ADD" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.IpAddressExpressions.create" title="com.vmware.nsx_policy.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>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_REMOVE">
<code class="sig-name descname">CREATE_ACTION_REMOVE</code><em class="property"> = 'remove'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.CREATE_ACTION_REMOVE" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.IpAddressExpressions.create" title="com.vmware.nsx_policy.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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">ip_address_list</span></em>, <em class="sig-param"><span class="n">action</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.create" title="Permalink to this definition"></a></dt>
<dd><p>It will add or remove the specified IP Addresses from a given
expression of a group.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><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)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add or Remove group members. (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete Group IPAddressExpression</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IPAddressExpression ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">ip_address_expression</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.IpAddressExpressions.patch" title="Permalink to this definition"></a></dt>
<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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IPAddressExpression ID (required)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">MacAddressExpressions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_ADD">
<code class="sig-name descname">CREATE_ACTION_ADD</code><em class="property"> = 'add'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_ADD" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.MacAddressExpressions.create" title="com.vmware.nsx_policy.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>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_REMOVE">
<code class="sig-name descname">CREATE_ACTION_REMOVE</code><em class="property"> = 'remove'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.CREATE_ACTION_REMOVE" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.MacAddressExpressions.create" title="com.vmware.nsx_policy.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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">m_ac_address_list</span></em>, <em class="sig-param"><span class="n">action</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.create" title="Permalink to this definition"></a></dt>
<dd><p>It will add or remove the specified MAC Addresses from a given
expression of a group.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><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)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add or Remove group members. (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete Group MACAddressExpression</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – MACAddressExpression ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">m_ac_address_expression</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MacAddressExpressions.patch" title="Permalink to this definition"></a></dt>
<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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – MACAddressExpression ID (required)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MemberTypes">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">MemberTypes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MemberTypes" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.MemberTypes.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.MemberTypes.get" title="Permalink to this definition"></a></dt>
<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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-odd">Returns</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-odd"><p>com.vmware.nsx_policy.model.GroupMemberTypeListResult</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
</dd></dl>
<dl class="py class">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">PathExpressions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.CREATE_ACTION_ADD">
<code class="sig-name descname">CREATE_ACTION_ADD</code><em class="property"> = 'add'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.CREATE_ACTION_ADD" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.PathExpressions.create" title="com.vmware.nsx_policy.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>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.CREATE_ACTION_REMOVE">
<code class="sig-name descname">CREATE_ACTION_REMOVE</code><em class="property"> = 'remove'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.CREATE_ACTION_REMOVE" title="Permalink to this definition"></a></dt>
<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.infra.domains.groups_client.PathExpressions.create" title="com.vmware.nsx_policy.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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.create">
<code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">group_member_list</span></em>, <em class="sig-param"><span class="n">action</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.create" title="Permalink to this definition"></a></dt>
<dd><p>It will add or remove the specified members having path for a given
expression of a group.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><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)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Add or Remove group members. (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete Group Path Expression</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – PathExpression ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">expression_id</span></em>, <em class="sig-param"><span class="n">path_expression</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PathExpressions.patch" title="Permalink to this definition"></a></dt>
<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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>expression_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – PathExpression ID (required)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">PortMirroringInstances</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.delete">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">port_mirroring_instance_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.delete" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05: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>/&lt;policy-mgr&gt;/policy/api/v1/infra/port-mirroring-profiles</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
<li><p><strong>port_mirroring_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Mirroring Instance Id (required)</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.get">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">port_mirroring_instance_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.get" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05: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>/&lt;policy-mgr&gt;/policy/api/v1/infra/port-mirroring-profiles</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
<li><p><strong>port_mirroring_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Mirroring Instance Id (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMirroringInstance" title="com.vmware.nsx_policy.model_client.PortMirroringInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMirroringInstance</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PortMirroringInstance</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.list">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.list" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05: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>/&lt;policy-mgr&gt;/policy/api/v1/infra/port-mirroring-profiles</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult" title="com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PortMirroringInstanceListResult</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.patch">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">port_mirroring_instance_id</span></em>, <em class="sig-param"><span class="n">port_mirroring_instance</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.patch" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05: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>/&lt;policy-mgr&gt;/policy/api/v1/infra/port-mirroring-profiles</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
<li><p><strong>port_mirroring_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Mirroring Instance Id (required)</p></li>
<li><p><strong>port_mirroring_instance</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMirroringInstance" title="com.vmware.nsx_policy.model_client.PortMirroringInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMirroringInstance</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.update">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em>, <em class="sig-param"><span class="n">port_mirroring_instance_id</span></em>, <em class="sig-param"><span class="n">port_mirroring_instance</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.PortMirroringInstances.update" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05: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>/&lt;policy-mgr&gt;/policy/api/v1/infra/port-mirroring-profiles</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group ID (required)</p></li>
<li><p><strong>port_mirroring_instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Port Mirroring Instance Id (required)</p></li>
<li><p><strong>port_mirroring_instance</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMirroringInstance" title="com.vmware.nsx_policy.model_client.PortMirroringInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMirroringInstance</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.PortMirroringInstance" title="com.vmware.nsx_policy.model_client.PortMirroringInstance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.PortMirroringInstance</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.PortMirroringInstance</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.StubFactory">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.StubFactory" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.Tags">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.groups_client.</code><code class="sig-name descname">Tags</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.Tags" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.groups_client.Tags.get">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">group_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.groups_client.Tags.get" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Get tags used to define conditions inside a Group. Also includes tags
inside nested groups.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain id (required)</p></li>
<li><p><strong>group_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Group Id (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.GroupTagsList</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<div class="section" id="module-com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client">
<span id="com-vmware-nsx-policy-infra-domains-intrusion-service-policies-client-module"></span><h2>com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client" title="Permalink to this headline"></a></h2>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.</code><code class="sig-name descname">Rules</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_AFTER">
<code class="sig-name descname">REVISE_OPERATION_AFTER</code><em class="property"> = 'insert_after'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_AFTER" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BEFORE">
<code class="sig-name descname">REVISE_OPERATION_BEFORE</code><em class="property"> = 'insert_before'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BEFORE" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BOTTOM">
<code class="sig-name descname">REVISE_OPERATION_BOTTOM</code><em class="property"> = 'insert_bottom'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_BOTTOM" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
<dl class="py attribute">
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_TOP">
<code class="sig-name descname">REVISE_OPERATION_TOP</code><em class="property"> = 'insert_top'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.REVISE_OPERATION_TOP" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.delete">
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete intrusion detection rule.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Policy ID (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Rule ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.get" title="Permalink to this definition"></a></dt>
<dd><p>Read intrusion detection rule</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Policy ID (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Rule ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Return type</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-odd">Returns</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-odd"><p>com.vmware.nsx_policy.model.IdsRule</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">policy_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.list" title="Permalink to this definition"></a></dt>
<dd><p>List intrusion detection rules.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Policy ID (required)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-odd">Returns</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-odd"><p>com.vmware.nsx_policy.model.IdsRuleListResult</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">ids_rule</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.patch" title="Permalink to this definition"></a></dt>
<dd><p>Patch intrusion detection system rule.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Policy ID (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Rule ID (required)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.revise">
<code class="sig-name descname">revise</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">ids_rule</span></em>, <em class="sig-param"><span class="n">anchor_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.revise" title="Permalink to this definition"></a></dt>
<dd><p>This is used to re-order a rule within a security policy.</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><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)</p></li>
<li><p><strong>anchor_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The security policy/rule path if operation is ‘insert_after’ or
‘insert_before’ (optional)</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.IdsRule</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">ids_rule</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.Rules.update" title="Permalink to this definition"></a></dt>
<dd><p>Update intrusion detection system rule.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain ID (required)</p></li>
<li><p><strong>policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Policy ID (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Rule ID (required)</p></li>
<li><p><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)</p></li>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</ul>
</dd>
<dt class="field-even">Return type</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-odd">Returns</dt>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dd class="field-odd"><p>com.vmware.nsx_policy.model.IdsRule</p>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
<dt id="com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.intrusion_service_policies_client.StubFactory" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.domains.security_policies_client">
<span id="com-vmware-nsx-policy-infra-domains-security-policies-client-module"></span><h2>com.vmware.nsx_policy.infra.domains.security_policies_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.domains.security_policies_client" title="Permalink to this headline"></a></h2>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.security_policies_client.</code><code class="sig-name descname">Rules</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_AFTER">
<code class="sig-name descname">REVISE_OPERATION_AFTER</code><em class="property"> = 'insert_after'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_AFTER" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_BEFORE">
<code class="sig-name descname">REVISE_OPERATION_BEFORE</code><em class="property"> = 'insert_before'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_BEFORE" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_BOTTOM">
<code class="sig-name descname">REVISE_OPERATION_BOTTOM</code><em class="property"> = 'insert_bottom'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_BOTTOM" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py attribute">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_TOP">
<code class="sig-name descname">REVISE_OPERATION_TOP</code><em class="property"> = 'insert_top'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.REVISE_OPERATION_TOP" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">operation</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.revise" title="com.vmware.nsx_policy.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>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.delete">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">security_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.delete" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Delete rule</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>security_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.get">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">security_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.get" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Read rule</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>security_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Rule</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.list">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">security_policy_id</span></em>, <em class="sig-param"><span class="n">cursor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">include_mark_for_delete_objects</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">included_fields</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">page_size</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_ascending</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sort_by</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.list" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>List rules</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>security_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>cursor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Opaque cursor to be used for getting next page of records (supplied
by current result page) (optional)</p></li>
<li><p><strong>include_mark_for_delete_objects</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Include objects that are marked for deletion in results (optional,
default to false)</p></li>
<li><p><strong>included_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Comma separated list of fields that should be included in query
result (optional)</p></li>
<li><p><strong>page_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of results to return in this page (server may return
fewer) (optional, default to 1000)</p></li>
<li><p><strong>sort_ascending</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – (optional)</p></li>
<li><p><strong>sort_by</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.RuleListResult" title="com.vmware.nsx_policy.model_client.RuleListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.RuleListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.RuleListResult</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.patch">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">security_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">rule</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.patch" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>security_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.revise">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">revise</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">security_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">rule</span></em>, <em class="sig-param"><span class="n">anchor_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.revise" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>This is used to re-order a rule within a security policy.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>security_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a>) – (required)</p></li>
<li><p><strong>anchor_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The security policy/rule path if operation is ‘insert_after’ or
‘insert_before’ (optional)</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Operation (optional, default to insert_top)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Rule</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.update">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">security_policy_id</span></em>, <em class="sig-param"><span class="n">rule_id</span></em>, <em class="sig-param"><span class="n">rule</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Rules.update" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>security_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – (required)</p></li>
<li><p><strong>rule</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a>) – (required)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.Rule" title="com.vmware.nsx_policy.model_client.Rule"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.Rule</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.Rule</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Statistics">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.security_policies_client.</code><code class="sig-name descname">Statistics</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Statistics" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py method">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.Statistics.list">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">domain_id</span></em>, <em class="sig-param"><span class="n">security_policy_id</span></em>, <em class="sig-param"><span class="n">enforcement_point_path</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.Statistics.list" title="Permalink to this definition"></a></dt>
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>domain_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Domain id (required)</p></li>
<li><p><strong>security_policy_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Security policy id (required)</p></li>
<li><p><strong>enforcement_point_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.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>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.SecurityPolicyStatisticsListResult</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code>
Service Unavailable</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Bad Request, Precondition Failed</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code>
Internal Server Error</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<dl class="py class">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<dt id="com.vmware.nsx_policy.infra.domains.security_policies_client.StubFactory">
Upgrade NSX SDKs to VMC 1.11 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-06-05 18:48:31 -04:00
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.domains.security_policies_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.domains.security_policies_client.StubFactory" title="Permalink to this definition"></a></dt>
add vsphere, vmc and nsx API docs
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>
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
<p>Initialize StubFactoryBase</p>
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
add vsphere, vmc and nsx API docs
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">
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
<a href="com.vmware.nsx_policy.infra.domains.gateway_policies.html" class="btn btn-neutral float-right" title="com.vmware.nsx_policy.infra.domains.gateway_policies package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
<a href="com.vmware.nsx_policy.infra.html" class="btn btn-neutral float-left" title="com.vmware.nsx_policy.infra package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</div>
<hr/>
<div role="contentinfo">
<p>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Update NSX documentation to M9 Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 14:28:46 -05:00
&copy; Copyright 2020, VMware, Inc.
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</p>
</div>
Upgrade NSX SDKs to VMC 1.12 release Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-09-21 16:47:14 -04:00
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
Upgrade NSX docs to M5P1 (nsx version 2.3.0.0.1.10604709) Signed-off-by: Gordon Good <ggood@vmware.com>
2018-11-01 14:01:54 -04:00
SphinxRtdTheme.Navigation.enable(true);
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
});
Update NSX documentation to M7 Signed-Off-By: Gordon Good <ggood@vmware.com>
2019-05-29 14:05:24 -04:00
</script>
add vsphere, vmc and nsx API docs
2018-08-07 19:42:25 -04:00
</body>
</html>
Copy Permalink