fmgd_firewall_address – Configure IPv4 addresses.

Added in version 1.1.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • firewall_address - Configure IPv4 addresses. type: dict
    • _image_base64 (Alias name: _image-base64) Image base64. type: str more...
    • allow_routing (Alias name: allow-routing) Enable/disable use of this address in the static route configuration. type: str choices: [disable, enable] more...
    • associated_interface (Alias name: associated-interface) Network interface associated with address. type: list more...
    • cache_ttl (Alias name: cache-ttl) Defines the minimal ttl of individual ip addresses in fqdn cache measured in seconds. type: int more...
    • clearpass_spt (Alias name: clearpass-spt) Spt (system posture token) value. type: str choices: [unknown, healthy, quarantine, checkup, infected, transient, transition] more...
    • color Color of icon on the gui. type: int more...
    • comment Comment. type: str more...
    • country Ip addresses associated to a specific country. type: list more...
    • dirty To be deleted address. type: str choices: [dirty, clean] more...
    • dynamic_mapping Dynamic mapping. type: list more...
      • _image_base64 (Alias name: _image-base64) Image base64. type: str more...
      • _scope Scope. type: list more...
        • name Name. type: str more...
        • vdom Vdom. type: str more...
      • allow_routing (Alias name: allow-routing) Enable/disable use of this address in the static route configuration. type: str choices: [disable, enable] more...
      • associated_interface (Alias name: associated-interface) Network interface associated with address. type: str more...
      • cache_ttl (Alias name: cache-ttl) Defines the minimal ttl of individual ip addresses in fqdn cache measured in seconds. type: int more...
      • clearpass_spt (Alias name: clearpass-spt) Spt (system posture token) value. type: str choices: [unknown, healthy, quarantine, checkup, infected, transient, transition] more...
      • color Color of icon on the gui. type: int more...
      • comment Comment. type: str more...
      • country Ip addresses associated to a specific country. type: list more...
      • dirty To be deleted address. type: str choices: [dirty, clean] more...
      • end_ip (Alias name: end-ip) Support meta variable type: str more...
      • end_mac (Alias name: end-mac) Support meta variable type: str more...
      • epg_name (Alias name: epg-name) Endpoint group name. type: str more...
      • fabric_object (Alias name: fabric-object) Security fabric global object setting. type: str choices: [disable, enable] more...
      • filter Match criteria filter. type: str more...
      • fqdn Support meta variable type: str more...
      • fsso_group (Alias name: fsso-group) Fsso group(s). type: list more...
      • global_object (Alias name: global-object) Global object. type: int more...
      • hw_model (Alias name: hw-model) Dynamic address matching hardware model. type: str more...
      • hw_vendor (Alias name: hw-vendor) Dynamic address matching hardware vendor. type: str more...
      • interface Name of interface whose ip address is to be used. type: str more...
      • macaddr Support meta variable type: list more...
      • node_ip_only (Alias name: node-ip-only) Enable/disable collection of node addresses only in kubernetes. type: str choices: [disable, enable] more...
      • obj_id (Alias name: obj-id) Object id for nsx. type: str more...
      • obj_tag (Alias name: obj-tag) Tag of dynamic address object. type: str more...
      • obj_type (Alias name: obj-type) Object type. type: str choices: [ip, mac] more...
      • organization Organization domain name (syntax: organization/domain). type: str more...
      • os Dynamic address matching operating system. type: str more...
      • pattern_end (Alias name: pattern-end) Ending number of pattern for fqdn-group. type: int more...
      • pattern_start (Alias name: pattern-start) Starting number of pattern for fqdn-group. type: int more...
      • policy_group (Alias name: policy-group) Policy group name. type: str more...
      • route_tag (Alias name: route-tag) Route-tag address. type: int more...
      • sdn Sdn. type: list more...
      • sdn_addr_type (Alias name: sdn-addr-type) Type of addresses to collect. type: str choices: [private, public, all] more...
      • sdn_tag (Alias name: sdn-tag) Sdn tag. type: str more...
      • start_ip (Alias name: start-ip) Support meta variable type: str more...
      • start_mac (Alias name: start-mac) Support meta variable type: str more...
      • sub_type (Alias name: sub-type) Sub-type of address. type: str choices: [sdn, clearpass-spt, fsso, ems-tag, swc-tag, fortivoice-tag, fortinac-tag, fortipolicy-tag, device-identification, external-resource, rsso, obsolete, telemetry] more...
      • subnet Support meta variable type: list more...
      • subnet_name (Alias name: subnet-name) Subnet name. type: str more...
      • sw_version (Alias name: sw-version) Dynamic address matching software version. type: str more...
      • tag_detection_level (Alias name: tag-detection-level) Tag detection level of dynamic address object. type: str more...
      • tag_type (Alias name: tag-type) Tag type of dynamic address object. type: str more...
      • tags Names of object-tags applied to address. type: list more...
      • tenant Tenant. type: str more...
      • type Type of address. type: str choices: [ipmask, iprange, fqdn, wildcard, geography, dynamic, interface-subnet, fqdn-group, route-tag, mac, wildcard-fqdn] more...
      • url Url. type: str more...
      • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
      • visibility Enable/disable address visibility in the gui. type: str choices: [disable, enable] more...
      • wildcard Support meta variable type: list more...
      • wildcard_fqdn (Alias name: wildcard-fqdn) Support meta variable type: str more...
      • agent_id (Alias name: agent-id) Telemetry agent id. type: list more...
      • sso_attribute_value (Alias name: sso-attribute-value) Radius attributes value. type: list more...
      • tag_uuid (Alias name: tag-uuid) Foreign uuid of dynamic address object. type: str more...
      • passive_fqdn_learning (Alias name: passive-fqdn-learning) Enable/disable passive learning of fqdns. type: str choices: [disable, enable] more...
    • end_ip (Alias name: end-ip) Support meta variable type: str more...
    • epg_name (Alias name: epg-name) Endpoint group name. type: str more...
    • fabric_object (Alias name: fabric-object) Security fabric global object setting. type: str choices: [disable, enable] more...
    • filter Match criteria filter. type: str more...
    • fqdn Support meta variable type: str more...
    • fsso_group (Alias name: fsso-group) Fsso group(s). type: list more...
    • interface Name of interface whose ip address is to be used. type: list more...
    • list List. type: list more...
      • ip Ip. type: str more...
      • net_id (Alias name: net-id) Network id. type: str more...
      • obj_id (Alias name: obj-id) Object id. type: str more...
    • name Address name. type: str more...
    • node_ip_only (Alias name: node-ip-only) Enable/disable collection of node addresses only in kubernetes. type: str choices: [disable, enable] more...
    • obj_id (Alias name: obj-id) Object id for nsx. type: str more...
    • obj_tag (Alias name: obj-tag) Tag of dynamic address object. type: str more...
    • obj_type (Alias name: obj-type) Object type. type: str choices: [ip, mac] more...
    • organization Organization domain name (syntax: organization/domain). type: str more...
    • pattern_end (Alias name: pattern-end) Ending number of pattern for fqdn-group. type: int more...
    • pattern_start (Alias name: pattern-start) Starting number of pattern for fqdn-group. type: int more...
    • policy_group (Alias name: policy-group) Policy group name. type: str more...
    • sdn Sdn. type: list more...
    • sdn_addr_type (Alias name: sdn-addr-type) Type of addresses to collect. type: str choices: [private, public, all] more...
    • sdn_tag (Alias name: sdn-tag) Sdn tag. type: str more...
    • start_ip (Alias name: start-ip) Support meta variable type: str more...
    • sub_type (Alias name: sub-type) Sub-type of address. type: str choices: [sdn, clearpass-spt, fsso, ems-tag, swc-tag, fortivoice-tag, fortinac-tag, fortipolicy-tag, device-identification, external-resource, rsso, obsolete, telemetry] more...
    • subnet Support meta variable type: list more...
    • subnet_name (Alias name: subnet-name) Subnet name. type: str more...
    • tag_detection_level (Alias name: tag-detection-level) Tag detection level of dynamic address object. type: str more...
    • tag_type (Alias name: tag-type) Tag type of dynamic address object. type: str more...
    • tagging Tagging. type: list more...
      • category Tag category. type: list more...
      • name Tagging entry name. type: str more...
      • tags Tags. type: list more...
    • tenant Tenant. type: str more...
    • type Type of address. type: str choices: [ipmask, iprange, fqdn, wildcard, geography, dynamic, interface-subnet, fqdn-group, route-tag, mac, wildcard-fqdn] more...
    • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
    • wildcard Support meta variable type: list more...
    • wildcard_fqdn (Alias name: wildcard-fqdn) Support meta variable type: str more...
    • hw_model (Alias name: hw-model) Dynamic address matching hardware model. type: str more...
    • route_tag (Alias name: route-tag) Route-tag address. type: int more...
    • sw_version (Alias name: sw-version) Dynamic address matching software version. type: str more...
    • macaddr Support meta variable type: list more...
    • hw_vendor (Alias name: hw-vendor) Dynamic address matching hardware vendor. type: str more...
    • os Dynamic address matching operating system. type: str more...
    • global_object (Alias name: global-object) Global object. type: int more...
    • start_mac (Alias name: start-mac) Support meta variable type: str more...
    • end_mac (Alias name: end-mac) Support meta variable type: str more...
    • visibility Enable/disable address visibility in the gui. type: str choices: [disable, enable] more...
    • tags Names of object-tags applied to address. type: list more...
    • tag_uuid (Alias name: tag-uuid) Foreign uuid of dynamic address object. type: str more...
    • sso_attribute_value (Alias name: sso-attribute-value) Radius attributes value. type: list more...
    • agent_id (Alias name: agent-id) Telemetry agent id. type: list more...
    • passive_fqdn_learning (Alias name: passive-fqdn-learning) Enable/disable passive learning of fqdns. type: str choices: [disable, enable] more...

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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 addresses.
      fortinet.fmgdevice.fmgd_firewall_address:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        firewall_address:
          name: "your value" # Required variable, string
          # _image_base64: <string>
          # allow_routing: <value in [disable, enable]>
          # associated_interface: <list or string>
          # cache_ttl: <integer>
          # clearpass_spt: <value in [unknown, healthy, quarantine, ...]>
          # color: <integer>
          # comment: <string>
          # country: <list or string>
          # dirty: <value in [dirty, clean]>
          # dynamic_mapping:
          #   - _image_base64: <string>
          #     _scope:
          #       - name: <string>
          #         vdom: <string>
          #     allow_routing: <value in [disable, enable]>
          #     associated_interface: <string>
          #     cache_ttl: <integer>
          #     clearpass_spt: <value in [unknown, healthy, quarantine, ...]>
          #     color: <integer>
          #     comment: <string>
          #     country: <list or string>
          #     dirty: <value in [dirty, clean]>
          #     end_ip: <string>
          #     end_mac: <string>
          #     epg_name: <string>
          #     fabric_object: <value in [disable, enable]>
          #     filter: <string>
          #     fqdn: <string>
          #     fsso_group: <list or string>
          #     global_object: <integer>
          #     hw_model: <string>
          #     hw_vendor: <string>
          #     interface: <string>
          #     macaddr: <list or string>
          #     node_ip_only: <value in [disable, enable]>
          #     obj_id: <string>
          #     obj_tag: <string>
          #     obj_type: <value in [ip, mac]>
          #     organization: <string>
          #     os: <string>
          #     pattern_end: <integer>
          #     pattern_start: <integer>
          #     policy_group: <string>
          #     route_tag: <integer>
          #     sdn: <list or string>
          #     sdn_addr_type: <value in [private, public, all]>
          #     sdn_tag: <string>
          #     start_ip: <string>
          #     start_mac: <string>
          #     sub_type: <value in [sdn, clearpass-spt, fsso, ...]>
          #     subnet: <list or string>
          #     subnet_name: <string>
          #     sw_version: <string>
          #     tag_detection_level: <string>
          #     tag_type: <string>
          #     tags: <list or string>
          #     tenant: <string>
          #     type: <value in [ipmask, iprange, fqdn, ...]>
          #     url: <string>
          #     uuid: <string>
          #     visibility: <value in [disable, enable]>
          #     wildcard: <list or string>
          #     wildcard_fqdn: <string>
          #     agent_id: <list or string>
          #     sso_attribute_value: <list or string>
          #     tag_uuid: <string>
          #     passive_fqdn_learning: <value in [disable, enable]>
          # end_ip: <string>
          # epg_name: <string>
          # fabric_object: <value in [disable, enable]>
          # filter: <string>
          # fqdn: <string>
          # fsso_group: <list or string>
          # interface: <list or string>
          # list:
          #   - ip: <string>
          #     net_id: <string>
          #     obj_id: <string>
          # node_ip_only: <value in [disable, enable]>
          # obj_id: <string>
          # obj_tag: <string>
          # obj_type: <value in [ip, mac]>
          # organization: <string>
          # pattern_end: <integer>
          # pattern_start: <integer>
          # policy_group: <string>
          # sdn: <list or string>
          # sdn_addr_type: <value in [private, public, all]>
          # sdn_tag: <string>
          # start_ip: <string>
          # sub_type: <value in [sdn, clearpass-spt, fsso, ...]>
          # subnet: <list or string>
          # subnet_name: <string>
          # tag_detection_level: <string>
          # tag_type: <string>
          # tagging:
          #   - category: <list or string>
          #     name: <string>
          #     tags: <list or string>
          # tenant: <string>
          # type: <value in [ipmask, iprange, fqdn, ...]>
          # uuid: <string>
          # wildcard: <list or string>
          # wildcard_fqdn: <string>
          # hw_model: <string>
          # route_tag: <integer>
          # sw_version: <string>
          # macaddr: <list or string>
          # hw_vendor: <string>
          # os: <string>
          # global_object: <integer>
          # start_mac: <string>
          # end_mac: <string>
          # visibility: <value in [disable, enable]>
          # tags: <list or string>
          # tag_uuid: <string>
          # sso_attribute_value: <list or string>
          # agent_id: <list or string>
          # passive_fqdn_learning: <value in [disable, enable]>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)