diff options
Diffstat (limited to 'docs/vyos.vyos.vyos_firewall_rules_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_firewall_rules_module.rst | 1996 |
1 files changed, 998 insertions, 998 deletions
diff --git a/docs/vyos.vyos.vyos_firewall_rules_module.rst b/docs/vyos.vyos.vyos_firewall_rules_module.rst index 647f8353..15073b1e 100644 --- a/docs/vyos.vyos.vyos_firewall_rules_module.rst +++ b/docs/vyos.vyos.vyos_firewall_rules_module.rst @@ -31,1281 +31,1287 @@ Parameters <tr> <th colspan="6">Parameter</th> <th>Choices/<font color="blue">Defaults</font></th> - <th width="100%">Comments</th> + <th width="100%">Comments</th> </tr> - <tr> - <td colspan="6"> + <tr> + <td colspan="6"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>config</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - / <span style="color: purple">elements=dictionary</span> </div> - </td> - <td> - </td> - <td> - <div>A dictionary of Firewall rule-set options.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="5"> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A dictionary of Firewall rule-set options.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>afi</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>ipv4</li> - <li>ipv6</li> - </ul> - </td> - <td> - <div>Specifies the type of rule-set.</div> - </td> + / <span style="color: red">required</span> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>ipv4</li> + <li>ipv6</li> + </ul> + </td> + <td> + <div>Specifies the type of rule-set.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td colspan="5"> + <tr> + <td class="elbow-placeholder"></td> + <td colspan="5"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>rule_sets</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - / <span style="color: purple">elements=dictionary</span> </div> - </td> - <td> - </td> - <td> - <div>The Firewall rule-set list.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="4"> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>The Firewall rule-set list.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>default_action</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>drop</li> - <li>reject</li> - <li>accept</li> - </ul> - </td> - <td> - <div>Default action for rule-set.</div> - <div>drop (Drop if no prior rules are hit (default))</div> - <div>reject (Drop and notify source if no prior rules are hit)</div> - <div>accept (Accept if no prior rules are hit)</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="4"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>drop</li> + <li>reject</li> + <li>accept</li> + </ul> + </td> + <td> + <div>Default action for rule-set.</div> + <div>drop (Drop if no prior rules are hit (default))</div> + <div>reject (Drop and notify source if no prior rules are hit)</div> + <div>accept (Accept if no prior rules are hit)</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>description</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Rule set description.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>Rule set description.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="4"> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>enable_default_log</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Option to log packets hitting default-action.</div> - </td> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Option to log packets hitting default-action.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="4"> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Firewall rule set name.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>Firewall rule set name.</div> + </td> </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="4"> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="4"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>rules</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - / <span style="color: purple">elements=dictionary</span> </div> - </td> - <td> - </td> - <td> - <div>A ditionary that specifies the rule-set configurations.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>A ditionary that specifies the rule-set configurations.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>action</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>drop</li> - <li>reject</li> - <li>accept</li> - <li>inspect</li> - </ul> - </td> - <td> - <div>Specifying the action.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>drop</li> + <li>reject</li> + <li>accept</li> + <li>inspect</li> + </ul> + </td> + <td> + <div>Specifying the action.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>description</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Description of this rule.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + </td> + <td> + <div>Description of this rule.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>destination</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Specifying the destination parameters.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Specifying the destination parameters.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>address</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Destination ip address subnet or range.</div> - <div>IPv4/6 address, subnet or range to match.</div> - <div>Match everything except the specified address, subnet or range.</div> - <div>Destination ip address subnet or range.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Destination ip address subnet or range.</div> + <div>IPv4/6 address, subnet or range to match.</div> + <div>Match everything except the specified address, subnet or range.</div> + <div>Destination ip address subnet or range.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Destination group.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>Destination group.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>address_group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Group of addresses.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>Group of addresses.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>network_group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Group of networks.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>Group of networks.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>port_group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Group of ports.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Group of ports.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>port</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Multiple destination ports can be specified as a comma-separated list.</div> - <div>The whole list can also be "negated" using '!'.</div> - <div>For example:'!22,telnet,http,123,1001-1005'.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + </td> + <td> + <div>Multiple destination ports can be specified as a comma-separated list.</div> + <div>The whole list can also be "negated" using '!'.</div> + <div>For example:'!22,telnet,http,123,1001-1005'.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>disabled</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Option to disable firewall rule.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Option to disable firewall rule.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>fragment</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>match-frag</li> - <li>match-non-frag</li> - </ul> - </td> - <td> - <div>IP fragment match.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>match-frag</li> + <li>match-non-frag</li> + </ul> + </td> + <td> + <div>IP fragment match.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>icmp</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>ICMP type and code information.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>ICMP type and code information.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>code</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>ICMP code.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>ICMP code.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>type</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>ICMP type.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>ICMP type.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>type_name</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>any</li> - <li>echo-reply</li> - <li>destination-unreachable</li> - <li>network-unreachable</li> - <li>host-unreachable</li> - <li>protocol-unreachable</li> - <li>port-unreachable</li> - <li>fragmentation-needed</li> - <li>source-route-failed</li> - <li>network-unknown</li> - <li>host-unknown</li> - <li>network-prohibited</li> - <li>host-prohibited</li> - <li>TOS-network-unreachable</li> - <li>TOS-host-unreachable</li> - <li>communication-prohibited</li> - <li>host-precedence-violation</li> - <li>precedence-cutoff</li> - <li>source-quench</li> - <li>redirect</li> - <li>network-redirect</li> - <li>host-redirect</li> - <li>TOS-network-redirect</li> - <li>TOS-host-redirect</li> - <li>echo-request</li> - <li>router-advertisement</li> - <li>router-solicitation</li> - <li>time-exceeded</li> - <li>ttl-zero-during-transit</li> - <li>ttl-zero-during-reassembly</li> - <li>parameter-problem</li> - <li>ip-header-bad</li> - <li>required-option-missing</li> - <li>timestamp-request</li> - <li>timestamp-reply</li> - <li>address-mask-request</li> - <li>address-mask-reply</li> - <li>ping</li> - <li>pong</li> - <li>ttl-exceeded</li> - </ul> - </td> - <td> - <div>ICMP type-name.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>any</li> + <li>echo-reply</li> + <li>destination-unreachable</li> + <li>network-unreachable</li> + <li>host-unreachable</li> + <li>protocol-unreachable</li> + <li>port-unreachable</li> + <li>fragmentation-needed</li> + <li>source-route-failed</li> + <li>network-unknown</li> + <li>host-unknown</li> + <li>network-prohibited</li> + <li>host-prohibited</li> + <li>TOS-network-unreachable</li> + <li>TOS-host-unreachable</li> + <li>communication-prohibited</li> + <li>host-precedence-violation</li> + <li>precedence-cutoff</li> + <li>source-quench</li> + <li>redirect</li> + <li>network-redirect</li> + <li>host-redirect</li> + <li>TOS-network-redirect</li> + <li>TOS-host-redirect</li> + <li>echo-request</li> + <li>router-advertisement</li> + <li>router-solicitation</li> + <li>time-exceeded</li> + <li>ttl-zero-during-transit</li> + <li>ttl-zero-during-reassembly</li> + <li>parameter-problem</li> + <li>ip-header-bad</li> + <li>required-option-missing</li> + <li>timestamp-request</li> + <li>timestamp-reply</li> + <li>address-mask-request</li> + <li>address-mask-reply</li> + <li>ping</li> + <li>pong</li> + <li>ttl-exceeded</li> + </ul> + </td> + <td> + <div>ICMP type-name.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>ipsec</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>match-ipsec</li> - <li>match-none</li> - </ul> - </td> - <td> - <div>Inboud ip sec packets.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>match-ipsec</li> + <li>match-none</li> + </ul> + </td> + <td> + <div>Inboud ip sec packets.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>limit</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Rate limit using a token bucket filter.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Rate limit using a token bucket filter.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>burst</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Maximum number of packets to allow in excess of rate.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Maximum number of packets to allow in excess of rate.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>rate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>format for rate (integer/time unit).</div> - <div>any one of second, minute, hour or day may be used to specify time unit.</div> - <div>eg. 1/second implies rule to be matched at an average of once per second.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>format for rate (integer/time unit).</div> + <div>any one of second, minute, hour or day may be used to specify time unit.</div> + <div>eg. 1/second implies rule to be matched at an average of once per second.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>number</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>This is the integer value.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>This is the integer value.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>unit</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>This is the time unit.</div> - </td> - </tr> - - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + </td> + <td> + <div>This is the time unit.</div> + </td> + </tr> + + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>number</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - / <span style="color: red">required</span> </div> - </td> - <td> - </td> - <td> - <div>Rule number.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + / <span style="color: red">required</span> + </div> + </td> + <td> + </td> + <td> + <div>Rule number.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>p2p</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">list</span> - / <span style="color: purple">elements=dictionary</span> </div> - </td> - <td> - </td> - <td> - <div>P2P application packets.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + / <span style="color: purple">elements=dictionary</span> + </div> + </td> + <td> + </td> + <td> + <div>P2P application packets.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>application</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>all</li> - <li>applejuice</li> - <li>bittorrent</li> - <li>directconnect</li> - <li>edonkey</li> - <li>gnutella</li> - <li>kazaa</li> - </ul> - </td> - <td> - <div>Name of the application.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>all</li> + <li>applejuice</li> + <li>bittorrent</li> + <li>directconnect</li> + <li>edonkey</li> + <li>gnutella</li> + <li>kazaa</li> + </ul> + </td> + <td> + <div>Name of the application.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>protocol</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Protocol to match (protocol name in /etc/protocols or protocol number or all).</div> - <div><text> IP protocol name from /etc/protocols (e.g. "tcp" or "udp").</div> - <div><0-255> IP protocol number.</div> - <div>tcp_udp Both TCP and UDP.</div> - <div>all All IP protocols.</div> - <div>(!)All IP protocols except for the specified name or number.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + </td> + <td> + <div>Protocol to match (protocol name in /etc/protocols or protocol number or all).</div> + <div><text> IP protocol name from /etc/protocols (e.g. "tcp" or "udp").</div> + <div><0-255> IP protocol number.</div> + <div>tcp_udp Both TCP and UDP.</div> + <div>all All IP protocols.</div> + <div>(!)All IP protocols except for the specified name or number.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>recent</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Parameters for matching recently seen sources.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Parameters for matching recently seen sources.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>count</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Source addresses seen more than N times.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Source addresses seen more than N times.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>time</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">integer</span> - </div> - </td> - <td> - </td> - <td> - <div>Source addresses seen in the last N seconds.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + </td> + <td> + <div>Source addresses seen in the last N seconds.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>source</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Source parameters.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Source parameters.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>address</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Source ip address subnet or range.</div> - <div>IPv4/6 address, subnet or range to match.</div> - <div>Match everything except the specified address, subnet or range.</div> - <div>Source ip address subnet or range.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Source ip address subnet or range.</div> + <div>IPv4/6 address, subnet or range to match.</div> + <div>Match everything except the specified address, subnet or range.</div> + <div>Source ip address subnet or range.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Source group.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>Source group.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>address_group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Group of addresses.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>Group of addresses.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>network_group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Group of networks.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="1"> + </div> + </td> + <td> + </td> + <td> + <div>Group of networks.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="1"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>port_group</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Group of ports.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Group of ports.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>mac_address</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div><MAC address> MAC address to match.</div> - <div><!MAC address> Match everything except the specified MAC address.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div><MAC address> MAC address to match.</div> + <div><!MAC address> Match everything except the specified MAC address.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>port</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Multiple source ports can be specified as a comma-separated list.</div> - <div>The whole list can also be "negated" using '!'.</div> - <div>For example:'!22,telnet,http,123,1001-1005'.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + </td> + <td> + <div>Multiple source ports can be specified as a comma-separated list.</div> + <div>The whole list can also be "negated" using '!'.</div> + <div>For example:'!22,telnet,http,123,1001-1005'.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Session state.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Session state.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>established</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Established state.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Established state.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>invalid</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Invalid state.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Invalid state.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>new</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>New state.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>New state.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>related</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Related state.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Related state.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>tcp</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>TCP flags to match.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>TCP flags to match.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>flags</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>TCP flags to be matched.</div> - </td> - </tr> - - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="3"> + </div> + </td> + <td> + </td> + <td> + <div>TCP flags to be matched.</div> + </td> + </tr> + + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>time</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">dictionary</span> - </div> - </td> - <td> - </td> - <td> - <div>Time to match rule.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Time to match rule.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>monthdays</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Monthdays to match rule on.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Monthdays to match rule on.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>startdate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Date to start matching rule.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Date to start matching rule.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>starttime</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Time of day to start matching rule.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Time of day to start matching rule.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>stopdate</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Date to stop matching rule.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Date to stop matching rule.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>stoptime</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Time of day to stop matching rule.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + </td> + <td> + <div>Time of day to stop matching rule.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>utc</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">boolean</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li>no</li> - <li>yes</li> - </ul> - </td> - <td> - <div>Interpret times for startdate, stopdate, starttime and stoptime to be UTC.</div> - </td> - </tr> - <tr> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td class="elbow-placeholder"></td> - <td colspan="2"> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li>no</li> + <li>yes</li> + </ul> + </td> + <td> + <div>Interpret times for startdate, stopdate, starttime and stoptime to be UTC.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="2"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>weekdays</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>Weekdays to match rule on.</div> - </td> - </tr> - - - - - <tr> - <td colspan="6"> + </div> + </td> + <td> + </td> + <td> + <div>Weekdays to match rule on.</div> + </td> + </tr> + + + + + <tr> + <td colspan="6"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>running_config</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div>This option is used only with state <em>parsed</em>.</div> - <div>The value of this option should be the output received from the VyOS device by executing the command <b>show configuration commands | grep firewall</b>.</div> - <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> - </td> + </div> + </td> + <td> + </td> + <td> + <div>This option is used only with state <em>parsed</em>.</div> + <div>The value of this option should be the output received from the VyOS device by executing the command <b>show configuration commands | grep firewall</b>.</div> + <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> + </td> </tr> - <tr> - <td colspan="6"> + <tr> + <td colspan="6"> <div class="ansibleOptionAnchor" id="parameter-"></div> <b>state</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - </div> - </td> - <td> - <ul style="margin: 0; padding: 0"><b>Choices:</b> - <li><div style="color: blue"><b>merged</b> ←</div></li> - <li>replaced</li> - <li>overridden</li> - <li>deleted</li> - <li>gathered</li> - <li>rendered</li> - <li>parsed</li> - </ul> - </td> - <td> - <div>The state the configuration should be left in</div> - </td> - </tr> - </table> + </div> + </td> + <td> + <ul style="margin: 0; padding: 0"><b>Choices:</b> + <li><div style="color: blue"><b>merged</b> ←</div></li> + <li>replaced</li> + <li>overridden</li> + <li>deleted</li> + <li>gathered</li> + <li>rendered</li> + <li>parsed</li> + </ul> + </td> + <td> + <div>The state the configuration should be left in</div> + </td> + </tr> + </table> <br/> @@ -1323,7 +1329,6 @@ Examples .. code-block:: yaml+jinja - # Using deleted to delete firewall rules based on rule-set name # # Before state @@ -2356,9 +2361,6 @@ Examples - - - Return Values ------------- Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: @@ -2371,60 +2373,60 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <th>Returned</th> <th width="100%">Description</th> </tr> - <tr> - <td colspan="1"> + <tr> + <td colspan="1"> <div class="ansibleOptionAnchor" id="return-"></div> <b>after</b> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> - </td> + </div> + </td> <td>when changed</td> <td> - <div>The resulting configuration model invocation.</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format + <div>The resulting configuration model invocation.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format of the parameters above.</div> - </td> + </td> </tr> - <tr> - <td colspan="1"> + <tr> + <td colspan="1"> <div class="ansibleOptionAnchor" id="return-"></div> <b>before</b> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> - </td> + </div> + </td> <td>always</td> <td> - <div>The configuration prior to the model invocation.</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format + <div>The configuration prior to the model invocation.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">The configuration returned will always be in the same format of the parameters above.</div> - </td> + </td> </tr> - <tr> - <td colspan="1"> + <tr> + <td colspan="1"> <div class="ansibleOptionAnchor" id="return-"></div> <b>commands</b> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <div style="font-size: small"> <span style="color: purple">list</span> - </div> - </td> + </div> + </td> <td>always</td> <td> - <div>The set of commands pushed to the remote device.</div> - <br/> - <div style="font-size: smaller"><b>Sample:</b></div> - <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">["set firewall name Downlink default-action 'accept'", "set firewall name Downlink description 'IPv4 INBOUND rule set'", "set firewall name Downlink rule 501 action 'accept'", "set firewall name Downlink rule 502 description 'Rule 502 is configured by Ansible'", "set firewall name Downlink rule 502 ipsec 'match-ipsec'"]</div> - </td> + <div>The set of commands pushed to the remote device.</div> + <br/> + <div style="font-size: smaller"><b>Sample:</b></div> + <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">["set firewall name Downlink default-action 'accept'", "set firewall name Downlink description 'IPv4 INBOUND rule set'", "set firewall name Downlink rule 501 action 'accept'", "set firewall name Downlink rule 502 description 'Rule 502 is configured by Ansible'", "set firewall name Downlink rule 502 ipsec 'match-ipsec'"]</div> + </td> </tr> - </table> + </table> <br/><br/> @@ -2436,5 +2438,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - |