New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
firewall_ippool
-
|
Default: null
|
Configure IPv4 IP pools.
|
|
arp-intf
-
|
Select an interface from available options that will reply to ARP requests. (If blank, any is selected). Source system.interface.name.
|
||
arp-reply
-
|
|
Enable/disable replying to ARP requests when an IP Pool is added to a policy (default = enable).
|
|
associated-interface
-
|
Associated interface name. Source system.interface.name.
|
||
block-size
-
|
Number of addresses in a block (64 to 4096, default = 128).
|
||
comments
-
|
Comment.
|
||
endip
-
|
Final IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
|
||
name
-
/ required
|
IP pool name.
|
||
num-blocks-per-user
-
|
Number of addresses blocks that can be used by a user (1 to 128, default = 8).
|
||
pba-timeout
-
|
Port block allocation timeout (seconds).
|
||
permit-any-host
-
|
|
Enable/disable full cone NAT.
|
|
source-endip
-
|
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
-
|
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
-
|
First IPv4 address (inclusive) in the range for the address pool (format xxx.xxx.xxx.xxx, Default: 0.0.0.0).
|
||
state
-
|
|
Indicates whether to create or remove the object
|
|
type
-
|
|
IP pool type (overload, one-to-one, fixed port range, or port block allocation).
|
|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
Default: "root"
|
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.
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure IPv4 IP pools.
fortios_firewall_ippool:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
firewall_ippool:
state: "present"
arp-intf: "<your_own_value> (source system.interface.name)"
arp-reply: "disable"
associated-interface: "<your_own_value> (source system.interface.name)"
block-size: "6"
comments: "<your_own_value>"
endip: "<your_own_value>"
name: "default_name_9"
num-blocks-per-user: "10"
pba-timeout: "11"
permit-any-host: "disable"
source-endip: "<your_own_value>"
source-startip: "<your_own_value>"
startip: "<your_own_value>"
type: "overload"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
key1
|
name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
status
string
|
always |
Indication of the operation's result
Sample:
success
|
vdom
string
|
always |
Virtual domain used
Sample:
root
|
version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.