fortinet.fortimanager.fmgr_firewall_address module – Configure IPv4 addresses.

Note

This module is part of the fortinet.fortimanager collection (version 2.3.0).

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 fortinet.fortimanager 1.0.0

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_address

dictionary

the top level parameters set

_image-base64

string

_Image-Base64.

allow-routing

string

Enable/disable use of this address in the static route configuration.

Choices:

  • "disable"

  • "enable"

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

SPT

Choices:

  • "unknown"

  • "healthy"

  • "quarantine"

  • "checkup"

  • "transition"

  • "infected"

  • "transient"

color

integer

Color of icon on the GUI.

comment

any

(dict or str) no description

country

string

IP addresses associated to a specific country.

dirty

string

To be deleted address.

Choices:

  • "dirty"

  • "clean"

dynamic_mapping

list / elements=dictionary

Dynamic_Mapping.

_image-base64

string

_Image-Base64.

_scope

list / elements=dictionary

_Scope.

name

string

Name.

vdom

string

Vdom.

allow-routing

string

Enable/disable use of this address in the static route configuration.

Choices:

  • "disable"

  • "enable"

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

SPT

Choices:

  • "unknown"

  • "healthy"

  • "quarantine"

  • "checkup"

  • "transition"

  • "infected"

  • "transient"

color

integer

Color of icon on the GUI.

comment

any

(dict or str) no description

country

string

IP addresses associated to a specific country.

dirty

string

To be deleted address.

Choices:

  • "dirty"

  • "clean"

end-ip

string

Final IP address

end-mac

string

Last MAC address in the range.

epg-name

string

Endpoint group name.

fabric-object

string

Security Fabric global object setting.

Choices:

  • "disable"

  • "enable"

filter

string

Match criteria filter.

fqdn

string

Fully Qualified Domain Name address.

fsso-group

any

(list or str) FSSO group

global-object

integer

Global-Object.

hw-model

string

Dynamic address matching hardware model.

hw-vendor

string

Dynamic address matching hardware vendor.

interface

string

Name of interface whose IP address is to be used.

macaddr

any

(list) Macaddr.

node-ip-only

string

Enable/disable collection of node addresses only in Kubernetes.

Choices:

  • "disable"

  • "enable"

obj-id

string

Object ID for NSX.

obj-tag

string

Obj-Tag.

obj-type

string

Obj-Type.

Choices:

  • "ip"

  • "mac"

organization

string

Organization domain name

os

string

Dynamic address matching operating system.

pattern-end

integer

no description

pattern-start

integer

no description

policy-group

string

Policy group name.

route-tag

integer

route-tag address.

sdn

string

SDN.

Choices:

  • "aci"

  • "aws"

  • "nsx"

  • "nuage"

  • "azure"

  • "gcp"

  • "oci"

  • "openstack"

sdn-addr-type

string

Type of addresses to collect.

Choices:

  • "private"

  • "public"

  • "all"

sdn-tag

string

SDN Tag.

start-ip

string

First IP address

start-mac

string

First MAC address in the range.

sub-type

string

Sub-type of address.

Choices:

  • "sdn"

  • "clearpass-spt"

  • "fsso"

  • "ems-tag"

  • "swc-tag"

  • "fortivoice-tag"

  • "fortinac-tag"

  • "fortipolicy-tag"

  • "device-identification"

subnet

string

IP address and subnet mask of address.

subnet-name

string

Subnet name.

sw-version

string

Dynamic address matching software version.

tag-detection-level

string

Tag detection level of dynamic address object.

tag-type

string

Tag type of dynamic address object.

tags

any

(list or str) Tags.

tenant

string

Tenant.

type

string

Type of address.

Choices:

  • "ipmask"

  • "iprange"

  • "fqdn"

  • "wildcard"

  • "geography"

  • "url"

  • "wildcard-fqdn"

  • "nsx"

  • "aws"

  • "dynamic"

  • "interface-subnet"

  • "mac"

  • "fqdn-group"

  • "route-tag"

url

string

Url.

uuid

string

Universally Unique Identifier

visibility

string

Enable/disable address visibility in the GUI.

Choices:

  • "disable"

  • "enable"

wildcard

string

IP address and wildcard netmask.

wildcard-fqdn

string

Fully Qualified Domain Name with wildcard characters.

end-ip

string

Final IP address

end-mac

string

Last MAC address in the range.

epg-name

string

Endpoint group name.

fabric-object

string

Security Fabric global object setting.

