fortinet.fortios.fortios_firewall_ippool – Configure IPv4 IP pools in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_ippool.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ippool 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.9.0

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

firewall_ippool

dictionary

Configure IPv4 IP pools.

add_nat64_route

string

Enable/disable adding NAT64 route.

Choices:

  • disable

  • enable

arp_intf

string

Select an interface from available options that will reply to ARP requests. (If blank, any is selected). Source system.interface.name.

arp_reply

string

Enable/disable replying to ARP requests when an IP Pool is added to a policy .

Choices:

  • disable

  • enable

associated_interface

string

Associated interface name. Source system.interface.name.

block_size

integer

Number of addresses in a block (64 to 4096).

comments

string

Comment.

endip

string

Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx).

endport

integer

Final port number (inclusive) in the range for the address pool .

name

string / required

IP pool name.

nat64

string

Enable/disable NAT64.

Choices:

  • disable

  • enable

num_blocks_per_user

integer

Number of addresses blocks that can be used by a user (1 to 128).

pba_timeout

integer

Port block allocation timeout (seconds).

permit_any_host

string

Enable/disable full cone NAT.

Choices:

  • disable

  • enable

port_per_user

integer

Number of port for each user (32 to 60416).

source_endip

string

Final IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx).

source_startip

string
First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx).

startip

string

First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx).

startport

integer

First port number (inclusive) in the range for the address pool .

type

string

IP pool type (overload, one-to-one, fixed port range, or port block allocation).

Choices:

  • overload

  • one-to-one

  • fixed-port-range

  • port-block-allocation

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

state

string / required

Indicates whether to create or remove the object.

Choices:

  • present

  • absent

vdom

string

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.

Default: “root”

Notes

Note

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

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_firewall_ippool
    fortios_firewall_ippool:
      vdom: root
      state: present
      firewall_ippool:
        arp_reply: enable
        block_size: 128
        endip: 11.11.11.5
        endport: 65533
        name: terr_ippool
        num_blocks_per_user: 8
        pba_timeout: 30
        permit_any_host: disable
        port_per_user: 0
        source_endip: 0.0.0.0
        source_startip: 0.0.0.0
        startip: 11.11.11.1
        startport: 5117
        type: overload

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)