fortinet.fortios.fortios_system_stp модуль — Настройка протокола STP (Spanning Tree Protocol) на устройствах FortiOS и FortiGate Fortinet.

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortios.fortios_system_stp.

Впервые в fortinet.fortios 2.0.0

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

Обзор

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в веб-интерфейсе Fortigate.
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для работы. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операций с членами.
member_state строка	Добавить или удалить члена по указанному пути к атрибуту. При указании member_state параметр state игнорируется. Варианты: `"present"` `"absent"`
system_stp словарь	Настроить протокол Spanning Tree Protocol (STP).
config_revision целое число	Ревизия конфигурации STP (0 - 4294967295).
forward_delay целое число	Задержка передачи (4 - 30 с).
hello_time целое число	Время приветствия (1 - 10 с).
max_age целое число	Максимальный срок действия пакета (6 - 40 с).
max_hops целое число	Максимальное количество переходов (1 - 40).
region_name строка	Установить имя региона.
status строка	Включить/выключить настройки STP.
switch_priority строка	Приоритет коммутатора STP; чем меньше число, тем выше приоритет (выберите из 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248 и 57344). Варианты: `"0"` `"4096"` `"8192"` `"12288"` `"16384"` `"20480"` `"24576"` `"28672"` `"32768"` `"36864"` `"40960"` `"45056"` `"49152"` `"53248"` `"57344"`
vdom строка	Виртуальная область, определённая ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi устарел, httpapi — предпочтительный способ выполнения книг задач

Примеры

- name: Configure Spanning Tree Protocol (STP).
  fortinet.fortios.fortios_system_stp:
      vdom: "{{ vdom }}"
      system_stp:
          config_revision: "2147483647"
          forward_delay: "15"
          hello_time: "2"
          max_age: "20"
          max_hops: "20"
          region_name: "<your_own_value>"
          status: "<your_own_value>"
          switch_priority: "0"

Значения возврата

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

Ключ	Описание
build строка	Номер сборки изображения fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate по последней применённой операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (ID), используемый в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер версии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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_system_stp_module.html