New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
firewall_address
-
|
Default: null
|
Configure IPv4 addresses.
|
|||
allow-routing
-
|
|
Enable/disable use of this address in the static route configuration.
|
|||
associated-interface
-
|
Network interface associated with address. Source system.interface.name system.zone.name.
|
||||
cache-ttl
-
|
Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
|
||||
color
-
|
Color of icon on the GUI.
|
||||
comment
-
|
Comment.
|
||||
country
-
|
IP addresses associated to a specific country.
|
||||
end-ip
-
|
Final IP address (inclusive) in the range for the address.
|
||||
epg-name
-
|
Endpoint group name.
|
||||
filter
-
|
Match criteria filter.
|
||||
fqdn
-
|
Fully Qualified Domain Name address.
|
||||
list
-
|
IP address list.
|
||||
ip
-
/ required
|
IP.
|
||||
name
-
/ required
|
Address name.
|
||||
obj-id
-
|
Object ID for NSX.
|
||||
organization
-
|
Organization domain name (Syntax: organization/domain).
|
||||
policy-group
-
|
Policy group name.
|
||||
sdn
-
|
|
SDN.
|
|||
sdn-tag
-
|
SDN Tag.
|
||||
start-ip
-
|
First IP address (inclusive) in the range for the address.
|
||||
state
-
|
|
Indicates whether to create or remove the object
|
|||
subnet
-
|
IP address and subnet mask of address.
|
||||
subnet-name
-
|
Subnet name.
|
||||
tagging
-
|
Config object tagging.
|
||||
category
-
|
Tag category. Source system.object-tagging.category.
|
||||
name
-
/ required
|
Tagging entry name.
|
||||
tags
-
|
Tags.
|
||||
name
-
/ required
|
Tag name. Source system.object-tagging.tags.name.
|
||||
tenant
-
|
Tenant.
|
||||
type
-
|
|
Type of address.
|
|||
uuid
-
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
|
||||
visibility
-
|
|
Enable/disable address visibility in the GUI.
|
|||
wildcard
-
|
IP address and wildcard netmask.
|
||||
wildcard-fqdn
-
|
Fully Qualified Domain Name with wildcard characters.
|
||||
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 addresses.
fortios_firewall_address:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
firewall_address:
state: "present"
allow-routing: "enable"
associated-interface: "<your_own_value> (source system.interface.name system.zone.name)"
cache-ttl: "5"
color: "6"
comment: "Comment."
country: "<your_own_value>"
end-ip: "<your_own_value>"
epg-name: "<your_own_value>"
filter: "<your_own_value>"
fqdn: "<your_own_value>"
list:
-
ip: "<your_own_value>"
name: "default_name_15"
obj-id: "<your_own_value>"
organization: "<your_own_value>"
policy-group: "<your_own_value>"
sdn: "aci"
sdn-tag: "<your_own_value>"
start-ip: "<your_own_value>"
subnet: "<your_own_value>"
subnet-name: "<your_own_value>"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_26"
tags:
-
name: "default_name_28 (source system.object-tagging.tags.name)"
tenant: "<your_own_value>"
type: "ipmask"
uuid: "<your_own_value>"
visibility: "enable"
wildcard: "<your_own_value>"
wildcard-fqdn: "<your_own_value>"
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.