fortinet.fortimanager.fmgr_firewall_ippool module – Configure IPv4 IP pools.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_ippool.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

firewall_ippool

dictionary

the top level parameters set

arp-intf

string

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

arp-reply

string

Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable).

Choices:

  • disable

  • enable

associated-interface

string

Associated interface name.

block-size

integer

Number of addresses in a block (64 to 4096, default = 128).

comments

string

Comment.

dynamic_mapping

list / elements=string

Dynamic_Mapping.

_scope

list / elements=string

_Scope.

name

string

Name.

vdom

string

Vdom.

arp-intf

string

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

arp-reply

string

Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable).

Choices:

  • disable

  • enable

associated-interface

string

Associated interface name.

block-size

integer

Number of addresses in a block (64 to 4096, default = 128).

cgn-block-size

integer

Number of ports in a block(64 to 4096 in unit of 64, default = 128).

cgn-client-endip

string

Final client IPv4 address (inclusive) (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).

cgn-client-startip

string

First client IPv4 address (inclusive) (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).

cgn-fixedalloc

string

Enable/disable fixed-allocation mode.

Choices:

  • disable

  • enable

cgn-overload

string

Enable/disable overload mode.

Choices:

  • disable

  • enable

cgn-port-end

integer

Ending public port can be allocated.

cgn-port-start

integer

Starting public port can be allocated.

cgn-spa

string

Enable/disable single port allocation mode.

Choices:

  • disable

  • enable

comments

string

Comment.

endip

string

Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).

endport

integer

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

num-blocks-per-user

integer

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

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, default = 0, auto).

source-endip

string

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

source-startip

string

First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default:…

startip

string

First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).

startport

integer

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

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

  • cgn-resource-allocation

utilization-alarm-clear

integer

Pool utilization alarm clear threshold (40-100).

utilization-alarm-raise

integer

Pool utilization alarm raise threshold (50-100).

endip

string

Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).

endport

integer

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

name

string

IP pool name.

num-blocks-per-user

integer

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

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, default = 0, auto).

source-endip

string

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

source-startip

string

First IPv4 address (inclusive) in the range of the source addresses to be translated (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).

startip

string

First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).

startport

integer

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

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

  • cgn-resource-allocation

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 IP pools.
     fmgr_firewall_ippool:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_ippool:
           comments: 'ansible-comment'
           endip: '222.222.222.254'
           name: 'ansible-test'
           startip: '222.222.222.0'
           type: overload #<value in [overload, one-to-one, fixed-port-range, ...]>
- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv4 IP pools
     fmgr_fact:
       facts:
           selector: 'firewall_ippool'
           params:
               adom: 'ansible'
               ippool: ''

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)