ansible.builtin.fortios_system_nat64 (v2.9.27) — module

Configure NAT64 in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and nat64 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure NAT64.
    fortios_system_nat64:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      system_nat64:
        always_synthesize_aaaa_record: "enable"
        generate_ipv6_fragment_header: "enable"
        nat46_force_ipv4_packet_forwarding: "enable"
        nat64_prefix: "<your_own_value>"
        secondary_prefix:
         -
            name: "default_name_8"
            nat64_prefix: "<your_own_value>"
        secondary_prefix_status: "enable"
        status: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_nat64:
    default: null
    description:
    - Configure NAT64.
    suboptions:
      always_synthesize_aaaa_record:
        choices:
        - enable
        - disable
        description:
        - Enable/disable AAAA record synthesis .
        type: str
      generate_ipv6_fragment_header:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPv6 fragment header generation.
        type: str
      nat46_force_ipv4_packet_forwarding:
        choices:
        - enable
        - disable
        description:
        - Enable/disable mandatory IPv4 packet forwarding in nat46.
        type: str
      nat64_prefix:
        description:
        - NAT64 prefix must be ::/96 .
        type: str
      secondary_prefix:
        description:
        - Secondary NAT64 prefix.
        suboptions:
          name:
            description:
            - NAT64 prefix name.
            required: true
            type: str
          nat64_prefix:
            description:
            - NAT64 prefix.
            type: str
        type: list
      secondary_prefix_status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable secondary NAT64 prefix.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable NAT64 .
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str