fortios_switch_controller_dynamic_port_policy – Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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 dynamic_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¶
- 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- switch_controller_dynamic_port_policy - Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device. type: dict more...
- description - Description for the Dynamic port policy. type: str more...
- fortilink - FortiLink interface for which this Dynamic port policy belongs to. Source system.interface.name. type: str more...
- name - Dynamic port policy name. type: str required: True more...
- policy - Port policies with matching criteria and actions. type: list more...
- 802_1x - 802.1x security policy to be applied when using this 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 policy is applied. Helps to clear and reassign VLAN from lldp-profile. type: str choices: disable, enable more...
- category - Category of Dynamic port policy. type: str choices: device, interface-tag more...
- description - Description for the policy. type: str more...
- family - Policy matching family. type: str more...
- host - Policy matching host. type: str more...
- interface_tags - Policy matching the FortiSwitch interface object tags. type: list more...
- tag_name - FortiSwitch port tag name. Source switch-controller.switch-interface-tag.name. type: str more...
- lldp_profile - LLDP profile to be applied when using this policy. Source switch-controller.lldp-profile.name. type: str more...
- mac - Policy matching MAC address. type: str more...
- name - Policy name. type: str required: True more...
- qos_policy - QoS policy to be applied when using this policy. Source switch-controller.qos.qos-policy.name. type: str more...
- status - Enable/disable policy. type: str choices: enable, disable more...
- type - Policy matching type. type: str more...
- vlan_policy - VLAN policy to be applied when using this policy. Source switch-controller.vlan-policy.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 Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device.
fortios_switch_controller_dynamic_port_policy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_dynamic_port_policy:
description: "<your_own_value>"
fortilink: "<your_own_value> (source system.interface.name)"
name: "default_name_5"
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"
category: "device"
description: "<your_own_value>"
family: "<your_own_value>"
host: "myhostname"
interface_tags:
-
tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
mac: "<your_own_value>"
name: "default_name_17"
qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
status: "enable"
type: "<your_own_value>"
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