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.
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 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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.4.0 -> v6.4.4
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
- switch_controller_port_policy - Configure port policy to be applied on the managed FortiSwitch ports through NAC device. type: dict more...
- set_802_1x - 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. type: str more...
- bounce_port_link - 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. type: str choices: disable, enable more...
- description - Description for the port policy. type: str more...
- fortilink - FortiLink interface for which this port policy belongs to. Source system.interface.name. type: str more...
- lldp_profile - LLDP profile to be applied when using this port-policy. Source switch-controller.lldp-profile.name. type: str more...
- name - Port policy name. type: str required: true more...
- qos_policy - QoS policy to be applied when using this port-policy. Source switch-controller.qos.qos-policy.name. type: str more...
- vlan_policy - VLAN policy to be applied when using this port-policy. Source switch-controller.vlan-policy.name. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure port policy to be applied on the managed FortiSwitch ports through NAC device.
fortinet.fortios.fortios_switch_controller_port_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_port_policy:
set_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: 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
Status
This module is not guaranteed to have a backwards compatible interface.