vyos.vyos.vyos_firewall_global module – Firewall global resource module
Note
This module is part of the vyos.vyos collection (version 6.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install vyos.vyos.
To use it in a playbook, specify: vyos.vyos.vyos_firewall_global.
New in vyos.vyos 1.0.0
Synopsis
This module manage global policies or configurations for firewall on VyOS devices.
Parameters
Parameter |
Comments |
|---|---|
A dictionary of Firewall global configuration options. |
|
SNMP trap generation on firewall configuration changes. Choices:
|
|
Defines a group of objects for referencing in firewall rules. |
|
Defines a group of IP addresses for referencing in firewall rules. |
|
Specifies IP address type Choices:
|
|
Allows you to specify a brief description for the address group. |
|
Address-group members. IPv4 address to match. IPv4 range to match. |
|
IP address. |
|
Name of the firewall address group. |
|
Defines a group of networks for referencing in firewall rules. |
|
Specifies network address type Choices:
|
|
Allows you to specify a brief description for the network group. |
|
Adds an IPv4 network to the specified network group. The format is ip-address/prefix. |
|
IP address. |
|
Name of the firewall network group. |
|
Defines a group of ports for referencing in firewall rules. |
|
A brief description for the port group. |
|
Port-group member. |
|
Specified port. |
|
Name of the firewall port group. |
|
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. Choices:
|
|
Policy for handling of all IPv4 ICMP echo requests. |
|
Enables or disables response to all IPv4 ICMP Echo Request (ping) messages. The system responds to IPv4 ICMP Echo Request messages. Choices:
|
|
Enables or disables response to broadcast IPv4 ICMP Echo Request and Timestamp Request messages. IPv4 ICMP Echo and Timestamp Request messages are not processed. Choices:
|
|
A dictionary of Firewall ICMP redirect and source route global configuration options. |
|
Specifies IP address type Choices:
|
|
Specifies whether to allow sending/receiving of IPv4/v6 ICMP redirect messages. |
|
Permits or denies receiving packets ICMP redirect messages. Choices:
|
|
Permits or denies transmitting packets ICMP redirect messages. Choices:
|
|
Specifies whether or not to process source route IP options. Choices:
|
|
Specifies global firewall state-policy. |
|
Action for packets part of an established connection. Choices:
|
|
Specifies connection type. Choices:
|
|
Enable logging of packets part of an established connection. Choices:
|
|
Specify log level for packets logged. Only available in 1.4+ Choices:
|
|
Specifies policy for using TCP SYN cookies with IPv4. (True) Enables TCP SYN cookies with IPv4. (False) Disables TCP SYN cookies with IPv4. Choices:
|
|
RFC1337 TCP TIME-WAIT assassination hazards protection. Choices:
|
|
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. Choices:
|
|
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 |
|
The state the configuration should be left in. Choices:
|
Notes
Note
Tested against VyOS 1.3.8, 1.4.2, the upcoming 1.5, and the rolling release of spring 2025.
The provided examples of commands are valid for VyOS 1.4+
This module works with connection
ansible.netcommon.network_cli. See the VyOS OS Platform Options.
Examples
# Using merged
#
# Before state:
# -------------
#
# vyos@vyos# run show configuration commands | grep firewall
#
#
- name: Merge the provided configuration with the existing running configuration
vyos.vyos.vyos_firewall_global:
config:
validation: strict
config_trap: true
log_martians: true
syn_cookies: true
twa_hazards_protection: true
ping:
all: true
broadcast: true
state_policy:
- connection_type: established
action: accept
log: true
log_level: emerg
- connection_type: invalid
action: reject
route_redirects:
- afi: ipv4
ip_src_route: true
icmp_redirects:
send: true
receive: false
group:
address_group:
- name: MGMT-HOSTS
description: This group has the Management hosts address list
members:
- address: 192.0.1.1
- address: 192.0.1.3
- address: 192.0.1.5
network_group:
- name: MGMT
description: This group has the Management network addresses
members:
- address: 192.0.1.0/24
state: merged
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
# before": []
#
# "commands": [
# "set firewall group address-group MGMT-HOSTS address 192.0.1.1",
# "set firewall group address-group MGMT-HOSTS address 192.0.1.3",
# "set firewall group address-group MGMT-HOSTS address 192.0.1.5",
# "set firewall group address-group MGMT-HOSTS description 'This group has the Management hosts address list'",
# "set firewall group address-group MGMT-HOSTS",
# "set firewall group network-group MGMT network 192.0.1.0/24",
# "set firewall group network-group MGMT description 'This group has the Management network addresses'",
# "set firewall group network-group MGMT",
# "set firewall global-options ip-src-route 'enable'",
# "set firewall global-options receive-redirects 'disable'",
# "set firewall global-options send-redirects 'enable'",
# "set firewall global-options config-trap 'enable'",
# "set firewall global-options state-policy established action 'accept'",
# "set firewall global-options state-policy established log,
# "set firewall global-options state-policy established log-level 'emerg'",
# "set firewall global-options state-policy invalid action 'reject'",
# "set firewall global-options broadcast-ping 'enable'",
# "set firewall global-options all-ping 'enable'",
# "set firewall global-options log-martians 'enable'",
# "set firewall global-options twa-hazards-protection 'enable'",
# "set firewall global-options syn-cookies 'enable'",
# "set firewall global-options source-validation 'strict'"
# ]
#
# "after": {
# "config_trap": true,
# "group": {
# "address_group": [
# {
# "description": "This group has the Management hosts address list",
# "members": [
# {
# "address": "192.0.1.1"
# },
# {
# "address": "192.0.1.3"
# },
# {
# "address": "192.0.1.5"
# }
# ],
# "name": "MGMT-HOSTS"
# }
# ],
# "network_group": [
# {
# "description": "This group has the Management network addresses",
# "members": [
# {
# "address": "192.0.1.0/24"
# }
# ],
# "name": "MGMT"
# }
# ]
# },
# "log_martians": true,
# "ping": {
# "all": true,
# "broadcast": true
# },
# "route_redirects": [
# {
# "afi": "ipv4",
# "icmp_redirects": {
# "receive": false,
# "send": true
# },
# "ip_src_route": true
# }
# ],
# "state_policy": [
# {
# "action": "accept",
# "connection_type": "established",
# "log": true
# },
# {
# "action": "reject",
# "connection_type": "invalid"
# }
# ],
# "syn_cookies": true,
# "twa_hazards_protection": true,
# "validation": "strict"
# }
#
# After state:
# -------------
#
# vyos@192# run show configuration commands | grep firewall
# set firewall global-options all-ping 'enable'
# set firewall global-options broadcast-ping 'enable'
# set firewall global-options config-trap 'enable'
# set firewall global-options ip-src-route 'enable'
# set firewall global-options log-martians 'enable'
# set firewall global-options receive-redirects 'disable'
# set firewall global-options send-redirects 'enable'
# set firewall global-options source-validation 'strict'
# set firewall global-options state-policy established action 'accept'
# set firewall global-options state-policy established log 'enable'
# set firewall global-options state-policy invalid action 'reject'
# set firewall global-options syn-cookies 'enable'
# set firewall global-options twa-hazards-protection 'enable'
# set firewall group address-group MGMT-HOSTS address '192.0.1.1'
# set firewall group address-group MGMT-HOSTS address '192.0.1.3'
# set firewall group address-group MGMT-HOSTS address '192.0.1.5'
# set firewall group address-group MGMT-HOSTS description 'This group has the Management hosts address list'
# set firewall group network-group MGMT description 'This group has the Management network addresses'
# set firewall group network-group MGMT network '192.0.1.0/24'
#
#
# Using parsed
#
#
- name: Render the commands for provided configuration
vyos.vyos.vyos_firewall_global:
running_config: |
set firewall global-options all-ping 'enable'
set firewall global-options broadcast-ping 'enable'
set firewall global-options config-trap 'enable'
set firewall global-options ip-src-route 'enable'
set firewall global-options log-martians 'enable'
set firewall global-options receive-redirects 'disable'
set firewall global-options send-redirects 'enable'
set firewall global-options source-validation 'strict'
set firewall global-options state-policy established action 'accept'
set firewall global-options state-policy established log 'enable'
set firewall global-options state-policy invalid action 'reject'
set firewall global-options syn-cookies 'enable'
set firewall global-options twa-hazards-protection 'enable'"
set firewall group address-group ENG-HOSTS address '192.0.3.1'
set firewall group address-group ENG-HOSTS address '192.0.3.2'
set firewall group address-group ENG-HOSTS description 'Sales office hosts address list'
set firewall group address-group SALES-HOSTS address '192.0.2.1'
set firewall group address-group SALES-HOSTS address '192.0.2.2'
set firewall group address-group SALES-HOSTS address '192.0.2.3'
set firewall group address-group SALES-HOSTS description 'Sales office hosts address list'
set firewall group network-group MGMT description 'This group has the Management network addresses'
set firewall group network-group MGMT network '192.0.1.0/24'
state: parsed
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
#
# "parsed": {
# "config_trap": true,
# "group": {
# "address_group": [
# {
# "description": "Sales office hosts address list",
# "members": [
# {
# "address": "192.0.3.1"
# },
# {
# "address": "192.0.3.2"
# }
# ],
# "name": "ENG-HOSTS"
# },
# {
# "description": "Sales office hosts address list",
# "members": [
# {
# "address": "192.0.2.1"
# },
# {
# "address": "192.0.2.2"
# },
# {
# "address": "192.0.2.3"
# }
# ],
# "name": "SALES-HOSTS"
# }
# ],
# "network_group": [
# {
# "description": "This group has the Management network addresses",
# "members": [
# {
# "address": "192.0.1.0/24"
# }
# ],
# "name": "MGMT"
# }
# ]
# },
# "log_martians": true,
# "ping": {
# "all": true,
# "broadcast": true
# },
# "route_redirects": [
# {
# "afi": "ipv4",
# "icmp_redirects": {
# "receive": false,
# "send": true
# },
# "ip_src_route": true
# }
# ],
# "state_policy": [
# {
# "action": "accept",
# "connection_type": "established",
# "log": true
# },
# {
# "action": "reject",
# "connection_type": "invalid"
# }
# ],
# "syn_cookies": true,
# "twa_hazards_protection": true,
# "validation": "strict"
# }
# }
#
#
# Using deleted
#
# Before state
# -------------
#
# vyos@192# run show configuration commands | grep firewall
# set firewall global-options all-ping 'enable'
# set firewall global-options broadcast-ping 'enable'
# set firewall global-options config-trap 'enable'
# set firewall global-options ip-src-route 'enable'
# set firewall global-options log-martians 'enable'
# set firewall global-options receive-redirects 'disable'
# set firewall global-options send-redirects 'enable'
# set firewall global-options source-validation 'strict'
# set firewall global-options state-policy established action 'accept'
# set firewall global-options state-policy established log 'enable'
# set firewall global-options state-policy invalid action 'reject'
# set firewall global-options syn-cookies 'enable'
# set firewall global-options twa-hazards-protection 'enable'
# set firewall group address-group MGMT-HOSTS address '192.0.1.1'
# set firewall group address-group MGMT-HOSTS address '192.0.1.3'
# set firewall group address-group MGMT-HOSTS address '192.0.1.5'
# set firewall group address-group MGMT-HOSTS description 'This group has the Management hosts address list'
# set firewall group network-group MGMT description 'This group has the Management network addresses'
# set firewall group network-group MGMT network '192.0.1.0/24'
- name: Delete attributes of firewall.
vyos.vyos.vyos_firewall_global:
config:
state_policy:
config_trap:
log_martians:
syn_cookies:
twa_hazards_protection:
route_redirects:
ping:
group:
state: deleted
#
#
# ------------------------
# Module Execution Results
# ------------------------
#
# "before": {
# "config_trap": true,
# "group": {
# "address_group": [
# {
# "description": "This group has the Management hosts address list",
# "members": [
# {
# "address": "192.0.1.1"
# },
# {
# "address": "192.0.1.3"
# },
# {
# "address": "192.0.1.5"
# }
# ],
# "name": "MGMT-HOSTS"
# }
# ],
# "network_group": [
# {
# "description": "This group has the Management network addresses",
# "members": [
# {
# "address": "192.0.1.0/24"
# }
# ],
# "name": "MGMT"
# }
# ]
# },
# "log_martians": true,
# "ping": {
# "all": true,
# "broadcast": true
# },
# "route_redirects": [
# {
# "afi": "ipv4",
# "icmp_redirects": {
# "receive": false,
# "send": true
# },
# "ip_src_route": true
# }
# ],
# "state_policy": [
# {
# "action": "accept",
# "connection_type": "established",
# "log": true
# },
# {
# "action": "reject",
# "connection_type": "invalid"
# }
# ],
# "syn_cookies": true,
# "twa_hazards_protection": true,
# "validation": "strict"
# }
# "commands": [
# "delete firewall global-options source-validation",
# "delete firewall global-options group",
# "delete firewall global-options log-martians",
# "delete firewall global-options ip-src-route",
# "delete firewall global-options receive-redirects",
# "delete firewall global-options send-redirects",
# "delete firewall global-options config-trap",
# "delete firewall global-options state-policy",
# "delete firewall global-options syn-cookies",
# "delete firewall global-options broadcast-ping",
# "delete firewall global-options all-ping",
# "delete firewall global-options twa-hazards-protection"
# ]
#
# "after": []
#
# After state
# ------------
# vyos@192# run show configuration commands | grep firewall
# set 'firewall'
#
#
# Using replaced
#
# Before state:
# -------------
#
# vyos@vyos:~$ show configuration commands| grep firewall
# set firewall global-options all-ping 'enable'
# set firewall global-options broadcast-ping 'enable'
# set firewall global-options config-trap 'enable'
# set firewall global-options ip-src-route 'enable'
# set firewall global-options log-martians 'enable'
# set firewall global-options receive-redirects 'disable'
# set firewall global-options send-redirects 'enable'
# set firewall global-options source-validation 'strict'
# set firewall global-options state-policy established action 'accept'
# set firewall global-options state-policy established log 'enable'
# set firewall global-options state-policy invalid action 'reject'
# set firewall global-options syn-cookies 'enable'
# set firewall global-options twa-hazards-protection 'enable'
# set firewall group address-group MGMT-HOSTS address '192.0.1.1'
# set firewall group address-group MGMT-HOSTS address '192.0.1.3'
# set firewall group address-group MGMT-HOSTS address '192.0.1.5'
# set firewall group address-group MGMT-HOSTS description 'This group has the Management hosts address list'
# set firewall group network-group MGMT description 'This group has the Management network addresses'
# set firewall group network-group MGMT network '192.0.1.0/24'
- name: Replace firewall global attributes configuration.
vyos.vyos.vyos_firewall_global:
config:
validation: strict
config_trap: true
log_martians: true
syn_cookies: true
twa_hazards_protection: true
ping: null
all: true
broadcast: true
state_policy:
- connection_type: established
action: accept
log: true
- connection_type: invalid
action: reject
route_redirects:
- afi: ipv4
ip_src_route: true
icmp_redirects:
send: true
receive: false
group:
address_group:
- name: SALES-HOSTS
description: Sales office hosts address list
members:
- address: 192.0.2.1
- address: 192.0.2.2
- address: 192.0.2.3
- name: ENG-HOSTS
description: Sales office hosts address list
members:
- address: 192.0.3.1
- address: 192.0.3.2
network_group:
- name: MGMT
description: This group has the Management network addresses
members:
- address: 192.0.1.0/24
state: replaced
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
# "before": {
# "config_trap": true,
# "group": {
# "address_group": [
# {
# "description": "This group has the Management hosts address list",
# "members": [
# {
# "address": "192.0.1.1"
# },
# {
# "address": "192.0.1.3"
# },
# {
# "address": "192.0.1.5"
# }
# ],
# "name": "MGMT-HOSTS"
# }
# ],
# "network_group": [
# {
# "description": "This group has the Management network addresses",
# "members": [
# {
# "address": "192.0.1.0/24"
# }
# ],
# "name": "MGMT"
# }
# ]
# },
# "log_martians": true,
# "ping": {
# "all": true,
# "broadcast": true
# },
# "route_redirects": [
# {
# "afi": "ipv4",
# "icmp_redirects": {
# "receive": false,
# "send": true
# },
# "ip_src_route": true
# }
# ],
# "state_policy": [
# {
# "action": "accept",
# "connection_type": "established",
# "log": true
# },
# {
# "action": "reject",
# "connection_type": "invalid"
# }
# ],
# "syn_cookies": true,
# "twa_hazards_protection": true,
# "validation": "strict"
# }
#
# "commands": [
# "delete firewall group address-group MGMT-HOSTS",
# "set firewall group address-group SALES-HOSTS address 192.0.2.1",
# "set firewall group address-group SALES-HOSTS address 192.0.2.2",
# "set firewall group address-group SALES-HOSTS address 192.0.2.3",
# "set firewall group address-group SALES-HOSTS description 'Sales office hosts address list'",
# "set firewall group address-group SALES-HOSTS",
# "set firewall group address-group ENG-HOSTS address 192.0.3.1",
# "set firewall group address-group ENG-HOSTS address 192.0.3.2",
# "set firewall group address-group ENG-HOSTS description 'Sales office hosts address list'",
# "set firewall group address-group ENG-HOSTS"
# ]
#
# "after": {
# "config_trap": true,
# "group": {
# "address_group": [
# {
# "description": "Sales office hosts address list",
# "members": [
# {
# "address": "192.0.3.1"
# },
# {
# "address": "192.0.3.2"
# }
# ],
# "name": "ENG-HOSTS"
# },
# {
# "description": "Sales office hosts address list",
# "members": [
# {
# "address": "192.0.2.1"
# },
# {
# "address": "192.0.2.2"
# },
# {
# "address": "192.0.2.3"
# }
# ],
# "name": "SALES-HOSTS"
# }
# ],
# "network_group": [
# {
# "description": "This group has the Management network addresses",
# "members": [
# {
# "address": "192.0.1.0/24"
# }
# ],
# "name": "MGMT"
# }
# ]
# },
# "log_martians": true,
# "ping": {
# "all": true,
# "broadcast": true
# },
# "route_redirects": [
# {
# "afi": "ipv4",
# "icmp_redirects": {
# "receive": false,
# "send": true
# },
# "ip_src_route": true
# }
# ],
# "state_policy": [
# {
# "action": "accept",
# "connection_type": "established",
# "log": true
# },
# {
# "action": "reject",
# "connection_type": "invalid"
# }
# ],
# "syn_cookies": true,
# "twa_hazards_protection": true,
# "validation": "strict"
# }
#
# After state:
# -------------
#
# vyos@192# run show configuration commands | grep firewall
# set firewall global-options all-ping 'enable'
# set firewall global-options broadcast-ping 'enable'
# set firewall global-options config-trap 'enable'
# set firewall global-options ip-src-route 'enable'
# set firewall global-options log-martians 'enable'
# set firewall global-options receive-redirects 'disable'
# set firewall global-options send-redirects 'enable'
# set firewall global-options source-validation 'strict'
# set firewall global-options state-policy established action 'accept'
# set firewall global-options state-policy established log 'enable'
# set firewall global-options state-policy invalid action 'reject'
# set firewall global-options syn-cookies 'enable'
# set firewall global-options twa-hazards-protection 'enable'
# set firewall group address-group ENG-HOSTS address '192.0.3.1'
# set firewall group address-group ENG-HOSTS address '192.0.3.2'
# set firewall group address-group ENG-HOSTS description 'Sales office hosts address list'
# set firewall group address-group SALES-HOSTS address '192.0.2.1'
# set firewall group address-group SALES-HOSTS address '192.0.2.2'
# set firewall group address-group SALES-HOSTS address '192.0.2.3'
# set firewall group address-group SALES-HOSTS description 'Sales office hosts address list'
# set firewall group network-group MGMT description 'This group has the Management network addresses'
# set firewall group network-group MGMT network '192.0.1.0/24'
#
#
# Using gathered
#
# Before state:
# -------------
#
# vyos@192# run show configuration commands | grep firewall
# set firewall global-options all-ping 'enable'
# set firewall global-options broadcast-ping 'enable'
# set firewall global-options config-trap 'enable'
# set firewall global-options ip-src-route 'enable'
# set firewall global-options log-martians 'enable'
# set firewall global-options receive-redirects 'disable'
# set firewall global-options send-redirects 'enable'
# set firewall global-options source-validation 'strict'
# set firewall global-options state-policy established action 'accept'
# set firewall global-options state-policy established log 'enable'
# set firewall global-options state-policy invalid action 'reject'
# set firewall global-options syn-cookies 'enable'
# set firewall global-options twa-hazards-protection 'enable'
# set firewall group address-group ENG-HOSTS address '192.0.3.1'
# set firewall group address-group ENG-HOSTS address '192.0.3.2'
# set firewall group address-group ENG-HOSTS description 'Sales office hosts address list'
# set firewall group address-group SALES-HOSTS address '192.0.2.1'
# set firewall group address-group SALES-HOSTS address '192.0.2.2'
# set firewall group address-group SALES-HOSTS address '192.0.2.3'
# set firewall group address-group SALES-HOSTS description 'Sales office hosts address list'
# set firewall group network-group MGMT description 'This group has the Management network addresses'
# set firewall group network-group MGMT network '192.0.1.0/24'
- name: Gather firewall global config with provided configurations
vyos.vyos.vyos_firewall_global:
state: gathered
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
# "gathered": [
# {
# "config_trap": true,
# "group": {
# "address_group": [
# {
# "description": "Sales office hosts address list",
# "members": [
# {
# "address": "192.0.3.1"
# },
# {
# "address": "192.0.3.2"
# }
# ],
# "name": "ENG-HOSTS"
# },
# {
# "description": "Sales office hosts address list",
# "members": [
# {
# "address": "192.0.2.1"
# },
# {
# "address": "192.0.2.2"
# },
# {
# "address": "192.0.2.3"
# }
# ],
# "name": "SALES-HOSTS"
# }
# ],
# "network_group": [
# {
# "description": "This group has the Management network addresses",
# "members": [
# {
# "address": "192.0.1.0/24"
# }
# ],
# "name": "MGMT"
# }
# ]
# },
# "log_martians": true,
# "ping": {
# "all": true,
# "broadcast": true
# },
# "route_redirects": [
# {
# "afi": "ipv4",
# "icmp_redirects": {
# "receive": false,
# "send": true
# },
# "ip_src_route": true
# }
# ],
# "state_policy": [
# {
# "action": "accept",
# "connection_type": "established",
# "log": true
# },
# {
# "action": "reject",
# "connection_type": "invalid"
# }
# ],
# "syn_cookies": true,
# "twa_hazards_protection": true,
# "validation": "strict"
# }
#
# After state:
# -------------
#
# vyos@192# run show configuration commands | grep firewall
# set firewall global-options all-ping 'enable'
# set firewall global-options broadcast-ping 'enable'
# set firewall global-options config-trap 'enable'
# set firewall global-options ip-src-route 'enable'
# set firewall global-options log-martians 'enable'
# set firewall global-options receive-redirects 'disable'
# set firewall global-options send-redirects 'enable'
# set firewall global-options source-validation 'strict'
# set firewall global-options state-policy established action 'accept'
# set firewall global-options state-policy established log 'enable'
# set firewall global-options state-policy invalid action 'reject'
# set firewall global-options syn-cookies 'enable'
# set firewall global-options twa-hazards-protection 'enable'
# set firewall group address-group ENG-HOSTS address '192.0.3.1'
# set firewall group address-group ENG-HOSTS address '192.0.3.2'
# set firewall group address-group ENG-HOSTS description 'Sales office hosts address list'
# set firewall group address-group SALES-HOSTS address '192.0.2.1'
# set firewall group address-group SALES-HOSTS address '192.0.2.2'
# set firewall group address-group SALES-HOSTS address '192.0.2.3'
# set firewall group address-group SALES-HOSTS description 'Sales office hosts address list'
# set firewall group network-group MGMT description 'This group has the Management network addresses'
# set firewall group network-group MGMT network '192.0.1.0/24'
# Using rendered
#
#
- name: Render the commands for provided configuration
vyos.vyos.vyos_firewall_global:
config:
validation: strict
config_trap: true
log_martians: true
syn_cookies: true
twa_hazards_protection: true
ping: null
all: true
broadcast: true
state_policy:
- connection_type: established
action: accept
log: true
- connection_type: invalid
action: reject
route_redirects:
- afi: ipv4
ip_src_route: true
icmp_redirects: null
send: true
receive: false
group:
address_group:
- name: SALES-HOSTS
description: Sales office hosts address list
members:
- address: 192.0.2.1
- address: 192.0.2.2
- address: 192.0.2.3
- name: ENG-HOSTS
description: Sales office hosts address list
members:
- address: 192.0.3.1
- address: 192.0.3.2
network_group:
- name: MGMT
description: This group has the Management network addresses
members:
- address: 192.0.1.0/24
state: rendered
#
#
# -------------------------
# Module Execution Result
# -------------------------
#
#
# "rendered": [
# "set firewall group address-group SALES-HOSTS address 192.0.2.1",
# "set firewall group address-group SALES-HOSTS address 192.0.2.2",
# "set firewall group address-group SALES-HOSTS address 192.0.2.3",
# "set firewall group address-group SALES-HOSTS description 'Sales office hosts address list'",
# "set firewall group address-group SALES-HOSTS",
# "set firewall group address-group ENG-HOSTS address 192.0.3.1",
# "set firewall group address-group ENG-HOSTS address 192.0.3.2",
# "set firewall group address-group ENG-HOSTS description 'Sales office hosts address list'",
# "set firewall group address-group ENG-HOSTS",
# "set firewall group network-group MGMT network 192.0.1.0/24",
# "set firewall group network-group MGMT description 'This group has the Management network addresses'",
# "set firewall group network-group MGMT",
# "set firewall global-options ip-src-route 'enable'",
# "set firewall global-options receive-redirects 'disable'",
# "set firewall global-options send-redirects 'enable'",
# "set firewall global-options config-trap 'enable'",
# "set firewall global-options state-policy established action 'accept'",
# "set firewall global-options state-policy established log,
# "set firewall global-options state-policy invalid action 'reject'",
# "set firewall global-options broadcast-ping 'enable'",
# "set firewall global-options all-ping 'enable'",
# "set firewall global-options log-martians 'enable'",
# "set firewall global-options twa-hazards-protection 'enable'",
# "set firewall global-options syn-cookies 'enable'",
# "set firewall global-options source-validation 'strict'"
# ]
#
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration after module execution. Returned: when changed Sample: |
|
The configuration prior to the module execution. Returned: when state is Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is Sample: |