Choices:

  • "disable"

  • "enable"

filter

string

Match criteria filter.

fqdn

string

Fully Qualified Domain Name address.

fsso-group

any

(list or str) FSSO group

global-object

integer

Global Object.

hw-model

string

Dynamic address matching hardware model.

hw-vendor

string

Dynamic address matching hardware vendor.

interface

string

Name of interface whose IP address is to be used.

list

list / elements=dictionary

List.

ip

string

IP.

net-id

string

Network ID.

obj-id

string

Object ID.

macaddr

any

(list) Multiple MAC address ranges.

name

string / required

Address name.

node-ip-only

string

Enable/disable collection of node addresses only in Kubernetes.

Choices:

  • "disable"

  • "enable"

obj-id

string

Object ID for NSX.

obj-tag

string

Tag of dynamic address object.

obj-type

string

Object type.

Choices:

  • "ip"

  • "mac"

organization

string

Organization domain name

os

string

Dynamic address matching operating system.

policy-group

string

Policy group name.

profile-list

list / elements=dictionary

no description

profile-id

integer

NSX service profile ID.

route-tag

integer

route-tag address.

sdn

string

SDN.

Choices:

  • "aci"

  • "aws"

  • "nsx"

  • "nuage"

  • "azure"

  • "gcp"

  • "oci"

  • "openstack"

sdn-addr-type

string

Type of addresses to collect.

Choices:

  • "private"

  • "public"

  • "all"

sdn-tag

string

SDN Tag.

start-ip

string

First IP address

start-mac

string

First MAC address in the range.

sub-type

string

Sub-type of address.

Choices:

  • "sdn"

  • "clearpass-spt"

  • "fsso"

  • "ems-tag"

  • "swc-tag"

  • "fortivoice-tag"

  • "fortinac-tag"

  • "fortipolicy-tag"

  • "device-identification"

subnet

string

IP address and subnet mask of address.

subnet-name

string

Subnet name.

sw-version

string

Dynamic address matching software version.

tag-detection-level

string

Tag detection level of dynamic address object.

tag-type

string

Tag type of dynamic address object.

tagging

list / elements=dictionary

Tagging.

category

string

Tag category.

name

string

Tagging entry name.

tags

any

(list) Tags.

tags

string

Names of object-tags applied to address.

tenant

string

Tenant.

type

string

Type of address.

Choices:

  • "ipmask"

  • "iprange"

  • "fqdn"

  • "wildcard"

  • "geography"

  • "url"

  • "wildcard-fqdn"

  • "nsx"

  • "aws"

  • "dynamic"

  • "interface-subnet"

  • "mac"

  • "fqdn-group"

  • "route-tag"

uuid

string

Universally Unique Identifier

visibility

string

Enable/disable address visibility in the GUI.

Choices:

  • "disable"

  • "enable"

wildcard

string

IP address and wildcard netmask.

wildcard-fqdn

string

Fully Qualified Domain Name with wildcard characters.

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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: fortimanager00
  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
        adom: root
        state: present
        firewall_address:
           allow-routing: disable
           associated-interface: any
           name: 'address-orignal'
           visibility: enable
   - name: rename the firewall addressobject
     fmgr_rename:
        rename:
            selector: 'firewall_address'
            self:
             adom: 'root'
             address: 'address-orignal'
            target:
             name: 'address-new'

   - name: delete renamed object
     fmgr_firewall_address:
        adom: 'root'
        state: absent
        firewall_address:
            name: 'address-new'


- hosts: fortimanager00
  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
        adom: ansible
        state: present
        firewall_address:
           allow-routing: disable
           associated-interface: any
           name: 'ansible-test1'
           visibility: disable

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: create IPv4 addresses.
     fmgr_firewall_address:
        adom: root
        state: present
        firewall_address:
           allow-routing: disable
           associated-interface: any
           name: 'fooaddress'
           visibility: disable
     register: info
     failed_when: info.rc != 0
   - name: create IPv4 addresses.
     fmgr_firewall_address:
        adom: root
        state: present
        firewall_address:
           allow-routing: disable
           associated-interface: any
           name: 'fooaddress'
           visibility: disable
     register: info
     failed_when: info.message != 'Object update skipped!'
   - name: delete created address
     fmgr_firewall_address:
        adom: root
        state: absent
        firewall_address:
            name: 'fooaddress'

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv4 addresses
     fmgr_fact:
       facts:
           selector: 'firewall_address'
           params:
               adom: 'ansible'
               address: 'your_value'

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)