Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_switch_controller_dynamic_port_policy_module.html

fortinet.fortios.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.

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

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_dynamic_port_policy
dictionary
Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device.
description
string
Description for the Dynamic port policy.
fortilink
string
FortiLink interface for which this Dynamic port policy belongs to. Source system.interface.name.
name
string / required
Dynamic port policy name.
policy
list / elements=string
Port policies with matching criteria and actions.
802_1x
string
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.
bounce_port_link
string
    Choices:
  • disable
  • enable
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.
category
string
    Choices:
  • device
  • interface-tag
Category of Dynamic port policy.
description
string
Description for the policy.
family
string
Policy matching family.
host
string
Policy matching host.
interface_tags
list / elements=string
Policy matching the FortiSwitch interface object tags.
tag_name
string
FortiSwitch port tag name. Source switch-controller.switch-interface-tag.name.
lldp_profile
string
LLDP profile to be applied when using this policy. Source switch-controller.lldp-profile.name.
mac
string
Policy matching MAC address.
name
string / required
Policy name.
qos_policy
string
QoS policy to be applied when using this policy. Source switch-controller.qos.qos-policy.name.
status
string
    Choices:
  • enable
  • disable
Enable/disable policy.
type
string
Policy matching type.
vlan_policy
string
VLAN policy to be applied when using this 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 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 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_dynamic_port_policy_module.html