ansible.builtin.fortios_firewall_central_snat_map (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and central_snat_map category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure central SNAT policies.
    fortios_firewall_central_snat_map:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_central_snat_map:
        state: "present"
        comments: "<your_own_value>"
        dst-addr:
         -
            name: "default_name_5 (source firewall.address.name firewall.addrgrp.name)"
        dstintf:
         -
            name: "default_name_7 (source system.interface.name system.zone.name)"
        nat: "disable"
        nat-ippool:
         -
            name: "default_name_10 (source firewall.ippool.name)"
        nat-port: "<your_own_value>"
        orig-addr:
         -
            name: "default_name_13 (source firewall.address.name firewall.addrgrp.name)"
        orig-port: "<your_own_value>"
        policyid: "15"
        protocol: "16"
        srcintf:
         -
            name: "default_name_18 (source system.interface.name system.zone.name)"
        status: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

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

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

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_central_snat_map:
    default: null
    description:
    - Configure central SNAT policies.
    suboptions:
      comments:
        description:
        - Comment.
      dst-addr:
        description:
        - Destination address name from available addresses.
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name.
            required: true
      dstintf:
        description:
        - Destination interface name from available interfaces.
        suboptions:
          name:
            description:
            - Interface name. Source system.interface.name system.zone.name.
            required: true
      nat:
        choices:
        - disable
        - enable
        description:
        - Enable/disable source NAT.
      nat-ippool:
        description:
        - Name of the IP pools to be used to translate addresses from available IP Pools.
        suboptions:
          name:
            description:
            - IP pool name. Source firewall.ippool.name.
            required: true
      nat-port:
        description:
        - Translated port or port range (0 to 65535).
      orig-addr:
        description:
        - Original address.
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name.
            required: true
      orig-port:
        description:
        - Original TCP port (0 to 65535).
      policyid:
        description:
        - Policy ID.
        required: true
      protocol:
        description:
        - Integer value for the protocol type (0 - 255).
      srcintf:
        description:
        - Source interface name from available interfaces.
        suboptions:
          name:
            description:
            - Interface name. Source system.interface.name system.zone.name.
            required: true
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable the active status of this policy.

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