Модуль fortinet.fortios.fortios_switch_controller_vlan_policy — настройка политики VLAN, применяемой к управляемым портам FortiSwitch посредством dynamic-port-policy в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_switch_controller_vlan_policy.

Добавлено в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции switch_controller и категории vlan_policy. Примеры содержат все параметры; перед использованием необходимо настроить их значения в соответствии с источниками данных. Проверено с FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов больше одного, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции с элементом.
member_state string	Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
switch_controller_vlan_policy dictionary	Настройка политики VLAN, применяемой к управляемым портам FortiSwitch посредством dynamic-port-policy.
allowed_vlans list / elements=dictionary	Разрешенные VLAN, применяемые при использовании этой политики VLAN.
vlan_name string / обязательный	Имя VLAN. Источник: system.interface.name.
allowed_vlans_all string	Включить или отключить все определенные VLAN при использовании этой политики VLAN. Варианты: `"enable"` `"disable"`
description string	Описание политики VLAN.
discard_mode string	Режим отбрасывания пакетов, применяемый при использовании этой политики VLAN. Варианты: `"none"` `"all-untagged"` `"all-tagged"`
fortilink string	Интерфейс FortiLink, к которому относится эта политика VLAN. Источник: system.interface.name.
name string / обязательный	Имя политики VLAN.
untagged_vlans list / elements=dictionary	VLAN без тегов, применяемые при использовании этой политики VLAN.
vlan_name string / обязательный	Имя VLAN. Источник: system.interface.name.
vlan string	Собственный VLAN, применяемый при использовании этой политики VLAN. Источник: system.interface.name.
vdom string	Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
Модуль поддерживает check_mode.

Примеры

- 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)"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_vlan_policy_module.html