fortinet.fortios.fortios_switch_controller_nac_device – Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy 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_nac_device
.
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 nac_device 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_nac_device dictionary | Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy. | ||
description string | Description for the learned NAC device. | ||
id integer / required | Device ID. | ||
last_known_port string | Managed FortiSwitch port where NAC device is last learned. | ||
last_known_switch string | Managed FortiSwitch where NAC device is last learned. Source switch-controller.managed-switch.switch-id. | ||
last_seen integer | Device last seen. | ||
mac string | MAC address of the learned NAC device. | ||
mac_policy string | MAC policy to be applied on this learned NAC device. Source switch-controller.mac-policy.name. | ||
matched_nac_policy string | Matched NAC policy for the learned NAC device. Source user.nac-policy.name. | ||
port_policy string | Port policy to be applied on this learned NAC device. Source switch-controller.port-policy.name. | ||
status string |
| Status of the learned NAC device. Set enable to authorize the NAC device. | |
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/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy. fortios_switch_controller_nac_device: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" switch_controller_nac_device: description: "<your_own_value>" id: "4" last_known_port: "<your_own_value>" last_known_switch: "<your_own_value> (source switch-controller.managed-switch.switch-id)" last_seen: "7" mac: "<your_own_value>" mac_policy: "<your_own_value> (source switch-controller.mac-policy.name)" matched_nac_policy: "<your_own_value> (source user.nac-policy.name)" port_policy: "<your_own_value> (source switch-controller.port-policy.name)" status: "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_switch_controller_nac_device_module.html