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.3).
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 |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy. |
|
Description for the learned NAC device. |
|
Device ID. |
|
Managed FortiSwitch port where NAC device is last learned. |
|
Managed FortiSwitch where NAC device is last learned. Source switch-controller.managed-switch.switch-id. |
|
Device last seen. |
|
MAC address of the learned NAC device. |
|
MAC policy to be applied on this learned NAC device. Source switch-controller.mac-policy.name. |
|
Matched NAC policy for the learned NAC device. Source user.nac-policy.name. |
|
Port policy to be applied on this learned NAC device. Source switch-controller.port-policy.name. |
|
Status of the learned NAC device. Set enable to authorize the NAC device. Choices:
|
|
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” |
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 |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
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)