fortinet.fortios.fortios_wireless_controller_access_control_list module – Configure WiFi bridge access control list in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.5).

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in fortinet.fortios 2.0.0

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and access_control_list 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

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: "present" "absent"
state string / required	Indicates whether to create or remove the object. Choices: "present" "absent"
vdom string	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. Default: "root"
wireless_controller_access_control_list dictionary	Configure WiFi bridge access control list.
comment string	Description.
layer3_ipv4_rules list / elements=dictionary	AP ACL layer3 ipv4 rule list.
action string	Policy action (allow | deny). Choices: "allow" "deny"
comment string	Description.
dstaddr string	Destination IP address (any | local-LAN | IPv4 address[/<network mask | mask length>]).
dstport integer	Destination port (0 - 65535).
protocol integer	Protocol type as defined by IANA (0 - 255).
rule_id integer / required	Rule ID (1 - 65535). see <a href=’#notes’>Notes</a>.
srcaddr string	Source IP address (any | local-LAN | IPv4 address[/<network mask | mask length>]).
srcport integer	Source port (0 - 65535).
layer3_ipv6_rules list / elements=dictionary	AP ACL layer3 ipv6 rule list.
action string	Policy action (allow | deny). Choices: "allow" "deny"
comment string	Description.
dstaddr string	Destination IPv6 address (any | local-LAN | IPv6 address[/prefix length]), default = any.
dstport integer	Destination port (0 - 65535).
protocol integer	Protocol type as defined by IANA (0 - 255).
rule_id integer / required	Rule ID (1 - 65535). see <a href=’#notes’>Notes</a>.
srcaddr string	Source IPv6 address (any | local-LAN | IPv6 address[/prefix length]), default = any.
srcport integer	Source port (0 - 65535).
name string / required	AP access control list name.

Notes

Note

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

Examples

- name: Configure WiFi bridge access control list.
  fortinet.fortios.fortios_wireless_controller_access_control_list:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_access_control_list:
          comment: "Description."
          layer3_ipv4_rules:
              -
                  action: "allow"
                  comment: "Description."
                  dstaddr: "<your_own_value>"
                  dstport: "0"
                  protocol: "255"
                  rule_id: "<you_own_value>"
                  srcaddr: "<your_own_value>"
                  srcport: "0"
          layer3_ipv6_rules:
              -
                  action: "allow"
                  comment: "Description."
                  dstaddr: "<your_own_value>"
                  dstport: "0"
                  protocol: "255"
                  rule_id: "<you_own_value>"
                  srcaddr: "<your_own_value>"
                  srcport: "0"
          name: "default_name_22"

Return Values

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

Key	Description
build string	Build number of the fortigate image Returned: always Sample: "1547"
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: "PUT"
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: "200"
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: "id"
name string	Name of the table used to fulfill the request Returned: always Sample: "urlfilter"
path string	Path of the table used to fulfill the request Returned: always Sample: "webfilter"
revision string	Internal revision number Returned: always Sample: "17.0.2.10658"
serial string	Serial number of the unit Returned: always Sample: "FGVMEVYYQT3AB5352"
status string	Indication of the operation’s result Returned: always Sample: "success"
vdom string	Virtual domain used Returned: always Sample: "root"
version string	Version of the FortiGate Returned: always 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)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)