W3cubDocs

/Ansible

fortinet.fortios.fortios_switch_controller_vlan_policy module – Configure VLAN policy to be applied on the managed FortiSwitch ports through dynamic-port-policy in Fortinet’s FortiOS and FortiGate.

Note

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

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

New in fortinet.fortios 2.0.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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

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_vlan_policy dictionary	Configure VLAN policy to be applied on the managed FortiSwitch ports through dynamic-port-policy.
allowed_vlans list / elements=dictionary	Allowed VLANs to be applied when using this VLAN policy.
vlan_name string / required	VLAN name. Source system.interface.name.
allowed_vlans_all string	Enable/disable all defined VLANs when using this VLAN policy. Choices: `"enable"` `"disable"`
description string	Description for the VLAN policy.
discard_mode string	Discard mode to be applied when using this VLAN policy. Choices: `"none"` `"all-untagged"` `"all-tagged"`
fortilink string	FortiLink interface for which this VLAN policy belongs to. Source system.interface.name.
name string / required	VLAN policy name.
untagged_vlans list / elements=dictionary	Untagged VLANs to be applied when using this VLAN policy.
vlan_name string / required	VLAN name. Source system.interface.name.
vlan string	Native VLAN to be applied when using this VLAN policy. Source system.interface.name.
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

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.

Examples

- name: Configure VLAN policy to be applied on the managed FortiSwitch ports through dynamic-port-policy.
  fortinet.fortios.fortios_switch_controller_vlan_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_vlan_policy:
          allowed_vlans:
              -
                  vlan_name: "<your_own_value> (source system.interface.name)"
          allowed_vlans_all: "enable"
          description: "<your_own_value>"
          discard_mode: "none"
          fortilink: "<your_own_value> (source system.interface.name)"
          name: "default_name_9"
          untagged_vlans:
              -
                  vlan_name: "<your_own_value> (source system.interface.name)"
          vlan: "<your_own_value> (source system.interface.name)"

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)

Collection links

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