From a45e2988263f5109a56b6dcb2c46ecbc6738cb3a Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Thu, 27 Aug 2020 14:58:25 -0400 Subject: Release 1.0.4 (#81) Release 1.0.4 Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_firewall_global_module.rst | 1076 ++++++++++++------------ 1 file changed, 542 insertions(+), 534 deletions(-) (limited to 'docs/vyos.vyos.vyos_firewall_global_module.rst') diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index f7e6462..30f7ecf 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -31,731 +31,743 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
dictionary -
- - - - -
A dictionary of Firewall global configuration options.
- + + + + + +
A dictionary of Firewall global configuration options.
+ - - - + + +
config_trap
boolean -
- - - - - -
SNMP trap generation on firewall configuration changes.
- + + + + + + +
SNMP trap generation on firewall configuration changes.
+ - - - + + +
group
dictionary -
- - - - -
Defines a group of objects for referencing in firewall rules.
- + + + + + +
Defines a group of objects for referencing in firewall rules.
+ - - - - + + + +
address_group
list - / elements=dictionary
- - - - -
Defines a group of IP addresses for referencing in firewall rules.
- + / elements=dictionary + + + + + +
Defines a group of IP addresses for referencing in firewall rules.
+ - - - - - + + + + +
description
string -
- - - - -
Allows you to specify a brief description for the address group.
- + + + + + +
Allows you to specify a brief description for the address group.
+ - - - - - + + + + +
members
list - / elements=dictionary
- - - - -
Address-group members.
-
IPv4 address to match.
-
IPv4 range to match.
- + / elements=dictionary + + + + + +
Address-group members.
+
IPv4 address to match.
+
IPv4 range to match.
+ - - - - - - + + + + + +
address
string -
- - - - -
IP address.
- + + + + + +
IP address.
+ - - - - - - + + + + + +
name
string - / required
- - - - -
Name of the firewall address group.
- + / required + + + + + +
Name of the firewall address group.
+ - - - - - + + + + +
network_group
list - / elements=dictionary
- - - - -
Defines a group of networks for referencing in firewall rules.
- + / elements=dictionary + + + + + +
Defines a group of networks for referencing in firewall rules.
+ - - - - - + + + + +
description
string -
- - - - -
Allows you to specify a brief description for the network group.
- + + + + + +
Allows you to specify a brief description for the network group.
+ - - - - - + + + + +
members
list - / elements=dictionary
- - - - -
Adds an IPv4 network to the specified network group.
-
The format is ip-address/prefix.
- + / elements=dictionary + + + + + +
Adds an IPv4 network to the specified network group.
+
The format is ip-address/prefix.
+ - - - - - - + + + + + +
address
string -
- - - - -
IP address.
- + + + + + +
IP address.
+ - - - - - - + + + + + +
name
string - / required
- - - - -
Name of the firewall network group.
- + / required + + + + + +
Name of the firewall network group.
+ - - - - - + + + + +
port_group
list - / elements=dictionary
- - - - -
Defines a group of ports for referencing in firewall rules.
- + / elements=dictionary + + + + + +
Defines a group of ports for referencing in firewall rules.
+ - - - - - + + + + +
description
string -
- - - - -
Allows you to specify a brief description for the port group.
- + + + + + +
Allows you to specify a brief description for the port group.
+ - - - - - + + + + +
members
list - / elements=dictionary
- - - - -
Port-group member.
- + / elements=dictionary + + + + + +
Port-group member.
+ - - - - - - + + + + + +
port
string -
- - - - -
Defines the number.
- + + + + + +
Defines the number.
+ - - - - - - + + + + + +
name
string - / required
- - - - -
Name of the firewall port group.
- + / required + + + + + +
Name of the firewall port group.
+ - - - - - + + + + +
log_martians
boolean -
- - - - - -
Specifies whether or not to record packets with invalid addresses in the log.
-
(True) Logs packets with invalid addresses.
-
(False) Does not log packets with invalid addresses.
- + + + + + + +
Specifies whether or not to record packets with invalid addresses in the log.
+
(True) Logs packets with invalid addresses.
+
(False) Does not log packets with invalid addresses.
+ - - - + + +
ping
dictionary -
- - - - -
Policy for handling of all IPv4 ICMP echo requests.
- + + + + + +
Policy for handling of all IPv4 ICMP echo requests.
+ - - - - + + + +
all
boolean -
- - - - - -
Enables or disables response to all IPv4 ICMP Echo Request (ping) messages.
-
The system responds to IPv4 ICMP Echo Request messages.
- + + + + + + +
Enables or disables response to all IPv4 ICMP Echo Request (ping) messages.
+
The system responds to IPv4 ICMP Echo Request messages.
+ - - - - + + + +
broadcast
boolean -
- - - - - -
Enables or disables response to broadcast IPv4 ICMP Echo Request and Timestamp Request messages.
-
IPv4 ICMP Echo and Timestamp Request messages are not processed.
- + + + + + + +
Enables or disables response to broadcast IPv4 ICMP Echo Request and Timestamp Request messages.
+
IPv4 ICMP Echo and Timestamp Request messages are not processed.
+ - - - - + + + +
route_redirects
list - / elements=dictionary
- - - - -
-A dictionary of Firewall icmp redirect and source route global configuration options.
- + / elements=dictionary + + + + + +
-A dictionary of Firewall icmp redirect and source route global configuration options.
+ - - - - + + + +
afi
string - / required
- - - - - -
Specifies IP address type
- + / required + + + + + + +
Specifies IP address type
+ - - - - + + + +
icmp_redirects
dictionary -
- - - - -
Specifies whether to allow sending/receiving of IPv4/v6 ICMP redirect messages.
- + + + + + +
Specifies whether to allow sending/receiving of IPv4/v6 ICMP redirect messages.
+ - - - - - + + + + +
receive
boolean -
- - - - - -
Permits or denies receiving packets ICMP redirect messages.
- + + + + + + +
Permits or denies receiving packets ICMP redirect messages.
+ - - - - - + + + + +
send
boolean -
- - - - - -
Permits or denies transmitting packets ICMP redirect messages.
- + + + + + + +
Permits or denies transmitting packets ICMP redirect messages.
+ - - - - - + + + + +
ip_src_route
boolean -
- - - - - -
Specifies whether or not to process source route IP options.
- + + + + + + +
Specifies whether or not to process source route IP options.
+ - - - - + + + +
state_policy
list - / elements=dictionary
- - - - -
Specifies global firewall state-policy.
- + / elements=dictionary + + + + + +
Specifies global firewall state-policy.
+ - - - - + + + +
action
string -
- - - - - -
Action for packets part of an established connection.
- + + + + + + +
Action for packets part of an established connection.
+ - - - - + + + +
connection_type
string -
- - - - - -
Specifies connection type.
- + + + + + + +
Specifies connection type.
+ - - - - + + + +
log
boolean -
- - - - - -
Enable logging of packets part of an established connection.
- + + + + + + +
Enable logging of packets part of an established connection.
+ - - - - + + + +
syn_cookies
boolean -
- - - - - -
Specifies policy for using TCP SYN cookies with IPv4.
-
(True) Enables TCP SYN cookies with IPv4.
-
(False) Disables TCP SYN cookies with IPv4.
- + + + + + + +
Specifies policy for using TCP SYN cookies with IPv4.
+
(True) Enables TCP SYN cookies with IPv4.
+
(False) Disables TCP SYN cookies with IPv4.
+ - - - + + +
twa_hazards_protection
boolean -
- - - - - -
RFC1337 TCP TIME-WAIT assasination hazards protection.
- + + + + + + +
RFC1337 TCP TIME-WAIT assasination hazards protection.
+ - - - + + +
validation
string -
- - - - - -
Specifies a policy for source validation by reversed path, as defined in RFC 3704.
-
(disable) No source validation is performed.
-
(loose) Enable Loose Reverse Path Forwarding as defined in RFC3704.
-
(strict) Enable Strict Reverse Path Forwarding as defined in RFC3704.
- + + + + + + +
Specifies a policy for source validation by reversed path, as defined in RFC 3704.
+
(disable) No source validation is performed.
+
(loose) Enable Loose Reverse Path Forwarding as defined in RFC3704.
+
(strict) Enable Strict Reverse Path Forwarding as defined in RFC3704.
+ - - - + + +
running_config
string -
- - - - -
The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. This value of this option should be the output received from device by executing command show configuration commands | grep 'firewall'
- + + + + + +
The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. This value of this option should be the output received from device by executing command show configuration commands | grep 'firewall'
+ - - + +
state
string -
- - - - - -
The state the configuration should be left in.
- + + + + + + +
The state the configuration should be left in.
+ - +
@@ -773,7 +785,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -1659,7 +1670,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -1672,60 +1682,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set firewall group address-group ENG-HOSTS', 'set firewall group address-group ENG-HOSTS address 192.0.3.1']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set firewall group address-group ENG-HOSTS', 'set firewall group address-group ENG-HOSTS address 192.0.3.1']
+ - +

@@ -1737,5 +1747,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - -- cgit v1.2.3