fortios_firewall_address6.rst

source:	fortios_firewall_address6.py
orphan:

fortios_firewall_address6 -- Configure IPv6 firewall addresses in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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...

  	Supported Version Ranges
  firewall_address6	v6.0.0 -> latest

• cache_ttl - Minimal TTL of individual IPv6 addresses in FQDN cache. type: int more...

  	Supported Version Ranges
  cache_ttl	v6.0.0 -> latest

• color - Integer value to determine the color of the icon in the GUI (range 1 to 32). type: int more...

  	Supported Version Ranges
  color	v6.0.0 -> latest

• comment - Comment. type: str more...

  	Supported Version Ranges
  comment	v6.0.0 -> latest

• country - IPv6 addresses associated to a specific country. type: str more...

  	Supported Version Ranges
  country	v6.4.0 -> latest

• end_ip - Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...

  	Supported Version Ranges
  end_ip	v6.0.0 -> latest

• end_mac - Last MAC address in the range. type: str more...

  	Supported Version Ranges
  end_mac	v6.2.0 -> v6.2.0	v6.2.5 -> v6.4.0	v6.4.4 -> v6.4.4

• epg_name - Endpoint group name. type: str more...

  	Supported Version Ranges
  epg_name	v7.2.1 -> latest

• fabric_object - Security Fabric global object setting. type: str choices: enable, disable more...

  	Supported Version Ranges
  fabric_object	v6.4.4 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• fqdn - Fully qualified domain name. type: str more...

  	Supported Version Ranges
  fqdn	v6.0.0 -> latest

• host - Host Address. type: str more...

  	Supported Version Ranges
  host	v6.0.0 -> latest

• host_type - Host type. type: str choices: any, specific more...

  	Supported Version Ranges
  host_type	v6.0.0 -> latest
  [any]	v6.0.0 -> latest
  [specific]	v6.0.0 -> latest

• ip6 - IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str more...

  	Supported Version Ranges
  ip6	v6.0.0 -> latest

• list - IP address list. type: list member_path: list:ip more...

  	Supported Version Ranges
  list	v6.0.0 -> latest

• ip - IP. type: str required: true more...

  	Supported Version Ranges
  ip	v6.0.0 -> latest

• net_id - Network ID. type: str more...

  	Supported Version Ranges
  net_id	v6.2.3 -> v6.2.3

• obj_id - Object ID. type: str more...

  	Supported Version Ranges
  obj_id	v6.2.3 -> v6.2.3

• macaddr - Multiple MAC address ranges. type: list member_path: macaddr:macaddr more...

  	Supported Version Ranges
  macaddr	v7.0.0 -> latest

• macaddr - MAC address ranges [-] separated by space. type: str required: true more...

  	Supported Version Ranges
  macaddr	v7.0.0 -> latest

• name - Address name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• obj_id - Object ID for NSX. type: str more...

  	Supported Version Ranges
  obj_id	v6.0.0 -> latest

• route_tag - route-tag address. type: int more...

  	Supported Version Ranges
  route_tag	v7.4.0 -> latest

• sdn - SDN. Source system.sdn-connector.name. type: str choices: nsx more...

  	Supported Version Ranges
  sdn	v6.0.0 -> latest
  [nsx]	v6.0.0 -> v6.0.11

• sdn_tag - SDN Tag. type: str more...

  	Supported Version Ranges
  sdn_tag	v7.2.1 -> latest

• start_ip - First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...

  	Supported Version Ranges
  start_ip	v6.0.0 -> latest

• start_mac - First MAC address in the range. type: str more...

  	Supported Version Ranges
  start_mac	v6.2.0 -> v6.2.0	v6.2.5 -> v6.4.0	v6.4.4 -> v6.4.4

• subnet_segment - IPv6 subnet segments. type: list member_path: subnet_segment:name more...

  	Supported Version Ranges
  subnet_segment	v6.0.0 -> latest

• name - Name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• type - Subnet segment type. type: str choices: any, specific more...

  	Supported Version Ranges
  type	v6.0.0 -> latest
  [any]	v6.0.0 -> latest
  [specific]	v6.0.0 -> latest

• value - Subnet segment value. type: str more...

  	Supported Version Ranges
  value	v6.0.0 -> latest

• tagging - Config object tagging. type: list member_path: tagging:name more...

  	Supported Version Ranges
  tagging	v6.0.0 -> latest

• category - Tag category. Source system.object-tagging.category. type: str more...

  	Supported Version Ranges
  category	v6.0.0 -> latest

• name - Tagging entry name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• tags - Tags. type: list member_path: tagging:name/tags:name more...

  	Supported Version Ranges
  tags	v6.0.0 -> latest

• name - Tag name. Source system.object-tagging.tags.name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• template - IPv6 address template. Source firewall.address6-template.name. type: str more...

  	Supported Version Ranges
  template	v6.0.0 -> latest

• tenant - Tenant. type: str more...

  	Supported Version Ranges
  tenant	v7.2.1 -> latest

• type - Type of IPv6 address object . type: str choices: ipprefix, iprange, fqdn, geography, dynamic, template, mac, route-tag more...

  	Supported Version Ranges
  type	v6.0.0 -> latest
  [ipprefix]	v6.0.0 -> latest
  [iprange]	v6.0.0 -> latest
  [fqdn]	v6.0.0 -> latest
  [geography]	v6.4.0 -> latest
  [dynamic]	v6.0.0 -> latest
  [template]	v6.0.0 -> latest
  [mac]	v6.2.0 -> v6.2.0	v6.2.5 -> v6.4.0	v6.4.4 -> latest
  [route-tag]	v7.4.0 -> latest

• uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...

  	Supported Version Ranges
  uuid	v6.0.0 -> latest

• visibility - Enable/disable the visibility of the object in the GUI. type: str choices: enable, disable more...

  	Supported Version Ranges
  visibility	v6.0.0 -> v6.2.7
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

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.