1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-29 12:00:00 -05:00
vsphere-automation-sdk-python/nsx/nsx_vmc_policy/com.vmware.nsx_policy.infra.settings.html
Gordon Good 49cbaa5a2a Update NSX documentation to M9
Signed-Off-By: Gordon Good <ggood@vmware.com>
2020-01-27 11:28:46 -08:00

434 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.nsx_policy.infra.settings package &mdash; NSX-T Policy API 2.5.1.0.1 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.nsx_policy.infra.settings.firewall package" href="com.vmware.nsx_policy.infra.settings.firewall.html" />
<link rel="prev" title="com.vmware.nsx_policy.infra.service_references package" href="com.vmware.nsx_policy.infra.service_references.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> NSX-T Policy API
</a>
<div class="version">
2.5.1.0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_policy_client">com.vmware.nsx_policy_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.nsx_policy_client_for_vmc">com.vmware.nsx_policy_client_for_vmc module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">NSX-T Policy API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<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.settings package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.nsx_policy.infra.settings.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.settings">
<span id="com-vmware-nsx-policy-infra-settings-package"></span><h1>com.vmware.nsx_policy.infra.settings package<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.settings" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.nsx_policy.infra.settings.firewall.html">com.vmware.nsx_policy.infra.settings.firewall package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.settings.firewall.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.settings.firewall.html#module-com.vmware.nsx_policy.infra.settings.firewall.idfw_client">com.vmware.nsx_policy.infra.settings.firewall.idfw_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.nsx_policy.infra.settings.firewall.html#module-com.vmware.nsx_policy.infra.settings.firewall.security_client">com.vmware.nsx_policy.infra.settings.firewall.security_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.nsx_policy.infra.settings.firewall_client">
<span id="com-vmware-nsx-policy-infra-settings-firewall-client-module"></span><h2>com.vmware.nsx_policy.infra.settings.firewall_client module<a class="headerlink" href="#module-com.vmware.nsx_policy.infra.settings.firewall_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Security">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><code class="sig-name descname">Security</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Security" 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="method">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Security.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Security.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the current dfw firewall configurations.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DfwFirewallConfiguration" title="com.vmware.nsx_policy.model_client.DfwFirewallConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.DfwFirewallConfiguration</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>com.vmware.nsx_policy.model.DfwFirewallConfiguration</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.ServiceUnavailable</span></code>
Service Unavailable</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.InvalidRequest</span></code>
Bad Request, Precondition Failed</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.InternalServerError</span></code>
Internal Server Error</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.Unauthorized</span></code>
Forbidden</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.NotFound</span></code>
Not Found</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Security.patch">
<code class="sig-name descname">patch</code><span class="sig-paren">(</span><em class="sig-param">dfw_firewall_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Security.patch" title="Permalink to this definition"></a></dt>
<dd><p>Update dfw firewall related configurations.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dfw_firewall_configuration</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DfwFirewallConfiguration" title="com.vmware.nsx_policy.model_client.DfwFirewallConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.DfwFirewallConfiguration</span></code></a>) (required)</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="method">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Security.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">dfw_firewall_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Security.update" title="Permalink to this definition"></a></dt>
<dd><p>Update dfw firewall related configurations.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>dfw_firewall_configuration</strong> (<a class="reference internal" href="com.vmware.nsx_policy.html#com.vmware.nsx_policy.model_client.DfwFirewallConfiguration" title="com.vmware.nsx_policy.model_client.DfwFirewallConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.DfwFirewallConfiguration</span></code></a>) (required)</p>
</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.DfwFirewallConfiguration" title="com.vmware.nsx_policy.model_client.DfwFirewallConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.nsx_policy.model_client.DfwFirewallConfiguration</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.nsx_policy.model.DfwFirewallConfiguration</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>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Stats">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><code class="sig-name descname">Stats</code><span class="sig-paren">(</span><em class="sig-param">config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats" 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="attribute">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Stats.RESET_CATEGORY_DFW">
<code class="sig-name descname">RESET_CATEGORY_DFW</code><em class="property"> = 'DFW'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats.RESET_CATEGORY_DFW" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">category</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset" title="com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset"><code class="xref py py-func docutils literal notranslate"><span class="pre">Stats.reset()</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Stats.RESET_CATEGORY_EDGE">
<code class="sig-name descname">RESET_CATEGORY_EDGE</code><em class="property"> = 'EDGE'</em><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats.RESET_CATEGORY_EDGE" title="Permalink to this definition"></a></dt>
<dd><p>Possible value for <code class="docutils literal notranslate"><span class="pre">category</span></code> of method <a class="reference internal" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset" title="com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset"><code class="xref py py-func docutils literal notranslate"><span class="pre">Stats.reset()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset">
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><em class="sig-param">category</em>, <em class="sig-param">enforcement_point_path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset" title="Permalink to this definition"></a></dt>
<dd><p>Sets firewall rule statistics counter to zero. This operation is
supported for given category, for example: DFW i.e. for all layer3
firewall (transport nodes only) rules or EDGE i.e. for all layer3 edge
firewall (edge nodes only) rules. - 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>category</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) Aggregation statistic category (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">Raise</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>
<dl class="class">
<dt id="com.vmware.nsx_policy.infra.settings.firewall_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param">stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.nsx_policy.infra.settings.firewall_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.nsx_policy.infra.settings.firewall.html" class="btn btn-neutral float-right" title="com.vmware.nsx_policy.infra.settings.firewall package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.nsx_policy.infra.service_references.html" class="btn btn-neutral float-left" title="com.vmware.nsx_policy.infra.service_references package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>