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

New in version 2.0.0.

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.0

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_vip46 v6.0.0 -> v7.0.0

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_vip46 - Configure IPv4 to IPv6 virtual IPs. type: dict more...
    • arp_reply - Enable ARP reply. type: str choices: disable, enable more...
    • color - Color of icon on the GUI. type: int more...
    • comment - Comment. type: str more...
    • extip - Start-external-IP [-end-external-IP]. type: str more...
    • extport - External service port. type: str more...
    • id - Custom defined id. type: int more...
    • ldb_method - Load balance method. type: str choices: static, round-robin, weighted, least-session, least-rtt, first-alive more...
    • mappedip - Start-mapped-IPv6-address [-end mapped-IPv6-address]. type: str more...
    • mappedport - Mapped service port. type: str more...
    • monitor - Health monitors. type: list member_path: monitor:name more...
      • name - Health monitor name. Source firewall.ldb-monitor.name. type: str required: true more...
    • name - VIP46 name. type: str required: true more...
    • portforward - Enable port forwarding. type: str choices: disable, enable more...
    • protocol - Mapped port protocol. type: str choices: tcp, udp more...
    • realservers - Real servers. type: list member_path: realservers:id more...
      • client_ip - Restrict server to a client IP in this range. type: str more...
      • healthcheck - Per server health check. type: str choices: disable, enable, vip more...
      • holddown_interval - Hold down interval. type: int more...
      • id - Real server ID. see Notes. type: int required: true more...
      • ip - Mapped server IPv6. type: str more...
      • max_connections - Maximum number of connections allowed to server. type: int more...
      • monitor - Health monitors. Source firewall.ldb-monitor.name. type: list member_path: realservers:id/monitor:name more...
        • name - Health monitor name. Source firewall.ldb-monitor.name. type: str required: true more...
      • port - Mapped server port. type: int more...
      • status - Server administrative status. type: str choices: active, standby, disable more...
      • weight - weight type: int more...
    • server_type - Server type. type: str choices: http, tcp, udp, ip more...
    • src_filter - Source IP filter (x.x.x.x/x). type: list member_path: src_filter:range more...
      • range - Src-filter range. type: str required: true more...
    • srcintf_filter - Interfaces to which the VIP46 applies. Separate the names with spaces. type: list member_path: srcintf_filter:interface_name more...
      • interface_name - Interface name. Source system.interface.name. type: str required: true more...
    • type - VIP type: static NAT or server load balance. type: str choices: static-nat, server-load-balance more...
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure IPv4 to IPv6 virtual IPs.
  fortinet.fortios.fortios_firewall_vip46:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_vip46:
          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>"
          srcintf_filter:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          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.