fortinet.fortios.fortios_switch_controller_nac_device module – Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.4).

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

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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

switch_controller_nac_device

dictionary

Configure/list NAC devices learned on the managed FortiSwitch ports which matches NAC policy.

description

string

Description for the learned NAC device.

id

integer / required

Device ID. see <a href=’#notes’>Notes</a>.

last_known_port

string

Managed FortiSwitch port where NAC device is last learned.

last_known_switch

string

Managed FortiSwitch where NAC device is last learned. Source switch-controller.managed-switch.switch-id.

last_seen

integer

Device last seen.

mac

string

MAC address of the learned NAC device.

mac_policy

string

MAC policy to be applied on this learned NAC device. Source switch-controller.mac-policy.name.

matched_nac_policy

string

Matched NAC policy for the learned NAC device. Source user.nac-policy.name.

port_policy

string

Port policy to be applied on this learned NAC device. Source switch-controller.port-policy.name.

status

string

Status of the learned NAC device. Set enable to authorize the NAC device.

Choices:

  • "enable"

  • "disable"

vdom

string

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: "root"

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.

  • 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/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 here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

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)