fortios_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs in Fortinet’s FortiOS and FortiGate

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
firewall_vip46 dictionary | Default: null | Configure IPv4 to IPv6 virtual IPs.
| arp_reply string | Choices: disable enable | 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 | Choices: static round-robin weighted least-session least-rtt first-alive | Load balance method.
| mappedip string |  | Start-mapped-IP [-end mapped-IP].
| mappedport string |  | Mapped service port.
| monitor list |  | Health monitors.
|  | name string / required |  | Health monitor name. Source firewall.ldb-monitor.name.
| name string / required |  | VIP46 name.
| portforward string | Choices: disable enable | Enable port forwarding.
| protocol string | Choices: tcp udp | Mapped port protocol.
| realservers list |  | Real servers.
|  | client_ip string |  | Restrict server to a client IP in this range.
|  | healthcheck string | Choices: disable enable vip | 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 | Choices: active standby disable | Server administrative status.
|  | weight integer |  | weight
| server_type string | Choices: http tcp udp ip | Server type.
| src_filter list |  | Source IP filter (x.x.x.x/x).
|  | range string / required |  | Src-filter range.
| state string | Choices: present absent | Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
| type string | Choices: static-nat server-load-balance | VIP type: static NAT or server load balance.
| uuid string |  | Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean added in 2.9 | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9 | Choices: present absent | 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.
username string |  | FortiOS or FortiGate username.
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

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure IPv4 to IPv6 virtual IPs.
        fortios_firewall_vip46:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          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>"
            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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.