fortios_firewall_vip64 – Configure IPv6 to IPv4 virtual IPs in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
- firewall_vip64 - Configure IPv6 to IPv4 virtual IPs. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- arp_reply - Enable ARP reply. type: str choices: disable, enable
- color - Color of icon on the GUI. type: int
- comment - Comment. type: str
- extip - Start-external-IP [-end-external-IP]. type: str
- extport - External service port. type: str
- id - Custom defined id. type: int
- ldb_method - Load balance method. type: str choices: static, round-robin, weighted, least-session, least-rtt, first-alive
- mappedip - Start-mapped-IP [-end-mapped-IP]. type: str
- mappedport - Mapped service port. type: str
- monitor - Health monitors. type: list
- name - Health monitor name. Source firewall.ldb-monitor.name. type: str required: True
- name - VIP64 name. type: str required: True
- portforward - Enable port forwarding. type: str choices: disable, enable
- protocol - Mapped port protocol. type: str choices: tcp, udp
- realservers - Real servers. type: list
- client_ip - Restrict server to a client IP in this range. type: str
- healthcheck - Per server health check. type: str choices: disable, enable, vip
- holddown_interval - Hold down interval. type: int
- id - Real server ID. type: int required: True
- ip - Mapped server IP. type: str
- max_connections - Maximum number of connections allowed to server. type: int
- monitor - Health monitors. Source firewall.ldb-monitor.name. type: str
- port - Mapped server port. type: int
- status - Server administrative status. type: str choices: active, standby, disable
- weight - weight type: int
- server_type - Server type. type: str choices: http, tcp, udp, ip
- src_filter - Source IP6 filter (x:x:x:x:x:x:x:x/x). type: list
- range - Src-filter range. type: str required: True
- type - VIP type: static NAT or server load balance. type: str choices: static-nat, server-load-balance
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
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 IPv6 to IPv4 virtual IPs.
fortios_firewall_vip64:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_vip64:
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>"
type: "static-nat"
uuid: "<your_own_value>"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3