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

Note

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

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

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

access_token

string

The token to access FortiManager without using username and password.

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:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_ippool

dictionary

the top level parameters set

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.

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.

block-size

integer

Number of addresses in a block

cgn-block-size

integer

Number of ports in a block

cgn-client-endip

string

Final client IPv4 address

cgn-client-ipv6shift

integer

IPv6 shift for fixed-allocation.

cgn-client-startip

string

First client IPv4 address

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.

dynamic_mapping

list / elements=dictionary

Dynamic_Mapping.

_scope

list / elements=dictionary

_Scope.

name

string

Name.

vdom

string

Vdom.

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.

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.

block-size

integer

Number of addresses in a block

cgn-block-size

integer

Number of ports in a block

cgn-client-endip

string

Final client IPv4 address

cgn-client-ipv6shift

integer

IPv6 shift for fixed-allocation.

cgn-client-startip

string

First client IPv4 address

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

endport

integer

Final port number

exclude-ip

any

(list) no description

nat64

string

Enable/disable NAT64.

Choices:

  • "disable"

  • "enable"

num-blocks-per-user

integer

Number of addresses blocks that can be used by a user

pba-timeout

integer

Port block allocation timeout

permit-any-host

string

Enable/disable full cone NAT.

Choices:

  • "disable"

  • "enable"

port-per-user

integer

Number of port for each user

source-endip

string

Final IPv4 address

source-startip

string

First IPv4 address

startip

string

First IPv4 address

startport

integer

First port number

subnet-broadcast-in-ippool

string

Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool.

Choices:

  • "disable"

  • "enable"

type

string

IP pool type

Choices:

  • "overload"

  • "one-to-one"

  • "fixed-port-range"

  • "port-block-allocation"

  • "cgn-resource-allocation"

utilization-alarm-clear

integer

Pool utilization alarm clear threshold

utilization-alarm-raise

integer

Pool utilization alarm raise threshold

endip

string

Final IPv4 address

endport

integer

Final port number

exclude-ip

any

(list) no description

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

pba-timeout

integer

Port block allocation timeout

permit-any-host

string

Enable/disable full cone NAT.

Choices:

  • "disable"

  • "enable"

port-per-user

integer

Number of port for each user

source-endip

string

Final IPv4 address

source-startip

string

First IPv4 address

startip

string

First IPv4 address

startport

integer

First port number

subnet-broadcast-in-ippool

string

Enable/disable inclusion of the subnetwork address and broadcast IP address in the NAT64 IP pool.

Choices:

  • "disable"

  • "enable"

type

string

IP pool type

Choices:

  • "overload"

  • "one-to-one"

  • "fixed-port-range"

  • "port-block-allocation"

  • "cgn-resource-allocation"

utilization-alarm-clear

integer

Pool utilization alarm clear threshold

utilization-alarm-raise

integer

Pool utilization alarm raise threshold

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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: 'your_value'

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)