fortinet.fortios.fortios_switch_controller_port_policy – Configure port policy to be applied on the managed FortiSwitch ports through NAC device in Fortinet’s FortiOS and FortiGate.

Note

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

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.

To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_port_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 switch_controller feature and port_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.
switch_controller_port_policy dictionary			Configure port policy to be applied on the managed FortiSwitch ports through NAC device.
	802_1x string		802.1x security policy to be applied when using this port-policy. Source switch-controller.security-policy.802-1X.name switch-controller .security-policy.captive-portal.name.
	bounce_port_link string	Choices: disable enable	Enable/disable bouncing (administratively bring the link down, up) of a switch port where this port policy is applied. Helps to clear and reassign VLAN from lldp-profile.
	description string		Description for the port policy.
	fortilink string		FortiLink interface for which this port policy belongs to. Source system.interface.name.
	lldp_profile string		LLDP profile to be applied when using this port-policy. Source switch-controller.lldp-profile.name.
	name string / required		Port policy name.
	qos_policy string		QoS policy to be applied when using this port-policy. Source switch-controller.qos.qos-policy.name.
	vlan_policy string		VLAN policy to be applied when using this port-policy. Source switch-controller.vlan-policy.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 port policy to be applied on the managed FortiSwitch ports through NAC device.
    fortios_switch_controller_port_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_port_policy:
        802_1x: "<your_own_value> (source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal.name)"
        bounce_port_link: "disable"
        description: "<your_own_value>"
        fortilink: "<your_own_value> (source system.interface.name)"
        lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
        name: "default_name_8"
        qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
        vlan_policy: "<your_own_value> (source switch-controller.vlan-policy.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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_port_policy_module.html

Docs

Docs4dev

Title here