<spanid="com-vmware-nsx-policy-infra-settings-package"></span><h1>com.vmware.nsx_policy.infra.settings package<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.settings"title="Permalink to this headline">¶</a></h1>
<spanid="com-vmware-nsx-policy-infra-settings-firewall-client-module"></span><h2>com.vmware.nsx_policy.infra.settings.firewall_client module<aclass="headerlink"href="#module-com.vmware.nsx_policy.infra.settings.firewall_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><codeclass="sig-name descname">CpuMemThresholdsProfileBindingMaps</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfileBindingMaps"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cpu_mem_thresholds_profile_binding_map_id</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfileBindingMaps.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>API will delete Firewall CPU Memory Thresholds Profile Binding.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cpu_mem_thresholds_profile_binding_map_id</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfileBindingMaps.get"title="Permalink to this definition">¶</a></dt>
<dd><p>API will get Firewall CPU Memory Thresholds Profile Binding Map.</p>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cursor</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">include_mark_for_delete_objects</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">included_fields</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">page_size</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_ascending</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_by</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfileBindingMaps.list"title="Permalink to this definition">¶</a></dt>
<dd><p>API will list all Firewall CPU Memory Thresholds Profile Binding Maps.</p>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of results to return in this page (server may return
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cpu_mem_thresholds_profile_binding_map_id</span></em>, <emclass="sig-param"><spanclass="n">policy_firewall_cpu_mem_thresholds_profile_binding_map</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfileBindingMaps.patch"title="Permalink to this definition">¶</a></dt>
<dd><p>API will create or update Firewall CPU Memory Thresholds Profile
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cpu_mem_thresholds_profile_binding_map_id</span></em>, <emclass="sig-param"><spanclass="n">policy_firewall_cpu_mem_thresholds_profile_binding_map</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfileBindingMaps.update"title="Permalink to this definition">¶</a></dt>
<dd><p>API will update Firewall CPU Memory Thresholds Profile Binding Map.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><codeclass="sig-name descname">CpuMemThresholdsProfiles</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfiles"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">profile_id</span></em>, <emclass="sig-param"><spanclass="n">override</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfiles.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete CPU and memory thresholds profile.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">profile_id</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfiles.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Read the CPU and memory thresholds profile.</p>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cursor</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">include_mark_for_delete_objects</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">included_fields</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">page_size</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_ascending</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sort_by</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfiles.list"title="Permalink to this definition">¶</a></dt>
<dd><p>List all CPU and memory thresholds profiles.</p>
<li><p><strong>cursor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Maximum number of results to return in this page (server may return
<li><p><strong>sort_by</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Field by which records are sorted (optional)</p></li>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">profile_id</span></em>, <emclass="sig-param"><spanclass="n">policy_firewall_cpu_mem_thresholds_profile</span></em>, <emclass="sig-param"><spanclass="n">override</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfiles.patch"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or update CPU and memory thresholds profile.</p>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">profile_id</span></em>, <emclass="sig-param"><spanclass="n">policy_firewall_cpu_mem_thresholds_profile</span></em>, <emclass="sig-param"><spanclass="n">override</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.CpuMemThresholdsProfiles.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Create or update CPU and memory thresholds profile.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><codeclass="sig-name descname">Security</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.Security"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<codeclass="sig-name descname">patch</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">dfw_firewall_configuration</span></em><spanclass="sig-paren">)</span><aclass="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>
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">dfw_firewall_configuration</span></em><spanclass="sig-paren">)</span><aclass="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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><codeclass="sig-name descname">Stats</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">RESET_CATEGORY_DFW</code><emclass="property"> = 'DFW'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset"title="com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Stats.reset()</span></code></a>.</p>
<codeclass="sig-name descname">RESET_CATEGORY_EDGE</code><emclass="property"> = 'EDGE'</em><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> of method <aclass="reference internal"href="#com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset"title="com.vmware.nsx_policy.infra.settings.firewall_client.Stats.reset"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Stats.reset()</span></code></a>.</p>
<codeclass="sig-name descname">reset</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">category</span></em>, <emclass="sig-param"><spanclass="n">enforcement_point_path</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="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: On global manager, it is mandatory to give an enforcement
point path. On local manager, reset of stats will be executed for each
enforcement point. - {enforcement_point_path}: Reset of stats will be
executed only for the given enforcement point.</p>
<li><p><strong>enforcement_point_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – String Path of the enforcement point (optional)</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.nsx_policy.infra.settings.firewall_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">stub_config</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.nsx_policy.infra.settings.firewall_client.StubFactory"title="Permalink to this definition">¶</a></dt>
