fortios_firewall_address – Configure IPv4 addresses in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
|
| fortios_firewall_address | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_address - Configure IPv4 addresses. type: dict more...
- allow_routing - Enable/disable use of this address in the static route configuration. type: str choices: enable, disable more...
- associated_interface - Network interface associated with address. Source system.interface.name system.zone.name. type: str more...
- cache_ttl - Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds. type: int more...
- clearpass_spt - SPT (System Posture Token) value. type: str choices: unknown, healthy, quarantine, checkup, transient, infected more...
- color - Color of icon on the GUI. type: int more...
- comment - Comment. type: str more...
- country - IP addresses associated to a specific country. type: str more...
- end_ip - Final IP address (inclusive) in the range for the address. type: str more...
- end_mac - Last MAC address in the range. type: str more...
- epg_name - Endpoint group name. type: str more...
- fabric_object - Security Fabric global object setting. type: str choices: enable, disable more...
- filter - Match criteria filter. type: str more...
- fqdn - Fully Qualified Domain Name address. type: str more...
- fsso_group - FSSO group(s). type: list member_path: fsso_group:name more...
- name - FSSO group name. Source user.adgrp.name. type: str required: true more...
- interface - Name of interface whose IP address is to be used. Source system.interface.name. type: str more...
- list - IP address list. type: list member_path: list:ip more...
- ip - IP. type: str required: true more...
- net_id - Network ID. type: str more...
- obj_id - Object ID. type: str more...
- macaddr - Multiple MAC address ranges. type: list member_path: macaddr:macaddr more...
- macaddr - MAC address ranges
[- ] separated by space. type: str required: true more... - name - Address name. type: str required: true more...
- node_ip_only - Enable/disable collection of node addresses only in Kubernetes. type: str choices: enable, disable more...
- obj_id - Object ID for NSX. type: str more...
- obj_tag - Tag of dynamic address object. type: str more...
- obj_type - Object type. type: str choices: ip, mac more...
- organization - Organization domain name (Syntax: organization/domain). type: str more...
- policy_group - Policy group name. type: str more...
- sdn - SDN. Source system.sdn-connector.name. type: str choices: aci, aws, azure, gcp, nsx, nuage, oci, openstack more...
- sdn_addr_type - Type of addresses to collect. type: str choices: private, public, all more...
- sdn_tag - SDN Tag. type: str more...
- start_ip - First IP address (inclusive) in the range for the address. type: str more...
- start_mac - First MAC address in the range. type: str more...
- sub_type - Sub-type of address. type: str choices: sdn, clearpass-spt, fsso, ems-tag, fortivoice-tag, fortinac-tag, swc-tag more...
- subnet - IP address and subnet mask of address. type: str more...
- subnet_name - Subnet name. type: str more...
- tag_detection_level - Tag detection level of dynamic address object. type: str more...
- tag_type - Tag type of dynamic address object. type: str more...
- tagging - Config object tagging. type: list member_path: tagging:name more...
- category - Tag category. Source system.object-tagging.category. type: str more...
- name - Tagging entry name. type: str required: true more...
- tags - Tags. type: list member_path: tagging:name/tags:name more...
- name - Tag name. Source system.object-tagging.tags.name. type: str required: true more...
- tenant - Tenant. type: str more...
- type - Type of address. type: str choices: ipmask, iprange, fqdn, geography, wildcard, dynamic, interface-subnet, mac, wildcard-fqdn more...
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
- visibility - Enable/disable address visibility in the GUI. type: str choices: enable, disable more...
- wildcard - IP address and wildcard netmask. type: str more...
- wildcard_fqdn - Fully Qualified Domain Name with wildcard characters. type: str more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure IPv4 addresses.
fortios_firewall_address:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_address:
allow_routing: "enable"
associated_interface: "<your_own_value> (source system.interface.name system.zone.name)"
cache_ttl: "5"
clearpass_spt: "unknown"
color: "7"
comment: "Comment."
country: "<your_own_value>"
end_ip: "<your_own_value>"
end_mac: "<your_own_value>"
epg_name: "<your_own_value>"
fabric_object: "enable"
filter: "<your_own_value>"
fqdn: "<your_own_value>"
fsso_group:
-
name: "default_name_17 (source user.adgrp.name)"
interface: "<your_own_value> (source system.interface.name)"
list:
-
ip: "<your_own_value>"
net_id: "<your_own_value>"
obj_id: "<your_own_value>"
macaddr:
-
macaddr: "<your_own_value>"
name: "default_name_25"
node_ip_only: "enable"
obj_id: "<your_own_value>"
obj_tag: "<your_own_value>"
obj_type: "ip"
organization: "<your_own_value>"
policy_group: "<your_own_value>"
sdn: "aci"
sdn_addr_type: "private"
sdn_tag: "<your_own_value>"
start_ip: "<your_own_value>"
start_mac: "<your_own_value>"
sub_type: "sdn"
subnet: "<your_own_value>"
subnet_name: "<your_own_value>"
tag_detection_level: "<your_own_value>"
tag_type: "<your_own_value>"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_44"
tags:
-
name: "default_name_46 (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>"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3