Try SpotterConfigure IPv4 addresses in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This 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
- name: Configure IPv4 addresses.
fortinet.fortios.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: "0"
clearpass_spt: "unknown"
color: "0"
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)"
hw_model: "<your_own_value>"
hw_vendor: "<your_own_value>"
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_27"
node_ip_only: "enable"
obj_id: "<your_own_value>"
obj_tag: "<your_own_value>"
obj_type: "ip"
organization: "<your_own_value>"
os: "<your_own_value>"
policy_group: "<your_own_value>"
route_tag: "0"
sdn: "<your_own_value> (source system.sdn-connector.name)"
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>"
sw_version: "<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_49"
tags:
-
name: "default_name_51 (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>"
vdom:
default: root
description:
- 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
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
firewall_address:
default: null
description:
- Configure IPv4 addresses.
suboptions:
allow_routing:
choices:
- enable
- disable
description:
- Enable/disable use of this address in the static route configuration.
type: str
associated_interface:
description:
- Network interface associated with address. Source system.interface.name system.zone.name.
type: str
cache_ttl:
description:
- Defines the minimal TTL of individual IP addresses in FQDN cache measured in
seconds.
type: int
clearpass_spt:
choices:
- unknown
- healthy
- quarantine
- checkup
- transient
- infected
description:
- SPT (System Posture Token) value.
type: str
color:
description:
- Color of icon on the GUI.
type: int
comment:
description:
- Comment.
type: str
country:
description:
- IP addresses associated to a specific country.
type: str
end_ip:
description:
- Final IP address (inclusive) in the range for the address.
type: str
end_mac:
description:
- Last MAC address in the range.
type: str
epg_name:
description:
- Endpoint group name.
type: str
fabric_object:
choices:
- enable
- disable
description:
- Security Fabric global object setting.
type: str
filter:
description:
- Match criteria filter.
type: str
fqdn:
description:
- Fully Qualified Domain Name address.
type: str
fsso_group:
description:
- FSSO group(s).
elements: dict
suboptions:
name:
description:
- FSSO group name. Source user.adgrp.name.
required: true
type: str
type: list
hw_model:
description:
- Dynamic address matching hardware model.
type: str
hw_vendor:
description:
- Dynamic address matching hardware vendor.
type: str
interface:
description:
- Name of interface whose IP address is to be used. Source system.interface.name.
type: str
list:
description:
- IP address list.
elements: dict
suboptions:
ip:
description:
- IP.
required: true
type: str
net_id:
description:
- Network ID.
type: str
obj_id:
description:
- Object ID.
type: str
type: list
macaddr:
description:
- Multiple MAC address ranges.
elements: dict
suboptions:
macaddr:
description:
- MAC address ranges <start>[-<end>] separated by space.
required: true
type: str
type: list
name:
description:
- Address name.
required: true
type: str
node_ip_only:
choices:
- enable
- disable
description:
- Enable/disable collection of node addresses only in Kubernetes.
type: str
obj_id:
description:
- Object ID for NSX.
type: str
obj_tag:
description:
- Tag of dynamic address object.
type: str
obj_type:
choices:
- ip
- mac
description:
- Object type.
type: str
organization:
description:
- 'Organization domain name (Syntax: organization/domain).'
type: str
os:
description:
- Dynamic address matching operating system.
type: str
policy_group:
description:
- Policy group name.
type: str
route_tag:
description:
- route-tag address.
type: int
sdn:
description:
- SDN. Source system.sdn-connector.name.
type: str
sdn_addr_type:
choices:
- private
- public
- all
description:
- Type of addresses to collect.
type: str
sdn_tag:
description:
- SDN Tag.
type: str
start_ip:
description:
- First IP address (inclusive) in the range for the address.
type: str
start_mac:
description:
- First MAC address in the range.
type: str
sub_type:
choices:
- sdn
- clearpass-spt
- fsso
- ems-tag
- fortivoice-tag
- fortinac-tag
- fortipolicy-tag
- swc-tag
- device-identification
description:
- Sub-type of address.
type: str
subnet:
description:
- IP address and subnet mask of address.
type: str
subnet_name:
description:
- Subnet name.
type: str
sw_version:
description:
- Dynamic address matching software version.
type: str
tag_detection_level:
description:
- Tag detection level of dynamic address object.
type: str
tag_type:
description:
- Tag type of dynamic address object.
type: str
tagging:
description:
- Config object tagging.
elements: dict
suboptions:
category:
description:
- Tag category. Source system.object-tagging.category.
type: str
name:
description:
- Tagging entry name.
required: true
type: str
tags:
description:
- Tags.
elements: dict
suboptions:
name:
description:
- Tag name. Source system.object-tagging.tags.name.
required: true
type: str
type: list
type: list
tenant:
description:
- Tenant.
type: str
type:
choices:
- ipmask
- iprange
- fqdn
- geography
- wildcard
- dynamic
- interface-subnet
- mac
- route-tag
- wildcard-fqdn
description:
- Type of address.
type: str
uuid:
description:
- Universally Unique Identifier (UUID; automatically assigned but can be manually
reset).
type: str
visibility:
choices:
- enable
- disable
description:
- Enable/disable address visibility in the GUI.
type: str
wildcard:
description:
- IP address and wildcard netmask.
type: str
wildcard_fqdn:
description:
- Fully Qualified Domain Name with wildcard characters.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str