source:	fortios_firewall_vip64.py
orphan:

fortios_firewall_vip64 -- Configure IPv6 to IPv4 virtual IPs in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis
Requirements
FortiOS Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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

FortiOS Version Compatibility

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
fortios_firewall_vip64	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

Parameters

access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
enable_log - Enable/Disable logging for task. type: bool required: false default: 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
member_path - Member attribute path to operate on. type: str
member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
firewall_vip64 - Configure IPv6 to IPv4 virtual IPs. type: dict more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

firewall_vip64 yes yes yes yes yes yes yes yes yes yes yes

arp_reply - Enable ARP reply. type: str choices: disable, enable more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
arp_reply	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

color - Color of icon on the GUI. type: int more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

color yes yes yes yes yes yes yes yes yes yes yes
comment - Comment. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

comment yes yes yes yes yes yes yes yes yes yes yes
extip - Start-external-IPv6-address [-end-external-IPv6-address]. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

extip yes yes yes yes yes yes yes yes yes yes yes
extport - External service port. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

extport yes yes yes yes yes yes yes yes yes yes yes
id - Custom defined id. type: int more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

id yes yes yes yes yes yes yes yes yes yes yes

ldb_method - Load balance method. type: str choices: static, round-robin, weighted, least-session, least-rtt, first-alive more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
ldb_method	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[static]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[round-robin]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[weighted]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[least-session]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[least-rtt]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[first-alive]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

mappedip - Start-mapped-IP [-end-mapped-IP]. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

mappedip yes yes yes yes yes yes yes yes yes yes yes
mappedport - Mapped service port. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

mappedport yes yes yes yes yes yes yes yes yes yes yes
monitor - Health monitors. type: list more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

monitor yes yes yes yes yes yes yes yes yes yes yes

name - Health monitor name. Source firewall.ldb-monitor.name. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

name yes yes yes yes yes yes yes yes yes yes yes

name - VIP64 name. type: str required: true more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

name yes yes yes yes yes yes yes yes yes yes yes

portforward - Enable port forwarding. type: str choices: disable, enable more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
portforward	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

protocol - Mapped port protocol. type: str choices: tcp, udp more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
protocol	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[tcp]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[udp]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

realservers - Real servers. type: list more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

realservers yes yes yes yes yes yes yes yes yes yes yes

client_ip - Restrict server to a client IP in this range. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

client_ip yes yes yes yes yes yes yes yes yes yes yes

healthcheck - Per server health check. type: str choices: disable, enable, vip more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
healthcheck	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[vip]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

holddown_interval - Hold down interval. type: int more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

holddown_interval yes yes yes yes yes yes yes yes yes yes yes
id - Real server ID. type: int more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

id yes yes yes yes yes yes yes yes yes yes yes
ip - Mapped server IP. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

ip yes yes yes yes yes yes yes yes yes yes yes
max_connections - Maximum number of connections allowed to server. type: int more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

max_connections yes yes yes yes yes yes yes yes yes yes yes
monitor - Health monitors. Source firewall.ldb-monitor.name. type: list more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

monitor yes yes yes yes yes yes yes yes yes yes yes

name - Health monitor name. Source firewall.ldb-monitor.name. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

name no no no no no no no no no yes yes

port - Mapped server port. type: int more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

port yes yes yes yes yes yes yes yes yes yes yes

status - Server administrative status. type: str choices: active, standby, disable more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
status	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[active]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[standby]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

weight - weight type: int more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

weight yes yes yes yes yes yes yes yes yes yes yes

server_type - Server type. type: str choices: http, tcp, udp, ip more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
server_type	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[http]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[tcp]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[udp]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[ip]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

src_filter - Source IP6 filter (x:x:x:x:x:x:x:x/x). type: list more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

src_filter yes yes yes yes yes yes yes yes yes yes yes

range - Src-filter range. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

range yes yes yes yes yes yes yes yes yes yes yes

type - VIP type: static NAT or server load balance. type: str choices: static-nat, server-load-balance more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
type	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[static-nat]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[server-load-balance]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0

uuid yes yes yes yes yes yes yes yes yes yes yes

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 IPv6 to IPv4 virtual IPs.
    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: 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

Status

This module is not guaranteed to have a backwards compatible interface.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_firewall_vip64.rst

fortios_firewall_vip64.rst

fortios_firewall_vip64 -- Configure IPv6 to IPv4 virtual IPs in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fortios_firewall_vip64.rst

Latest commit

History

fortios_firewall_vip64.rst

File metadata and controls

fortios_firewall_vip64 -- Configure IPv6 to IPv4 virtual IPs in Fortinet's FortiOS and FortiGate.