fortios_firewall_address – Configure IPv4 addresses in Fortinet’s FortiOS and FortiGate

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

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.5

Requirements

The below requirements are needed on the host that executes this module.

fortiosapi>=0.9.8

Parameters

Parameter				Choices/Defaults	Comments
firewall_address dictionary				Default: null	Configure IPv4 addresses.
	allow_routing string			enable disable	Enable/disable use of this address in the static route configuration.
	associated_interface string				Network interface associated with address. Source system.interface.name system.zone.name.
	cache_ttl integer				Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
	color integer				Color of icon on the GUI.
	comment string				Comment.
	country string				IP addresses associated to a specific country.
	end_ip string				Final IP address (inclusive) in the range for the address.
	epg_name string				Endpoint group name.
	filter string				Match criteria filter.
	fqdn string				Fully Qualified Domain Name address.
	list list				IP address list.
		ip string / required			IP.
	name string / required				Address name.
	obj_id string				Object ID for NSX.
	organization string				Organization domain name (Syntax: organization/domain).
	policy_group string				Policy group name.
	sdn string			aci aws azure gcp nsx nuage oci openstack	SDN.
	sdn_tag string				SDN Tag.
	start_ip string				First IP address (inclusive) in the range for the address.
	state string			present absent	Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
	subnet string				IP address and subnet mask of address.
	subnet_name string				Subnet name.
	tagging list				Config object tagging.
		category string			Tag category. Source system.object-tagging.category.
		name string / required			Tagging entry name.
		tags list			Tags.
			name string / required		Tag name. Source system.object-tagging.tags.name.
	tenant string				Tenant.
	type string			ipmask iprange fqdn geography wildcard wildcard-fqdn dynamic	Type of address.
	uuid string				Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
	visibility string			enable disable	Enable/disable address visibility in the GUI.
	wildcard string				IP address and wildcard netmask.
	wildcard_fqdn string				Fully Qualified Domain Name with wildcard characters.
host string					FortiOS or FortiGate IP address.
https boolean				no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol.
password string				Default: ""	FortiOS or FortiGate password.
ssl_verify boolean added in 2.9				no yes ←	Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9				present absent	Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
username string					FortiOS or FortiGate username.
vdom string				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.

Notes

Note

Requires fortiosapi library developed by Fortinet
Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure IPv4 addresses.
    fortios_firewall_address:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      firewall_address:
        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>"

Return Values

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: id
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

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_firewall_address_module.html