fortinet.fortios.fortios_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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 fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_vip46
.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip46 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
firewall_vip46 dictionary | Configure IPv4 to IPv6 virtual IPs. | |||
arp_reply string |
| Enable ARP reply. | ||
color integer | Color of icon on the GUI. | |||
comment string | Comment. | |||
extip string | Start-external-IP [-end-external-IP]. | |||
extport string | External service port. | |||
id integer | Custom defined id. | |||
ldb_method string |
| Load balance method. | ||
mappedip string | Start-mapped-IP [-end mapped-IP]. | |||
mappedport string | Mapped service port. | |||
monitor list / elements=string | Health monitors. | |||
name string / required | Health monitor name. Source firewall.ldb-monitor.name. | |||
name string / required | VIP46 name. | |||
portforward string |
| Enable port forwarding. | ||
protocol string |
| Mapped port protocol. | ||
realservers list / elements=string | Real servers. | |||
client_ip string | Restrict server to a client IP in this range. | |||
healthcheck string |
| Per server health check. | ||
holddown_interval integer | Hold down interval. | |||
id integer / required | Real server ID. | |||
ip string | Mapped server IPv6. | |||
max_connections integer | Maximum number of connections allowed to server. | |||
monitor string | Health monitors. Source firewall.ldb-monitor.name. | |||
port integer | Mapped server port. | |||
status string |
| Server administrative status. | ||
weight integer | weight | |||
server_type string |
| Server type. | ||
src_filter list / elements=string | Source IP filter (x.x.x.x/x). | |||
range string / required | Src-filter range. | |||
srcintf_filter list / elements=string | Interfaces to which the VIP46 applies. Separate the names with spaces. | |||
interface_name string | Interface name. Source system.interface.name. | |||
type string |
| VIP type: static NAT or server load balance. | ||
uuid string | Universally Unique Identifier (UUID; automatically assigned but can be manually reset). | |||
state string / required |
| Indicates whether to create or remove the object. | ||
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure IPv4 to IPv6 virtual IPs. fortios_firewall_vip46: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" firewall_vip46: arp_reply: "disable" color: "4" comment: "Comment." extip: "<your_own_value>" extport: "<your_own_value>" id: "8" ldb_method: "static" mappedip: "<your_own_value>" mappedport: "<your_own_value>" monitor: - name: "default_name_13 (source firewall.ldb-monitor.name)" name: "default_name_14" portforward: "disable" protocol: "tcp" realservers: - client_ip: "<your_own_value>" healthcheck: "disable" holddown_interval: "20" id: "21" ip: "<your_own_value>" max_connections: "23" monitor: "<your_own_value> (source firewall.ldb-monitor.name)" port: "25" status: "active" weight: "27" server_type: "http" src_filter: - range: "<your_own_value>" srcintf_filter: - interface_name: "<your_own_value> (source system.interface.name)" type: "static-nat" uuid: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_vip46_module.html