fortinet.fortimanager.fmgr_firewall_ippool – Configure IPv4 IP pools.

Note

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

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
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
    Choices:
  • disable
  • enable
Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = 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
no description
_scope
list / elements=string
no description
name
string
no description
vdom
string
no description
arp-intf
string
no description
arp-reply
string
    Choices:
  • disable
  • enable
no description
associated-interface
string
no description
block-size
integer
no description
cgn-block-size
integer
no description
cgn-client-endip
string
no description
cgn-client-startip
string
no description
cgn-fixedalloc
string
    Choices:
  • disable
  • enable
no description
cgn-overload
string
    Choices:
  • disable
  • enable
no description
cgn-port-end
integer
no description
cgn-port-start
integer
no description
cgn-spa
string
    Choices:
  • disable
  • enable
no description
comments
string
no description
endip
string
no description
endport
integer
Final port number (inclusive) in the range for the address pool (Default: 65533).
num-blocks-per-user
integer
no description
pba-timeout
integer
no description
permit-any-host
string
    Choices:
  • disable
  • enable
no description
port-per-user
integer
Number of port for each user (32 to 60416, default = 0, auto).
source-endip
string
no description
source-startip
string
no description
startip
string
no description
startport
integer
First port number (inclusive) in the range for the address pool (Default: 5117).
type
string
    Choices:
  • overload
  • one-to-one
  • fixed-port-range
  • port-block-allocation
  • cgn-resource-allocation
no description
utilization-alarm-clear
integer
no description
utilization-alarm-raise
integer
no description
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
    Choices:
  • disable
  • enable
Enable/disable full cone NAT.
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
    Choices:
  • overload
  • one-to-one
  • fixed-port-range
  • port-block-allocation
  • cgn-resource-allocation
IP pool type (overload, one-to-one, fixed port range, or port block allocation).
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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: fortimanager-inventory
  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
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_ippool:
           arp-intf: <value of string>
           arp-reply: <value in [disable, enable]>
           associated-interface: <value of string>
           block-size: <value of integer>
           comments: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 arp-intf: <value of string>
                 arp-reply: <value in [disable, enable]>
                 associated-interface: <value of string>
                 block-size: <value of integer>
                 comments: <value of string>
                 endip: <value of string>
                 num-blocks-per-user: <value of integer>
                 pba-timeout: <value of integer>
                 permit-any-host: <value in [disable, enable]>
                 source-endip: <value of string>
                 source-startip: <value of string>
                 startip: <value of string>
                 type: <value in [overload, one-to-one, fixed-port-range, ...]>
                 cgn-block-size: <value of integer>
                 cgn-client-endip: <value of string>
                 cgn-client-startip: <value of string>
                 cgn-fixedalloc: <value in [disable, enable]>
                 cgn-overload: <value in [disable, enable]>
                 cgn-port-end: <value of integer>
                 cgn-port-start: <value of integer>
                 cgn-spa: <value in [disable, enable]>
                 utilization-alarm-clear: <value of integer>
                 utilization-alarm-raise: <value of integer>
                 endport: <value of integer>
                 port-per-user: <value of integer>
                 startport: <value of integer>
           endip: <value of string>
           name: <value of string>
           num-blocks-per-user: <value of integer>
           pba-timeout: <value of integer>
           permit-any-host: <value in [disable, enable]>
           source-endip: <value of string>
           source-startip: <value of string>
           startip: <value of string>
           type: <value in [overload, one-to-one, fixed-port-range, ...]>
           endport: <value of integer>
           port-per-user: <value of integer>
           startport: <value of integer>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)