Модуль fortinet.fortios.fortios_switch_controller_vlan — Настройка VLAN для контроллера коммутатора в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortios.fortios_switch_controller_vlan.

Новая функция в fortinet.fortios 2.0.0

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

Описание

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в GUI Fortigate.
enable_log boolean	Включить/Отключить логирование для задачи. Варианты: `false` ← (default) `true`
member_path string	Путь к атрибуту члена для выполнения операции. Разделяется символом слеша, если атрибутов более одного. Параметр, помеченный как member_path, является допустимым для выполнения операции с членом.
member_state string	Добавить или удалить члена по указанному пути к атрибуту. Когда указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / required	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
switch_controller_vlan dictionary	Настроить VLAN для контроллера коммутатора.
auth string	Аутентификация. Варианты: `"radius"` `"usergroup"`
color integer	Цвет значка в GUI.
comments string	Комментарий.
name string / required	Имя VLAN коммутатора.
portal_message_override_group string	Указать группу переопределения замещающего сообщения портала.
portal_message_overrides dictionary	Индивидуальные переопределения сообщений.
auth_disclaimer_page string	Переопределить сообщение auth-disclaimer-page сообщением из группы portal-message-overrides.
auth_login_failed_page string	Переопределить сообщение auth-login-failed-page сообщением из группы portal-message-overrides.
auth_login_page string	Переопределить сообщение auth-login-page сообщением из группы portal-message-overrides.
auth_reject_page string	Переопределить сообщение auth-reject-page сообщением из группы portal-message-overrides.
radius_server string	RADIUS-сервер аутентификации. Источник user.radius.name.
security string	Безопасность. Варианты: `"open"` `"captive-portal"` `"8021x"`
selected_usergroups list / elements=dictionary	Выбранная группа пользователей.
name string / required	Имя группы пользователей. Источник user.group.name.
usergroup string	Группа пользователей аутентификации. Источник user.group.name.
vdom string	Виртуальный домен.

vlanid integer	Идентификатор VLAN.
vdom string	Виртуальный домен, среди ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. Default: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure VLANs for switch controller.
  fortinet.fortios.fortios_switch_controller_vlan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_vlan:
          auth: "radius"
          color: "16"
          comments: "<your_own_value>"
          name: "default_name_6"
          portal_message_override_group: "<your_own_value>"
          portal_message_overrides:
              auth_disclaimer_page: "<your_own_value>"
              auth_login_failed_page: "<your_own_value>"
              auth_login_page: "<your_own_value>"
              auth_reject_page: "<your_own_value>"
          radius_server: "<your_own_value> (source user.radius.name)"
          security: "open"
          selected_usergroups:
              -
                  name: "default_name_16 (source user.group.name)"
          usergroup: "<your_own_value> (source user.group.name)"
          vdom: "<your_own_value>"
          vlanid: "2047"

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

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

Ключ	Описание
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–2024 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_module.html