fortios_user_nac_policy – Configure NAC policy matching pattern to identify matching NAC devices 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 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
FortiOS Version Compatibility¶
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_user_nac_policy | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | 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
- user_nac_policy - Configure NAC policy matching pattern to identify matching NAC devices. type: dict more...
- category - Category of NAC policy. type: str choices: device, firewall-user, ems-tag, vulnerability more...
- description - Description for the NAC policy matching pattern. type: str more...
- ems_tag - NAC policy matching EMS tag. Source firewall.address.name. type: str more...
- family - NAC policy matching family. type: str more...
- firewall_address - Dynamic firewall address to associate MAC which match this policy. Source firewall.address.name. type: str more...
- host - NAC policy matching host. type: str more...
- hw_vendor - NAC policy matching hardware vendor. type: str more...
- hw_version - NAC policy matching hardware version. type: str more...
- mac - NAC policy matching MAC address. type: str more...
- name - NAC policy name. type: str required: true more...
- os - NAC policy matching operating system. type: str more...
- severity - NAC policy matching devices vulnerability severity lists. type: list member_path: severity:severity_num more...
- severity_num - Enter multiple severity levels, where 0 = Info, 1 = Low, ..., 4 = Critical type: int required: true more...
- src - NAC policy matching source. type: str more...
- ssid_policy - SSID policy to be applied on the matched NAC policy. Source wireless-controller.ssid-policy.name. type: str more...
- status - Enable/disable NAC policy. type: str choices: enable, disable more...
- sw_version - NAC policy matching software version. type: str more...
- switch_auto_auth - NAC device auto authorization when discovered and nac-policy matched. type: str choices: global, disable, enable more...
- switch_fortilink - FortiLink interface for which this NAC policy belongs to. Source system.interface.name. type: str more...
- switch_group - List of managed FortiSwitch groups on which NAC policy can be applied. type: list member_path: switch_group:name more...
- name - Managed FortiSwitch group name from available options. Source switch-controller.switch-group.name. type: str required: true more...
- switch_mac_policy - Switch MAC policy action to be applied on the matched NAC policy. Source switch-controller.mac-policy.name. type: str more...
- switch_port_policy - switch-port-policy to be applied on the matched NAC policy. Source switch-controller.port-policy.name. type: str more...
- switch_scope - List of managed FortiSwitches on which NAC policy can be applied. type: list member_path: switch_scope:switch_id more...
- switch_id - Managed FortiSwitch name from available options. Source switch-controller.managed-switch.switch-id. type: str required: true more...
- type - NAC policy matching type. type: str more...
- user - NAC policy matching user. type: str more...
- user_group - NAC policy matching user group. Source user.group.name. type: str 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 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: 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