fortinet.fortios.fortios_switch_controller_mac_policy – Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device 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_switch_controller_mac_policy
.
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 switch_controller feature and mac_policy 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. | |
switch_controller_mac_policy dictionary | Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device. | ||
bounce_port_link string |
| Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. | |
count string |
| Enable/Disable packet count on the NAC device. | |
description string | Description for the MAC policy. | ||
drop string |
| Enable/disable dropping of NAC device traffic. | |
fortilink string | FortiLink interface for which this MAC policy belongs to. Source system.interface.name. | ||
name string / required | MAC policy name. | ||
traffic_policy string | Traffic policy to be applied when using this MAC policy. Source switch-controller.traffic-policy.name. | ||
vlan string | Ingress traffic VLAN assignment for the MAC address matching this MAC policy. Source system.interface.name. | ||
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 MAC policy to be applied on the managed FortiSwitch devices through NAC device. fortios_switch_controller_mac_policy: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" switch_controller_mac_policy: bounce_port_link: "disable" count: "disable" description: "<your_own_value>" drop: "disable" fortilink: "<your_own_value> (source system.interface.name)" name: "default_name_8" traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)" vlan: "<your_own_value> (source system.interface.name)"
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_switch_controller_mac_policy_module.html