fortinet.fortios.fortios_firewall_vip64 module – Configure IPv6 to IPv4 virtual IPs in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_vip64
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip64 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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure IPv6 to IPv4 virtual IPs. |
|
Enable ARP reply. Choices:
|
|
Color of icon on the GUI. |
|
Comment. |
|
Start-external-IPv6-address [-end-external-IPv6-address]. |
|
External service port. |
|
Custom defined id. |
|
Load balance method. Choices:
|
|
Start-mapped-IP [-end-mapped-IP]. |
|
Mapped service port. |
|
Health monitors. |
|
Health monitor name. Source firewall.ldb-monitor.name. |
|
VIP64 name. |
|
Enable port forwarding. Choices:
|
|
Mapped port protocol. Choices:
|
|
Real servers. |
|
Restrict server to a client IP in this range. |
|
Per server health check. Choices:
|
|
Hold down interval. |
|
Real server ID. see <a href=’#notes’>Notes</a>. |
|
Mapped server IP. |
|
Maximum number of connections allowed to server. |
|
Health monitors. Source firewall.ldb-monitor.name. |
|
Health monitor name. Source firewall.ldb-monitor.name. |
|
Mapped server port. |
|
Server administrative status. Choices:
|
|
weight |
|
Server type. Choices:
|
|
Source IP6 filter (x:x:x:x:x:x:x:x/x). |
|
Src-filter range. |
|
VIP type: static NAT or server load balance. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure IPv6 to IPv4 virtual IPs.
fortinet.fortios.fortios_firewall_vip64:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vip64:
arp_reply: "disable"
color: "0"
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: "300"
id: "21"
ip: "<your_own_value>"
max_connections: "0"
monitor:
-
name: "default_name_25 (source firewall.ldb-monitor.name)"
port: "0"
status: "active"
weight: "1"
server_type: "http"
src_filter:
-
range: "<your_own_value>"
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 |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |