fortinet.fortios.fortios_firewall_vip6 – Configure virtual IP for IPv6 in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.3).
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_vip6
.
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 vip6 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 |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure virtual IP for IPv6. |
|
Enable/disable adding NAT64 route. Choices:
|
|
Enable to respond to ARP requests for this virtual IP address. Enabled by default. Choices:
|
|
Color of icon on the GUI. |
|
Comment. |
|
Enable/disable embedded IPv4 address. Choices:
|
|
IP address or address range on the external interface that you want to map to an address or address range on the destination network. |
|
Incoming port number range that you want to map to a port number range on the destination network. |
|
Time in minutes that client web browsers should keep a cookie. Default is 60 seconds. 0 = no time limit. |
|
Domain that HTTP cookie persistence should apply to. |
|
Enable/disable use of HTTP cookie domain from host field in HTTP. Choices:
|
|
Generation of HTTP cookie to be accepted. Changing invalidates all existing cookies. |
|
Limit HTTP cookie persistence to the specified path. |
|
Control sharing of cookies across virtual servers. same-ip means a cookie from one virtual server can be used by another. Disable stops cookie sharing. Choices:
|
|
For HTTP multiplexing, enable to add the original client IP address in the XForwarded-For HTTP header. Choices:
|
|
For HTTP multiplexing, enter a custom HTTPS header name. The original client IP address is added to this header. If empty, X-Forwarded-For is used. |
|
Enable/disable HTTP multiplexing. Choices:
|
|
Enable/disable redirection of HTTP to HTTPS Choices:
|
|
Enable/disable verification that inserted HTTPS cookies are secure. Choices:
|
|
Custom defined ID. |
|
Start-mapped-IPv4-address [-end mapped-IPv4-address]. |
|
IPv4 port number range on the destination network to which the external port number range is mapped. |
|
Method used to distribute sessions to real servers. Choices:
|
|
Mapped IP address range in the format startIP-endIP. |
|
Port number range on the destination network to which the external port number range is mapped. |
|
Maximum number of incomplete connections. |
|
Name of the health check monitor to use when polling to determine a virtual server”s connectivity status. |
|
Health monitor name. Source firewall.ldb-monitor.name. |
|
Virtual ip6 name. |
|
Enable/disable DNAT64. Choices:
|
|
Enable/disable DNAT66. Choices:
|
|
Enable to perform SNAT on traffic from mappedip to the extip for all egress interfaces. Choices:
|
|
Enable to add the Front-End-Https header for Microsoft Outlook Web Access. Choices:
|
|
Configure how to make sure that clients connect to the same server every time they make a request that is part of the same session. Choices:
|
|
Enable port forwarding. Choices:
|
|
Protocol to use when forwarding packets. Choices:
|
|
Select the real servers that this server load balancing VIP will distribute traffic to. |
|
Only clients in this IP range can connect to this real server. |
|
Enable to check the responsiveness of the real server before forwarding traffic. Choices:
|
|
Time in seconds that the health check monitor continues to monitor an unresponsive server that should be active. |
|
HTTP server domain name in HTTP header. |
|
Real server ID. |
|
IPv6 address of the real server. |
|
Max number of active connections that can directed to the real server. When reached, sessions are sent to other real servers. |
|
Name of the health check monitor to use when polling to determine a virtual server”s connectivity status. Source firewall .ldb-monitor.name. |
|
Port for communicating with the real server. Required if port forwarding is enabled. |
|
Set the status of the real server to active so that it can accept traffic, or on standby or disabled so no traffic is sent. Choices:
|
|
Weight of the real server. If weighted load balancing is enabled, the server with the highest weight gets more connections. |
|
Protocol to be load balanced by the virtual server (also called the server load balance virtual IP). Choices:
|
|
Source IP6 filter (x:x:x:x:x:x:x:x/x). Separate addresses with spaces. |
|
Source-filter range. |
|
Permitted encryption algorithms for SSL sessions according to encryption strength. Choices:
|
|
The name of the SSL certificate to use for SSL acceleration. Source vpn.certificate.local.name. |
|
SSL/TLS cipher suites acceptable from a client, ordered by priority. |
|
Cipher suite name. Choices:
|
|
SSL/TLS cipher suites priority. |
|
SSL/TLS versions that the cipher suite can be used with. Choices:
|
|
Enable/disable support for preventing Downgrade Attacks on client connections (RFC 7507). Choices:
|
|
Maximum length of data in MB before triggering a client rekey (0 = disable). |
|
Allow, deny, or require secure renegotiation of client sessions to comply with RFC 5746. Choices:
|
|
Maximum number of client to FortiGate SSL session states to keep. |
|
Number of minutes to keep client to FortiGate SSL session state. |
|
How to expire SSL sessions for the segment of the SSL connection between the client and the FortiGate. Choices:
|
|
Number of bits to use in the Diffie-Hellman exchange for RSA encryption of SSL sessions. Choices:
|
|
Enable/disable including HPKP header in response. Choices:
|
|
Number of minutes the web browser should keep HPKP. |
|
Certificate to generate backup HPKP pin from. Source vpn.certificate.local.name vpn.certificate.ca.name. |
|
Indicate that HPKP header applies to all subdomains. Choices:
|
|
Certificate to generate primary HPKP pin from. Source vpn.certificate.local.name vpn.certificate.ca.name. |
|
URL to report HPKP violations to. |
|
Enable/disable including HSTS header in response. Choices:
|
|
Number of seconds the client should honour the HSTS setting. |
|
Indicate that HSTS header applies to all subdomains. Choices:
|
|
Enable to replace HTTP with HTTPS in the reply”s Location HTTP header field. Choices:
|
|
Enable/disable HTTP host matching for location conversion. Choices:
|
|
Highest SSL/TLS version acceptable from a client. Choices:
|
|
Lowest SSL/TLS version acceptable from a client. Choices:
|
|
Apply SSL offloading between the client and the FortiGate (half) or from the client to the FortiGate and from the FortiGate to the server (full). Choices:
|
|
Select the cipher suites that can be used for SSL perfect forward secrecy (PFS). Applies to both client and server sessions. Choices:
|
|
Enable/disable sending empty fragments to avoid CBC IV attacks (SSL 3.0 & TLS 1.0 only). May need to be disabled for compatibility with older systems. Choices:
|
|
Permitted encryption algorithms for the server side of SSL full mode sessions according to encryption strength. Choices:
|
|
SSL/TLS cipher suites to offer to a server, ordered by priority. |
|
Cipher suite name. Choices:
|
|
SSL/TLS cipher suites priority. |
|
SSL/TLS versions that the cipher suite can be used with. Choices:
|
|
Highest SSL/TLS version acceptable from a server. Use the client setting by default. Choices:
|
|
Lowest SSL/TLS version acceptable from a server. Use the client setting by default. Choices:
|
|
Maximum number of FortiGate to Server SSL session states to keep. |
|
Number of minutes to keep FortiGate to Server SSL session state. |
|
How to expire SSL sessions for the segment of the SSL connection between the server and the FortiGate. Choices:
|
|
Configure a static NAT or server load balance VIP. Choices:
|
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Enable to add an HTTP header to indicate SSL offloading for a WebLogic server. Choices:
|
|
Enable to add an HTTP header to indicate SSL offloading for a WebSphere server. Choices:
|
|
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: “root” |
Examples
- collections:
- fortinet.fortios
connection: httpapi
hosts: fortigate01
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
vdom: root
tasks:
- name: fortios_firewall_vip6
fortios_firewall_vip6:
vdom: root
state: present
firewall_vip6:
arp_reply: enable
color: 0
extip: 2001:1:1:12::100
extport: 0-65535
http_cookie_age: 60
http_cookie_domain_from_host: disable
http_cookie_generation: 0
http_cookie_share: same-ip
http_ip_header: disable
http_multiplex: disable
http_redirect: disable
https_cookie_secure: disable
id: 0
ldb_method: static
mappedip: 2001:1:1:12::200
mappedport: 0-65535
max_embryonic_connections: 1000
name: vip6s1
nat_source_vip: disable
outlook_web_access: disable
persistence: none
portforward: disable
protocol: tcp
ssl_algorithm: high
ssl_client_fallback: enable
ssl_client_rekey_count: 200
ssl_client_renegotiation: secure
ssl_client_session_state_max: 1000
ssl_client_session_state_timeout: 30
ssl_client_session_state_type: both
ssl_dh_bits: '2048'
ssl_hpkp: disable
ssl_hpkp_age: 5184000
ssl_hpkp_include_subdomains: disable
ssl_hsts: disable
ssl_hsts_age: 5184000
ssl_hsts_include_subdomains: disable
ssl_http_location_conversion: disable
ssl_http_match_host: enable
ssl_max_version: tls-1.3
ssl_min_version: tls-1.1
ssl_mode: half
ssl_pfs: require
ssl_send_empty_frags: enable
ssl_server_algorithm: client
ssl_server_max_version: client
ssl_server_min_version: client
ssl_server_session_state_max: 100
ssl_server_session_state_timeout: 60
ssl_server_session_state_type: both
type: static-nat
weblogic_server: disable
websphere_server: disable
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: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always 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)