fortios_firewall_address6 – Configure IPv6 firewall addresses in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_address6 v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • firewall_address6 - Configure IPv6 firewall addresses. type: dict more...
    • cache_ttl - Minimal TTL of individual IPv6 addresses in FQDN cache. type: int more...
    • color - Integer value to determine the color of the icon in the GUI (range 1 to 32). type: int more...
    • comment - Comment. type: str more...
    • country - IPv6 addresses associated to a specific country. type: str more...
    • end_ip - Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...
    • end_mac - Last MAC address in the range. type: str more...
    • epg_name - Endpoint group name. type: str more...
    • fabric_object - Security Fabric global object setting. type: str choices: enable, disable more...
    • fqdn - Fully qualified domain name. type: str more...
    • host - Host Address. type: str more...
    • host_type - Host type. type: str choices: any, specific more...
    • ip6 - IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str more...
    • list - IP address list. type: list member_path: list:ip more...
      • ip - IP. type: str required: true more...
      • net_id - Network ID. type: str more...
      • obj_id - Object ID. type: str more...
    • macaddr - Multiple MAC address ranges. type: list member_path: macaddr:macaddr more...
      • macaddr - MAC address ranges [-] separated by space. type: str required: true more...
    • name - Address name. type: str required: true more...
    • obj_id - Object ID for NSX. type: str more...
    • route_tag - route-tag address. type: int more...
    • sdn - SDN. Source system.sdn-connector.name. type: str choices: nsx more...
    • sdn_tag - SDN Tag. type: str more...
    • start_ip - First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...
    • start_mac - First MAC address in the range. type: str more...
    • subnet_segment - IPv6 subnet segments. type: list member_path: subnet_segment:name more...
      • name - Name. type: str required: true more...
      • type - Subnet segment type. type: str choices: any, specific more...
      • value - Subnet segment value. type: str more...
    • tagging - Config object tagging. type: list member_path: tagging:name more...
      • category - Tag category. Source system.object-tagging.category. type: str more...
      • name - Tagging entry name. type: str required: true more...
      • tags - Tags. type: list member_path: tagging:name/tags:name more...
        • name - Tag name. Source system.object-tagging.tags.name. type: str required: true more...
    • template - IPv6 address template. Source firewall.address6-template.name. type: str more...
    • tenant - Tenant. type: str more...
    • type - Type of IPv6 address object . type: str choices: ipprefix, iprange, fqdn, geography, dynamic, template, mac, route-tag more...
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
    • visibility - Enable/disable the visibility of the object in the GUI. type: str choices: enable, disable more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure IPv6 firewall addresses.
  fortinet.fortios.fortios_firewall_address6:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_address6:
          cache_ttl: "0"
          color: "0"
          comment: "Comment."
          country: "<your_own_value>"
          end_ip: "<your_own_value>"
          end_mac: "<your_own_value>"
          epg_name: "<your_own_value>"
          fabric_object: "enable"
          fqdn: "<your_own_value>"
          host: "myhostname"
          host_type: "any"
          ip6: "<your_own_value>"
          list:
              -
                  ip: "<your_own_value>"
                  net_id: "<your_own_value>"
                  obj_id: "<your_own_value>"
          macaddr:
              -
                  macaddr: "<your_own_value>"
          name: "default_name_21"
          obj_id: "<your_own_value>"
          route_tag: "0"
          sdn: "nsx"
          sdn_tag: "<your_own_value>"
          start_ip: "<your_own_value>"
          start_mac: "<your_own_value>"
          subnet_segment:
              -
                  name: "default_name_29"
                  type: "any"
                  value: "<your_own_value>"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_34"
                  tags:
                      -
                          name: "default_name_36 (source system.object-tagging.tags.name)"
          template: "<your_own_value> (source firewall.address6-template.name)"
          tenant: "<your_own_value>"
          type: "ipprefix"
          uuid: "<your_own_value>"
          visibility: "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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

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

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.