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

Configure IPv4 addresses.

| "added in version" 2.8 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.8.20

Description

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


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"
  tasks:
  - name: Configure IPv4 addresses.
    fortios_firewall_address:
      host:  "{{  host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{  vdom }}"
      firewall_address:
        state: "present"
        allow-routing: "enable"
        associated-interface: "<your_own_value> (source system.interface.name system.zone.name)"
        cache-ttl: "5"
        color: "6"
        comment: "Comment."
        country: "<your_own_value>"
        end-ip: "<your_own_value>"
        epg-name: "<your_own_value>"
        filter: "<your_own_value>"
        fqdn: "<your_own_value>"
        list:
         -
            ip: "<your_own_value>"
        name: "default_name_15"
        obj-id: "<your_own_value>"
        organization: "<your_own_value>"
        policy-group: "<your_own_value>"
        sdn: "aci"
        sdn-tag: "<your_own_value>"
        start-ip: "<your_own_value>"
        subnet: "<your_own_value>"
        subnet-name: "<your_own_value>"
        tagging:
         -
            category: "<your_own_value> (source system.object-tagging.category)"
            name: "default_name_26"
            tags:
             -
                name: "default_name_28 (source system.object-tagging.tags.name)"
        tenant: "<your_own_value>"
        type: "ipmask"
        uuid: "<your_own_value>"
        visibility: "enable"
        wildcard: "<your_own_value>"
        wildcard-fqdn: "<your_own_value>"

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_address:
    default: null
    description:
    - Configure IPv4 addresses.
    suboptions:
      allow-routing:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of this address in the static route configuration.
      associated-interface:
        description:
        - Network interface associated with address. Source system.interface.name system.zone.name.
      cache-ttl:
        description:
        - Defines the minimal TTL of individual IP addresses in FQDN cache measured in
          seconds.
      color:
        description:
        - Color of icon on the GUI.
      comment:
        description:
        - Comment.
      country:
        description:
        - IP addresses associated to a specific country.
      end-ip:
        description:
        - Final IP address (inclusive) in the range for the address.
      epg-name:
        description:
        - Endpoint group name.
      filter:
        description:
        - Match criteria filter.
      fqdn:
        description:
        - Fully Qualified Domain Name address.
      list:
        description:
        - IP address list.
        suboptions:
          ip:
            description:
            - IP.
            required: true
      name:
        description:
        - Address name.
        required: true
      obj-id:
        description:
        - Object ID for NSX.
      organization:
        description:
        - 'Organization domain name (Syntax: organization/domain).'
      policy-group:
        description:
        - Policy group name.
      sdn:
        choices:
        - aci
        - aws
        - azure
        - gcp
        - nsx
        - nuage
        - oci
        description:
        - SDN.
      sdn-tag:
        description:
        - SDN Tag.
      start-ip:
        description:
        - First IP address (inclusive) in the range for the address.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      subnet:
        description:
        - IP address and subnet mask of address.
      subnet-name:
        description:
        - Subnet name.
      tagging:
        description:
        - Config object tagging.
        suboptions:
          category:
            description:
            - Tag category. Source system.object-tagging.category.
          name:
            description:
            - Tagging entry name.
            required: true
          tags:
            description:
            - Tags.
            suboptions:
              name:
                description:
                - Tag name. Source system.object-tagging.tags.name.
                required: true
      tenant:
        description:
        - Tenant.
      type:
        choices:
        - ipmask
        - iprange
        - fqdn
        - geography
        - wildcard
        - wildcard-fqdn
        - dynamic
        description:
        - Type of address.
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
      visibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable address visibility in the GUI.
      wildcard:
        description:
        - IP address and wildcard netmask.
      wildcard-fqdn:
        description:
        - Fully Qualified Domain Name with wildcard characters.

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: key1
  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