fmgr_firewall_address – Configure IPv4 addresses.

Added in version 1.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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 v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> 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
  • adom - The parameter in requested url type: str required: true
  • firewall_address - Configure IPv4 addresses. type: dict
    • 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...
    • color Color of icon on the gui. type: int more...
    • comment type: dict or str
    • country Ip addresses associated to a specific country. type: str more...
    • dynamic_mapping Dynamic_mapping. type: list 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...
      • color Color of icon on the gui. type: int more...
      • comment type: dict or str
      • country Ip addresses associated to a specific country. type: str more...
      • end_ip (Alias name: end-ip) Final ip address (inclusive) in the range for the address. type: str more...
      • end_mac (Alias name: end-mac) Last mac address in the range. type: str more...
      • epg_name (Alias name: epg-name) Endpoint group name. type: str more...
      • filter Match criteria filter. type: str more...
      • fqdn Fully qualified domain name address. type: str more...
      • interface Name of interface whose ip address is to be used. type: str more...
      • obj_id (Alias name: obj-id) Object id for nsx. type: str more...
      • organization Organization domain name (syntax: organization/domain). type: str more...
      • policy_group (Alias name: policy-group) Policy group name. type: str more...
      • sdn Sdn. type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack] 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) First ip address (inclusive) in the range for the address. type: str more...
      • start_mac (Alias name: start-mac) First mac address in the range. type: str more...
      • subnet Ip address and subnet mask of address. type: str more...
      • subnet_name (Alias name: subnet-name) Subnet name. type: str more...
      • tags Tags. type: list or str more...
      • tenant Tenant. type: str more...
      • type Type of address. type: str choices: [ipmask, iprange, fqdn, wildcard, geography, url, wildcard-fqdn, nsx, aws, dynamic, interface-subnet, mac, fqdn-group, route-tag] 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 Ip address and wildcard netmask. type: str more...
      • wildcard_fqdn (Alias name: wildcard-fqdn) Fully qualified domain name with wildcard characters. type: str more...
      • _image_base64 (Alias name: _image-base64) _image-base64. type: str more...
      • clearpass_spt (Alias name: clearpass-spt) Spt (system posture token) value. type: str choices: [unknown, healthy, quarantine, checkup, transition, infected, transient] more...
      • fsso_group (Alias name: fsso-group) Fsso group(s). type: list or 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] more...
      • global_object (Alias name: global-object) Global-object. type: int more...
      • obj_tag (Alias name: obj-tag) Obj-tag. type: str more...
      • obj_type (Alias name: obj-type) Obj-type. type: str choices: [ip, mac] more...
      • fabric_object (Alias name: fabric-object) Security fabric global object setting. type: str choices: [disable, enable] more...
      • macaddr Macaddr. 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...
      • dirty To be deleted address. type: str choices: [dirty, clean] more...
      • pattern_end (Alias name: pattern-end) type: int more...
      • pattern_start (Alias name: pattern-start) type: int 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...
      • 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...
      • os Dynamic address matching operating system. 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...
    • end_ip (Alias name: end-ip) Final ip address (inclusive) in the range for the address. type: str more...
    • epg_name (Alias name: epg-name) Endpoint group name. type: str more...
    • filter Match criteria filter. type: str more...
    • fqdn Fully qualified domain name address. type: str 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...
    • obj_id (Alias name: obj-id) Object id for nsx. type: str more...
    • organization Organization domain name (syntax: organization/domain). type: str more...
    • policy_group (Alias name: policy-group) Policy group name. type: str more...
    • sdn Sdn. type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack] more...
    • sdn_tag (Alias name: sdn-tag) Sdn tag. type: str more...
    • start_ip (Alias name: start-ip) First ip address (inclusive) in the range for the address. type: str more...
    • subnet Ip address and subnet mask of address. type: str more...
    • subnet_name (Alias name: subnet-name) Subnet name. type: str more...
    • tagging Tagging. type: list more...
      • category Tag category. type: str 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, url, wildcard-fqdn, nsx, aws, dynamic, interface-subnet, mac, fqdn-group, route-tag] 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 Ip address and wildcard netmask. type: str more...
    • wildcard_fqdn (Alias name: wildcard-fqdn) Fully qualified domain name with wildcard characters. type: str more...
    • end_mac (Alias name: end-mac) Last mac address in the range. type: str more...
    • interface Name of interface whose ip address is to be used. type: str more...
    • sdn_addr_type (Alias name: sdn-addr-type) Type of addresses to collect. type: str choices: [private, public, all] more...
    • start_mac (Alias name: start-mac) First mac address in the range. type: str more...
    • tags Names of object-tags applied to address. type: str more...
    • profile_list (Alias name: profile-list) type: list more...
      • profile_id (Alias name: profile-id) Nsx service profile id. type: int more...
    • _image_base64 (Alias name: _image-base64) _image-base64. type: str more...
    • clearpass_spt (Alias name: clearpass-spt) Spt (system posture token) value. type: str choices: [unknown, healthy, quarantine, checkup, transition, infected, transient] more...
    • fsso_group (Alias name: fsso-group) Fsso group(s). type: list or 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] more...
    • global_object (Alias name: global-object) Global object. type: int 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...
    • fabric_object (Alias name: fabric-object) Security fabric global object setting. type: str choices: [disable, enable] more...
    • macaddr Multiple mac address ranges. 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...
    • dirty To be deleted address. type: str choices: [dirty, clean] 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...
    • 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...
    • os Dynamic address matching operating system. 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...

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "ansible-test1"
          visibility: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv4 addresses
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address"
          params:
            adom: "ansible"
            address: "your_value"

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 addresses.
      fortinet.fortimanager.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
      fortinet.fortimanager.fmgr_rename:
        rename:
          selector: "firewall_address"
          self:
            adom: "root"
            address: "address-orignal"
          target:
            name: "address-new"
    - name: Delete renamed object
      fortinet.fortimanager.fmgr_firewall_address:
        adom: "root"
        state: absent
        firewall_address:
          name: "address-new"

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Create IPv4 addresses.
      fortinet.fortimanager.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.
      fortinet.fortimanager.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
      fortinet.fortimanager.fmgr_firewall_address:
        adom: root
        state: absent
        firewall_address:
          name: "fooaddress"

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)