fortinet.fortios.fortios_wireless_controller_access_control_list – Configure WiFi bridge access control list 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_wireless_controller_access_control_list
.
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 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.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
state string / required |
| 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. | ||
wireless_controller_access_control_list dictionary | Configure WiFi bridge access control list. | |||
comment string | Description. | |||
layer3_ipv4_rules list / elements=string | AP ACL layer3 ipv4 rule list. | |||
action string |
| Policy action (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 | Rule ID (1 - 65535). | |||
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=string | AP ACL layer3 ipv6 rule list. | |||
action string |
| Policy action (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 | Rule ID (1 - 65535). | |||
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
- 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 WiFi bridge access control list. 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: "8" protocol: "9" rule_id: "10" srcaddr: "<your_own_value>" srcport: "12" layer3_ipv6_rules: - action: "allow" comment: "Description." dstaddr: "<your_own_value>" dstport: "17" protocol: "18" rule_id: "19" srcaddr: "<your_own_value>" srcport: "21" name: "default_name_22"
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_wireless_controller_access_control_list_module.html