Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00
Code
0c2294f46c
vsphere-automation-sdk-python/vsphere/6.6.1/com.vmware.appliance.techpreview.networking.firewall.html
Tianhao He 9bf9af8207 add vsphere, vmc and nsx API docs
2018-08-07 16:42:25 -07:00

336 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>com.vmware.appliance.techpreview.networking.firewall package &mdash; vSphere Automation SDK for Python 6.6.1 documentation</title>
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '6.6.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 documentation" href="index.html" />
<link rel="up" title="com.vmware.appliance.techpreview.networking package" href="com.vmware.appliance.techpreview.networking.html" />
<link rel="next" title="com.vmware.cis package" href="com.vmware.cis.html" />
<link rel="prev" title="com.vmware.appliance.techpreview.networking package" href="com.vmware.appliance.techpreview.networking.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="com.vmware.cis.html" title="com.vmware.cis package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="com.vmware.appliance.techpreview.networking.html" title="com.vmware.appliance.techpreview.networking package"
accesskey="P">previous</a> |</li>
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</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.appliance.html" >com.vmware.appliance package</a> &raquo;</li>
<li><a href="com.vmware.appliance.techpreview.html" >com.vmware.appliance.techpreview package</a> &raquo;</li>
<li><a href="com.vmware.appliance.techpreview.networking.html" accesskey="U">com.vmware.appliance.techpreview.networking package</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="com-vmware-appliance-techpreview-networking-firewall-package">
<h1>com.vmware.appliance.techpreview.networking.firewall package<a class="headerlink" href="#com-vmware-appliance-techpreview-networking-firewall-package" title="Permalink to this headline"></a></h1>
<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.appliance.techpreview.networking.firewall.addr_client">
<span id="com-vmware-appliance-techpreview-networking-firewall-addr-client-module"></span><h2>com.vmware.appliance.techpreview.networking.firewall.addr_client module<a class="headerlink" href="#module-com.vmware.appliance.techpreview.networking.firewall.addr_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound">
<em class="property">class </em><tt class="descclassname">com.vmware.appliance.techpreview.networking.firewall.addr_client.</tt><tt class="descname">Inbound</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></p>
<p><tt class="docutils literal"><span class="pre">Inbound</span></tt> class provides methods Operations for Firewall rules.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt>) &#8211; Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.DeleteFirewallRule">
<em class="property">class </em><tt class="descname">DeleteFirewallRule</tt><big>(</big><em>position=None</em>, <em>all=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.DeleteFirewallRule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
<p><tt class="docutils literal"><span class="pre">Inbound.DeleteFirewallRule</span></tt> class Structure that defines
networking.firewall.addr.inbound.delete api input argument</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>position</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) &#8211; Position before which to insert the rule (zero-based). If you try
to insert the rule in a position whose number is greater than the
number of rules, the firewall rule is inserted at the end of the
list.</li>
<li><strong>all</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) &#8211; Delete all firewall rules. Set all argument to &#8220;true&#8221; to delete all
rules or set the all argument to &#8220;false&#8221; to delete a single rule.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule">
<em class="property">class </em><tt class="descclassname">Inbound.</tt><tt class="descname">FirewallAddressRule</tt><big>(</big><em>address=None</em>, <em>prefix=None</em>, <em>policy=None</em>, <em>interface_name=None</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></p>
<p><tt class="docutils literal"><span class="pre">Inbound.FirewallAddressRule</span></tt> class Structure that defines a single
address-based firewall rule.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>address</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; IPv4 or IPv6 address.</li>
<li><strong>prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) &#8211; CIDR prefix used to mask address. For example, an IPv4 prefix of 24
ignores the low-order 8 bits of address.</li>
<li><strong>policy</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy" title="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy"><tt class="xref py py-class docutils literal"><span class="pre">Inbound.FirewallRulePolicy</span></tt></a>) &#8211; The allow or deny policy of this rule.</li>
<li><strong>interface_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; The interface to which this rule applies. An empty string or
&#8220;\*&#8221; indicates that the rule applies to all interfaces.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy">
<em class="property">class </em><tt class="descclassname">Inbound.</tt><tt class="descname">FirewallRulePolicy</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></p>
<p><tt class="docutils literal"><span class="pre">Inbound.FirewallRulePolicy</span></tt> class Defines firewall rule policies</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="custom/rst/enumeration.html#enumeration-description"><em>enumerated
type description page</em></a>.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) &#8211; String value for the <tt class="xref py py-class docutils literal"><span class="pre">FirewallRulePolicy</span></tt> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy.allow">
<tt class="descname">allow</tt><em class="property"> = FirewallRulePolicy(string=u'allow')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy.allow" title="Permalink to this definition"></a></dt>
<dd><p>Allow packet with corresponding address.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy.deny">
<tt class="descname">deny</tt><em class="property"> = FirewallRulePolicy(string=u'deny')</em><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallRulePolicy.deny" title="Permalink to this definition"></a></dt>
<dd><p>Deny packet with correpsonding address.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.add">
<tt class="descclassname">Inbound.</tt><tt class="descname">add</tt><big>(</big><em>pos</em>, <em>rule</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.add" title="Permalink to this definition"></a></dt>
<dd><p>Add a firewall rule to allow or deny traffic from incoming IP address.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>pos</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) &#8211; Position before which to insert the rule (zero-based). If you try
to insert the rule in a position whose number is greater than the
number of rules, the firewall rule is inserted at the end of the
list.</li>
<li><strong>rule</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule" title="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule"><tt class="xref py py-class docutils literal"><span class="pre">Inbound.FirewallAddressRule</span></tt></a>) &#8211; Firewall IP-based rule.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
Generic error</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.delete">
<tt class="descclassname">Inbound.</tt><tt class="descname">delete</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete specific rule at a given position or delete all rules.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.DeleteFirewallRule" title="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.DeleteFirewallRule"><tt class="xref py py-class docutils literal"><span class="pre">Inbound.DeleteFirewallRule</span></tt></a>) &#8211; Delete a firewall rule</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.list">
<tt class="descclassname">Inbound.</tt><tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.list" title="Permalink to this definition"></a></dt>
<dd><p>Get ordered list of inbound IP addresses that are allowed or denied by
firewall.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.list" title="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule" title="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule"><tt class="xref py py-class docutils literal"><span class="pre">Inbound.FirewallAddressRule</span></tt></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of address-based firewall rules.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.set">
<tt class="descclassname">Inbound.</tt><tt class="descname">set</tt><big>(</big><em>rules</em><big>)</big><a class="headerlink" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.set" title="Permalink to this definition"></a></dt>
<dd><p>Set list of inbound IP addresses to allow or deny by firewall. This
replaces all existing rules. Firewall rules have no impact on closed
ports because these ports are closed for all traffic.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rules</strong> (<a class="reference internal" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.list" title="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.list"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule" title="com.vmware.appliance.techpreview.networking.firewall.addr_client.Inbound.FirewallAddressRule"><tt class="xref py py-class docutils literal"><span class="pre">Inbound.FirewallAddressRule</span></tt></a>) &#8211; List of address-based firewall rules.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></tt>
Generic error</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.techpreview.networking.firewall">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-com.vmware.appliance.techpreview.networking.firewall" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">com.vmware.appliance.techpreview.networking.firewall package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview.networking.firewall.addr_client">com.vmware.appliance.techpreview.networking.firewall.addr_client module</a></li>
<li><a class="reference internal" href="#module-com.vmware.appliance.techpreview.networking.firewall">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="com.vmware.appliance.techpreview.networking.html"
title="previous chapter">com.vmware.appliance.techpreview.networking package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="com.vmware.cis.html"
title="next chapter">com.vmware.cis package</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/com.vmware.appliance.techpreview.networking.firewall.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="com.vmware.cis.html" title="com.vmware.cis package"
>next</a> |</li>
<li class="right" >
<a href="com.vmware.appliance.techpreview.networking.html" title="com.vmware.appliance.techpreview.networking package"
>previous</a> |</li>
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</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.appliance.html" >com.vmware.appliance package</a> &raquo;</li>
<li><a href="com.vmware.appliance.techpreview.html" >com.vmware.appliance.techpreview package</a> &raquo;</li>
<li><a href="com.vmware.appliance.techpreview.networking.html" >com.vmware.appliance.techpreview.networking package</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014-2017, VMware, Inc. All rights reserved.
</div>
</body>
</html>
View Git Blame Copy Permalink