fortinet.fortios.fortios_user_nac_policy module – Configure NAC policy matching pattern to identify matching NAC devices in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_user_nac_policy.
New in fortinet.fortios 2.0.0
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.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.9
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 NAC policy matching pattern to identify matching NAC devices. |
|
Category of NAC policy. Choices:
|
|
Description for the NAC policy matching pattern. |
|
NAC policy matching EMS tag. Source firewall.address.name. |
|
NAC policy matching family. |
|
Dynamic firewall address to associate MAC which match this policy. Source firewall.address.name. |
|
NAC policy matching host. |
|
NAC policy matching hardware vendor. |
|
NAC policy matching hardware version. |
|
NAC policy matching MAC address. |
|
NAC policy name. |
|
NAC policy matching operating system. |
|
NAC policy matching devices vulnerability severity lists. |
|
Enter multiple severity levels, where 0 = Info, 1 = Low, …, 4 = Critical |
|
NAC policy matching source. |
|
SSID policy to be applied on the matched NAC policy. Source wireless-controller.ssid-policy.name. |
|
Enable/disable NAC policy. Choices:
|
|
NAC policy matching software version. |
|
NAC device auto authorization when discovered and nac-policy matched. Choices:
|
|
FortiLink interface for which this NAC policy belongs to. Source system.interface.name. |
|
List of managed FortiSwitch groups on which NAC policy can be applied. |
|
Managed FortiSwitch group name from available options. Source switch-controller.switch-group.name. |
|
Switch MAC policy action to be applied on the matched NAC policy. Source switch-controller.mac-policy.name. |
|
switch-port-policy to be applied on the matched NAC policy. Source switch-controller.port-policy.name. |
|
List of managed FortiSwitches on which NAC policy can be applied. |
|
Managed FortiSwitch name from available options. Source switch-controller.managed-switch.switch-id. |
|
NAC policy matching type. |
|
NAC policy matching user. |
|
NAC policy matching user group. Source user.group.name. |
|
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: |
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 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>"
ems_tag: "<your_own_value> (source firewall.address.name)"
family: "<your_own_value>"
firewall_address: "<your_own_value> (source firewall.address.name)"
host: "myhostname"
hw_vendor: "<your_own_value>"
hw_version: "<your_own_value>"
mac: "<your_own_value>"
name: "default_name_12"
os: "<your_own_value>"
severity:
-
severity_num: "0"
src: "<your_own_value>"
ssid_policy: "<your_own_value> (source wireless-controller.ssid-policy.name)"
status: "enable"
sw_version: "<your_own_value>"
switch_auto_auth: "global"
switch_fortilink: "<your_own_value> (source system.interface.name)"
switch_group:
-
name: "default_name_23 (source switch-controller.switch-group.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 here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |