fortinet.fortimanager.fmgr_firewall_addrgrp – Configure IPv4 address groups.

Note

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

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

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

New in version 2.10: of fortinet.fortimanager

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_addrgrp
dictionary
the top level parameters set
_image-base64
string
no description
allow-routing
string
    Choices:
  • disable
  • enable
Enable/disable use of this group in the static route configuration.
category
string
    Choices:
  • default
  • ztna-ems-tag
  • ztna-geo-tag
Address group category.
color
integer
Color of icon on the GUI.
comment
string
no description
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
category
string
    Choices:
  • default
  • ztna-ems-tag
  • ztna-geo-tag
Address group category.
color
integer
no description
comment
string
no description
exclude
string
    Choices:
  • disable
  • enable
no description
exclude-member
string
no description
fabric-object
string
    Choices:
  • disable
  • enable
Security Fabric global object setting.
global-object
integer
no description
member
list / elements=string
no description
tags
string
no description
type
string
    Choices:
  • default
  • array
  • folder
no description
uuid
string
no description
visibility
string
    Choices:
  • disable
  • enable
no description
exclude
string
    Choices:
  • disable
  • enable
Enable/disable address exclusion.
exclude-member
string
Address exclusion member.
fabric-object
string
    Choices:
  • disable
  • enable
Security Fabric global object setting.
global-object
integer
Global Object.
member
list / elements=string
no description
name
string
Address group name.
tagging
list / elements=string
no description
category
string
Tag category.
name
string
Tagging entry name.
tags
string
no description
type
string
    Choices:
  • default
  • array
  • folder
Address group type.
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.
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 address groups.
     fmgr_firewall_addrgrp:
        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_addrgrp:
           allow-routing: <value in [disable, enable]>
           color: <value of integer>
           comment: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 allow-routing: <value in [disable, enable]>
                 color: <value of integer>
                 comment: <value of string>
                 exclude: <value in [disable, enable]>
                 exclude-member: <value of string>
                 member: <value of list>
                 tags: <value of string>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
                 _image-base64: <value of string>
                 global-object: <value of integer>
                 type: <value in [default, array, folder]>
                 fabric-object: <value in [disable, enable]>
                 category: <value in [default, ztna-ems-tag, ztna-geo-tag]>
           member: <value of list>
           name: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           uuid: <value of string>
           visibility: <value in [disable, enable]>
           exclude: <value in [disable, enable]>
           exclude-member: <value of string>
           _image-base64: <value of string>
           global-object: <value of integer>
           type: <value in [default, array, folder]>
           fabric-object: <value in [disable, enable]>
           category: <value in [default, ztna-ems-tag, ztna-geo-tag]>

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)