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

Note

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

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

aliases: add-nat64-route

string

Enable/disable adding NAT64 route.

Choices:

  • "disable"

  • "enable"

arp_intf

aliases: arp-intf

string

Select an interface from available options that will reply to ARP requests.

arp_reply

aliases: arp-reply

string

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

Choices:

  • "disable"

  • "enable"

associated_interface

aliases: associated-interface

string

Associated interface name.

block_size

aliases: block-size

integer

Number of addresses in a block

cgn_block_size

aliases: cgn-block-size

integer

Number of ports in a block

cgn_client_endip

aliases: cgn-client-endip

string

Final client IPv4 address

cgn_client_ipv6shift

aliases: cgn-client-ipv6shift

integer

IPv6 shift for fixed-allocation.

cgn_client_startip

aliases: cgn-client-startip

string

First client IPv4 address

cgn_fixedalloc

aliases: cgn-fixedalloc

string

Enable/disable fixed-allocation mode.

Choices:

  • "disable"

  • "enable"

cgn_overload

aliases: cgn-overload

string

Enable/disable overload mode.

Choices:

  • "disable"

  • "enable"

cgn_port_end

aliases: cgn-port-end

integer

Ending public port can be allocated.

cgn_port_start

aliases: cgn-port-start

integer

Starting public port can be allocated.

cgn_spa

aliases: cgn-spa

string

Enable/disable single port allocation mode.

Choices:

  • "disable"

  • "enable"

client_prefix_length

aliases: client-prefix-length

integer

Subnet length of a single deterministic NAT64 client

comments

string

Comment.

dynamic_mapping

list / elements=dictionary

Dynamic mapping.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

add_nat64_route

aliases: add-nat64-route

string

Enable/disable adding NAT64 route.

Choices:

  • "disable"

  • "enable"

arp_intf

aliases: arp-intf

string

Arp intf.

arp_reply

aliases: arp-reply

string

Arp reply.

Choices:

  • "disable"

  • "enable"

associated_interface

aliases: associated-interface

string

Associated interface.

block_size

aliases: block-size

integer

Block size.

cgn_block_size

aliases: cgn-block-size

integer

Cgn block size.

cgn_client_endip

aliases: cgn-client-endip

string

Cgn client endip.

cgn_client_ipv6shift

aliases: cgn-client-ipv6shift

integer

IPv6 shift for fixed-allocation.

cgn_client_startip

aliases: cgn-client-startip

string

Cgn client startip.

cgn_fixedalloc

aliases: cgn-fixedalloc

string

Cgn fixedalloc.

Choices:

  • "disable"

  • "enable"

cgn_overload

aliases: cgn-overload

string

Cgn overload.

Choices:

  • "disable"

  • "enable"

cgn_port_end

aliases: cgn-port-end

integer

Cgn port end.

cgn_port_start

aliases: cgn-port-start

integer

Cgn port start.

cgn_spa

aliases: cgn-spa

string

Cgn spa.

Choices:

  • "disable"

  • "enable"

client_prefix_length

aliases: client-prefix-length

integer

Subnet length of a single deterministic NAT64 client

comments

string

Comments.

endip

string

Endip.

endport

integer

Final port number

exclude_ip

aliases: exclude-ip

any

(list) Exclude IPs x.

icmp_session_quota

aliases: icmp-session-quota

integer

Maximum number of concurrent ICMP sessions allowed per client

nat64

string

Enable/disable NAT64.

Choices:

  • "disable"

  • "enable"

num_blocks_per_user

aliases: num-blocks-per-user

integer

Num blocks per user.

pba_interim_log

aliases: pba-interim-log

integer

Port block allocation interim logging interval

pba_timeout

aliases: pba-timeout

integer

Pba timeout.

permit_any_host

aliases: permit-any-host

string

Permit any host.

Choices:

  • "disable"

  • "enable"

port_per_user

aliases: port-per-user

integer

Number of port for each user

privileged_port_use_pba

aliases: privileged-port-use-pba

string

Enable/disable selection of the external port from the port block allocation for NATing privileged ports

Choices:

  • "disable"

  • "enable"

source_endip

aliases: source-endip

string

Source endip.

source_prefix6

aliases: source-prefix6

string

Source IPv6 network to be translated

source_startip

aliases: source-startip

string

Source startip.

startip

string

Startip.

startport

integer

First port number

subnet_broadcast_in_ippool

aliases: subnet-broadcast-in-ippool

string

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

Choices:

  • "disable"

  • "enable"

tcp_session_quota

aliases: tcp-session-quota

integer

Maximum number of concurrent TCP sessions allowed per client

type

string

Type.

Choices:

  • "overload"

  • "one-to-one"

  • "fixed-port-range"

  • "port-block-allocation"

  • "cgn-resource-allocation"

udp_session_quota

aliases: udp-session-quota

integer

Maximum number of concurrent UDP sessions allowed per client

utilization_alarm_clear

aliases: utilization-alarm-clear

integer

Utilization alarm clear.

utilization_alarm_raise

aliases: utilization-alarm-raise

integer

Utilization alarm raise.

endip

string

Final IPv4 address

endport

integer

Final port number

exclude_ip

aliases: exclude-ip

any

(list) Exclude IPs x.

icmp_session_quota

aliases: icmp-session-quota

integer

Maximum number of concurrent ICMP sessions allowed per client

name

string / required

IP pool name.

nat64

string

Enable/disable NAT64.

Choices:

  • "disable"

  • "enable"

num_blocks_per_user

aliases: num-blocks-per-user

integer

Number of addresses blocks that can be used by a user

pba_interim_log

aliases: pba-interim-log

integer

Port block allocation interim logging interval

pba_timeout

aliases: pba-timeout

integer

Port block allocation timeout

permit_any_host

aliases: permit-any-host

string

Enable/disable full cone NAT.

Choices:

  • "disable"

  • "enable"

port_per_user

aliases: port-per-user

integer

Number of port for each user

privileged_port_use_pba

aliases: privileged-port-use-pba

string

Enable/disable selection of the external port from the port block allocation for NATing privileged ports

Choices:

  • "disable"

  • "enable"

source_endip

aliases: source-endip

string

Final IPv4 address

source_prefix6

aliases: source-prefix6

string

Source IPv6 network to be translated

source_startip

aliases: source-startip

string

First IPv4 address

startip

string

First IPv4 address

startport

integer

First port number

subnet_broadcast_in_ippool

aliases: subnet-broadcast-in-ippool

string

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

Choices:

  • "disable"

  • "enable"

tcp_session_quota

aliases: tcp-session-quota

integer

Maximum number of concurrent TCP sessions allowed per client

type

string

IP pool type

Choices:

  • "overload"

  • "one-to-one"

  • "fixed-port-range"

  • "port-block-allocation"

  • "cgn-resource-allocation"

udp_session_quota

aliases: udp-session-quota

integer

Maximum number of concurrent UDP sessions allowed per client

utilization_alarm_clear

aliases: utilization-alarm-clear

integer

Pool utilization alarm clear threshold

utilization_alarm_raise

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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 IP pools.
      fortinet.fortimanager.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: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv4 IP pools
      fortinet.fortimanager.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)