W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_firewall_address – Configure IPv4 addresses.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_address.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter				Choices/Defaults	Comments
adom string / required					the parameter (adom) in requested url
bypass_validation boolean				Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean				Choices: no ← yes	Enable/Disable logging for task
firewall_address dictionary					the top level parameters set
	_image-base64 string				no description
	allow-routing string			Choices: disable enable	Enable/disable use of this address in the static route configuration.
	associated-interface string				Network interface associated with address.
	cache-ttl integer				Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
	clearpass-spt string			Choices: unknown healthy quarantine checkup transition infected transient	SPT (System Posture Token) value.
	color integer				Color of icon on the GUI.
	comment string				no description
	country string				IP addresses associated to a specific country.
	dynamic_mapping list / elements=string				no description
		_image-base64 string			no description
		_scope list / elements=string			no description
			name string		no description
			vdom string		no description
		allow-routing string		Choices: disable enable	no description
		associated-interface string			no description
		cache-ttl integer			no description
		clearpass-spt string		Choices: unknown healthy quarantine checkup transition infected transient	no description
		color integer			no description
		comment string			no description
		country string			no description
		end-ip string			no description
		end-mac string			no description
		epg-name string			no description
		fabric-object string		Choices: disable enable	Security Fabric global object setting.
		filter string			no description
		fqdn string			no description
		fsso-group string			no description
		global-object integer			no description
		interface string			no description
		macaddr string			no description
		node-ip-only string		Choices: disable enable	Enable/disable collection of node addresses only in Kubernetes.
		obj-id string			no description
		obj-tag string			no description
		obj-type string		Choices: ip mac	no description
		organization string			no description
		policy-group string			no description
		sdn string		Choices: aci aws nsx nuage azure gcp oci openstack	no description
		sdn-addr-type string		Choices: private public all	no description
		sdn-tag string			no description
		start-ip string			no description
		start-mac string			no description
		sub-type string		Choices: sdn clearpass-spt fsso ems-tag	no description
		subnet string			no description
		subnet-name string			no description
		tags string			no description
		tenant string			no description
		type string		Choices: ipmask iprange fqdn wildcard geography wildcard-fqdn dynamic	no description
		url string			no description
		uuid string			no description
		visibility string		Choices: disable enable	no description
		wildcard string			no description
		wildcard-fqdn string			no description
	end-ip string				Final IP address (inclusive) in the range for the address.
	end-mac string				Last MAC address in the range.
	epg-name string				Endpoint group name.
	fabric-object string			Choices: disable enable	Security Fabric global object setting.
	filter string				Match criteria filter.
	fqdn string				Fully Qualified Domain Name address.
	fsso-group string				FSSO group(s).
	global-object integer				Global Object.
	interface string				Name of interface whose IP address is to be used.
	list list / elements=string				no description
		ip string			IP.
		net-id string			Network ID.
		obj-id string			Object ID.
	macaddr string				no description
	name string				Address name.
	node-ip-only string			Choices: disable enable	Enable/disable collection of node addresses only in Kubernetes.
	obj-id string				Object ID for NSX.
	obj-tag string				Tag of dynamic address object.
	obj-type string			Choices: ip mac	Object type.
	organization string				Organization domain name (Syntax: organization/domain).
	policy-group string				Policy group name.
	sdn string			Choices: aci aws nsx nuage azure gcp oci openstack	SDN.
	sdn-addr-type string			Choices: private public all	Type of addresses to collect.
	sdn-tag string				SDN Tag.
	start-ip string				First IP address (inclusive) in the range for the address.
	start-mac string				First MAC address in the range.
	sub-type string			Choices: sdn clearpass-spt fsso ems-tag	Sub-type of address.
	subnet string				IP address and subnet mask of address.
	subnet-name string				Subnet name.
	tagging list / elements=string				no description
		category string			Tag category.
		name string			Tagging entry name.
		tags string			no description
	tenant string				Tenant.
	type string			Choices: ipmask iprange fqdn wildcard geography wildcard-fqdn dynamic	Type of address.
	uuid string				Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
	visibility string			Choices: disable enable	Enable/disable address visibility in the GUI.
	wildcard string				IP address and wildcard netmask.
	wildcard-fqdn string				Fully Qualified Domain Name with wildcard characters.
proposed_method string				Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string					the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string					the rc codes list with which the conditions to succeed will be overriden
state string / required				Choices: present absent	the directive to create, update or delete an object
workspace_locking_adom string					the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer				Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 addresses.
     fmgr_firewall_address:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_address:
           allow-routing: <value in [disable, enable]>
           associated-interface: <value of string>
           cache-ttl: <value of integer>
           color: <value of integer>
           comment: <value of string>
           country: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 allow-routing: <value in [disable, enable]>
                 associated-interface: <value of string>
                 cache-ttl: <value of integer>
                 color: <value of integer>
                 comment: <value of string>
                 country: <value of string>
                 end-ip: <value of string>
                 end-mac: <value of string>
                 epg-name: <value of string>
                 filter: <value of string>
                 fqdn: <value of string>
                 interface: <value of string>
                 obj-id: <value of string>
                 organization: <value of string>
                 policy-group: <value of string>
                 sdn: <value in [aci, aws, nsx, ...]>
                 sdn-addr-type: <value in [private, public, all]>
                 sdn-tag: <value of string>
                 start-ip: <value of string>
                 start-mac: <value of string>
                 subnet: <value of string>
                 subnet-name: <value of string>
                 tags: <value of string>
                 tenant: <value of string>
                 type: <value in [ipmask, iprange, fqdn, ...]>
                 url: <value of string>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
                 wildcard: <value of string>
                 wildcard-fqdn: <value of string>
                 _image-base64: <value of string>
                 clearpass-spt: <value in [unknown, healthy, quarantine, ...]>
                 fsso-group: <value of string>
                 sub-type: <value in [sdn, clearpass-spt, fsso, ...]>
                 global-object: <value of integer>
                 obj-tag: <value of string>
                 obj-type: <value in [ip, mac]>
                 fabric-object: <value in [disable, enable]>
                 macaddr: <value of string>
                 node-ip-only: <value in [disable, enable]>
           end-ip: <value of string>
           epg-name: <value of string>
           filter: <value of string>
           fqdn: <value of string>
           list:
             -
                 ip: <value of string>
                 net-id: <value of string>
                 obj-id: <value of string>
           name: <value of string>
           obj-id: <value of string>
           organization: <value of string>
           policy-group: <value of string>
           sdn: <value in [aci, aws, nsx, ...]>
           sdn-tag: <value of string>
           start-ip: <value of string>
           subnet: <value of string>
           subnet-name: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           tenant: <value of string>
           type: <value in [ipmask, iprange, fqdn, ...]>
           uuid: <value of string>
           visibility: <value in [disable, enable]>
           wildcard: <value of string>
           wildcard-fqdn: <value of string>
           end-mac: <value of string>
           interface: <value of string>
           sdn-addr-type: <value in [private, public, all]>
           start-mac: <value of string>
           _image-base64: <value of string>
           clearpass-spt: <value in [unknown, healthy, quarantine, ...]>
           fsso-group: <value of string>
           sub-type: <value in [sdn, clearpass-spt, fsso, ...]>
           global-object: <value of integer>
           obj-tag: <value of string>
           obj-type: <value in [ip, mac]>
           fabric-object: <value in [disable, enable]>
           macaddr: <value of string>
           node-ip-only: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_address_module.html