fortinet.fortios.fortios_user_nac_policy – Configure NAC policy matching pattern to identify matching NAC devices in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_user_nac_policy.

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 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.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
user_nac_policy
dictionary
Configure NAC policy matching pattern to identify matching NAC devices.
category
string
    Choices:
  • device
  • firewall-user
  • ems-tag
Category of NAC policy.
description
string
Description for the NAC policy matching pattern.
ems_tag
string
NAC policy matching EMS tag. Source firewall.address.name.
family
string
NAC policy matching family.
host
string
NAC policy matching host.
hw_vendor
string
NAC policy matching hardware vendor.
hw_version
string
NAC policy matching hardware version.
mac
string
NAC policy matching MAC address.
name
string / required
NAC policy name.
os
string
NAC policy matching operating system.
src
string
NAC policy matching source.
ssid_policy
string
SSID policy to be applied on the matched NAC policy. Source wireless-controller.ssid-policy.name.
status
string
    Choices:
  • enable
  • disable
Enable/disable NAC policy.
sw_version
string
NAC policy matching software version.
switch_auto_auth
string
    Choices:
  • global
  • disable
  • enable
NAC device auto authorization when discovered and nac-policy matched.
switch_fortilink
string
FortiLink interface for which this NAC policy belongs to. Source system.interface.name.
switch_mac_policy
string
switch-mac-policy to be applied on the matched NAC policy. Source switch-controller.mac-policy.name.
switch_port_policy
string
switch-port-policy to be applied on the matched NAC policy. Source switch-controller.port-policy.name.
switch_scope
list / elements=string
List of managed FortiSwitches on which NAC policy can be applied.
switch_id
string
Managed FortiSwitch name from available options. Source switch-controller.managed-switch.switch-id.
type
string
NAC policy matching type.
user
string
NAC policy matching user.
user_group
string
NAC policy matching user group. Source user.group.name.
vdom
string
Default:
"root"
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.

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>"
        host: "myhostname"
        hw_vendor: "<your_own_value>"
        hw_version: "<your_own_value>"
        mac: "<your_own_value>"
        name: "default_name_11"
        os: "<your_own_value>"
        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_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 Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

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)