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.¶
New in version 2.0.0.
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
FortiOS Version Compatibility¶
v6.4.0 |
v6.4.1 |
v6.4.4 |
|
fortios_switch_controller_nac_device | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- switch_controller_nac_device - Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy. type: dict more...
- description - Description for the learned NAC device. type: str more...
- id - Device ID. type: int required: true more...
- last_known_port - Managed FortiSwitch port where NAC device is last learned. type: str more...
- last_known_switch - Managed FortiSwitch where NAC device is last learned. Source switch-controller.managed-switch.switch-id. type: str more...
- last_seen - Device last seen. type: int more...
- mac - MAC address of the learned NAC device. type: str more...
- mac_policy - MAC policy to be applied on this learned NAC device. Source switch-controller.mac-policy.name. type: str more...
- matched_nac_policy - Matched NAC policy for the learned NAC device. Source user.nac-policy.name. type: str more...
- port_policy - Port policy to be applied on this learned NAC device. Source switch-controller.port-policy.name. type: str more...
- status - Status of the learned NAC device. Set enable to authorize the NAC device. type: str choices: enable, disable more...
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: "2147483647"
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3