Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_firewall_address6_module.html

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

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_address6.

New in version 2.10: of fortinet.fortios

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

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
firewall_address6
dictionary
Configure IPv6 firewall addresses.
cache_ttl
integer
Minimal TTL of individual IPv6 addresses in FQDN cache.
color
integer
Integer value to determine the color of the icon in the GUI (range 1 to 32).
comment
string
Comment.
country
string
IPv6 addresses associated to a specific country.
end_ip
string
Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
end_mac
string
Last MAC address in the range.
fabric_object
string
    Choices:
  • enable
  • disable
Security Fabric global object setting.
fqdn
string
Fully qualified domain name.
host
string
Host Address.
host_type
string
    Choices:
  • any
  • specific
Host type.
ip6
string
IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx).
list
list / elements=string
IP address list.
ip
string / required
IP.
net_id
string
Network ID.
obj_id
string
Object ID.
macaddr
list / elements=string
Multiple MAC address ranges.
macaddr
string / required
MAC address ranges <start>[-<end>] separated by space.
name
string / required
Address name.
obj_id
string
Object ID for NSX.
sdn
string
    Choices:
  • nsx
SDN. Source system.sdn-connector.name.
start_ip
string
First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
start_mac
string
First MAC address in the range.
subnet_segment
list / elements=string
IPv6 subnet segments.
name
string / required
Name.
type
string
    Choices:
  • any
  • specific
Subnet segment type.
value
string
Subnet segment value.
tagging
list / elements=string
Config object tagging
category
string
Tag category. Source system.object-tagging.category.
name
string / required
Tagging entry name.
tags
list / elements=string
Tags.
name
string / required
Tag name. Source system.object-tagging.tags.name.
template
string
IPv6 address template. Source firewall.address6-template.name.
type
string
    Choices:
  • ipprefix
  • iprange
  • fqdn
  • dynamic
  • template
  • mac
  • geography
Type of IPv6 address object .
uuid
string
Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
visibility
string
    Choices:
  • enable
  • disable
Enable/disable the visibility of the object in the GUI.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
Default:
"root"
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.

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IPv6 firewall addresses.
    fortios_firewall_address6:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_address6:
        cache_ttl: "3"
        color: "4"
        comment: "Comment."
        country: "<your_own_value>"
        end_ip: "<your_own_value>"
        end_mac: "<your_own_value>"
        fabric_object: "enable"
        fqdn: "<your_own_value>"
        host: "<your_own_value>"
        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_20"
        obj_id: "<your_own_value>"
        sdn: "nsx"
        start_ip: "<your_own_value>"
        start_mac: "<your_own_value>"
        subnet_segment:
         -
            name: "default_name_26"
            type: "any"
            value: "<your_own_value>"
        tagging:
         -
            category: "<your_own_value> (source system.object-tagging.category)"
            name: "default_name_31"
            tags:
             -
                name: "default_name_33 (source system.object-tagging.tags.name)"
        template: "<your_own_value> (source firewall.address6-template.name)"
        type: "ipprefix"
        uuid: "<your_own_value>"
        visibility: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_address6_module.html