fortios_user_nac_policy – Configure NAC policy matching pattern to identify matching NAC devices in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and nac_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- user_nac_policy - Configure NAC policy matching pattern to identify matching NAC devices. type: dict
- category - Category of NAC policy. type: str choices: device, firewall-user
- description - Description for the NAC policy matching pattern. type: str
- family - NAC policy matching family. type: str
- host - NAC policy matching host. type: str
- hw_vendor - NAC policy matching hardware vendor. type: str
- hw_version - NAC policy matching hardware version. type: str
- mac - NAC policy matching MAC address. type: str
- name - NAC policy name. type: str required: True
- os - NAC policy matching operating system. type: str
- src - NAC policy matching source. type: str
- status - Enable/disable NAC policy. type: str choices: enable, disable
- sw_version - NAC policy matching software version. type: str
- switch_auto_auth - NAC device auto authorization when discovered and nac-policy matched. type: str choices: global, disable, enable
- switch_fortilink - FortiLink interface for which this NAC policy belongs to. Source system.interface.name. type: str
- switch_mac_policy - switch-mac-policy to be applied on the matched NAC policy. Source switch-controller.mac-policy.name. type: str
- switch_port_policy - switch-port-policy to be applied on the matched NAC policy. Source switch-controller.port-policy.name. type: str
- switch_scope - List of managed FortiSwitches on which NAC policy can be applied. type: list
- switch_id - Managed FortiSwitch name from available options. Source switch-controller.managed-switch.switch-id. type: str
- type - NAC policy matching type. type: str
- user - NAC policy matching user. type: str
- user_group - NAC policy matching user group. Source user.group.name. type: str
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 NAC policy matching pattern to identify matching NAC devices.
fortios_user_nac_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_nac_policy:
category: "device"
description: "<your_own_value>"
family: "<your_own_value>"
host: "myhostname"
hw_vendor: "<your_own_value>"
hw_version: "<your_own_value>"
mac: "<your_own_value>"
name: "default_name_10"
os: "<your_own_value>"
src: "<your_own_value>"
status: "enable"
sw_version: "<your_own_value>"
switch_auto_auth: "global"
switch_fortilink: "<your_own_value> (source system.interface.name)"
switch_mac_policy: "<your_own_value> (source switch-controller.mac-policy.name)"
switch_port_policy: "<your_own_value> (source switch-controller.port-policy.name)"
switch_scope:
-
switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
type: "<your_own_value>"
user: "<your_own_value>"
user_group: "<your_own_value> (source user.group.name)"
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