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 by allowing the user to configure firewall feature and vip64 category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2
 
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
 
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
|  firewall_vip64   -    |   Default: null   |    Configure IPv6 to IPv4 virtual IPs.   |  ||
|  arp-reply   -    |   
  |    Enable ARP reply.   |  ||
|  color   -    |    Color of icon on the GUI.   |  |||
|  comment   -    |    Comment.   |  |||
|  extip   -    |    Start-external-IP [-end-external-IP].   |  |||
|  extport   -    |    External service port.   |  |||
|  id   -    |    Custom defined id.   |  |||
|  ldb-method   -    |   
  |    Load balance method.   |  ||
|  mappedip   -    |    Start-mapped-IP [-end-mapped-IP].   |  |||
|  mappedport   -    |    Mapped service port.   |  |||
|  monitor   -    |    Health monitors.   |  |||
|  name   - / required    |    Health monitor name. Source firewall.ldb-monitor.name.   |  |||
|  name   - / required    |    VIP64 name.   |  |||
|  portforward   -    |   
  |    Enable port forwarding.   |  ||
|  protocol   -    |   
  |    Mapped port protocol.   |  ||
|  realservers   -    |    Real servers.   |  |||
|  client-ip   -    |    Restrict server to a client IP in this range.   |  |||
|  healthcheck   -    |   
  |    Per server health check.   |  ||
|  holddown-interval   -    |    Hold down interval.   |  |||
|  id   - / required    |    Real server ID.   |  |||
|  ip   -    |    Mapped server IP.   |  |||
|  max-connections   -    |    Maximum number of connections allowed to server.   |  |||
|  monitor   -    |    Health monitors. Source firewall.ldb-monitor.name.   |  |||
|  port   -    |    Mapped server port.   |  |||
|  status   -    |   
  |    Server administrative status.   |  ||
|  weight   -    |    weight   |  |||
|  server-type   -    |   
  |    Server type.   |  ||
|  src-filter   -    |    Source IP6 filter (x:x:x:x:x:x:x:x/x).   |  |||
|  range   - / required    |    Src-filter range.   |  |||
|  state   -    |   
  |    Indicates whether to create or remove the object   |  ||
|  type   -    |   
  |    VIP type: static NAT or server load balance.   |  ||
|  uuid   -    |    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).   |  |||
|  host   - / required    |    FortiOS or FortiGate ip address.   |  |||
|  https   boolean    |   
  |    Indicates if the requests towards FortiGate must use HTTPS protocol   |  ||
|  password   -    |   Default: ""   |    FortiOS or FortiGate password.   |  ||
|  username   - / required    |    FortiOS or FortiGate username.   |  |||
|  vdom   -    |   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"
  tasks:
  - name: Configure IPv6 to IPv4 virtual IPs.
    fortios_firewall_vip64:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_vip64:
        state: "present"
        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:  key1   |  
|  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.
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.8/modules/fortios_firewall_vip64_module.html