модуль fortinet.fortios.fortios_system_pppoe_interface — настройка интерфейсов PPPoE в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

Краткое описание

Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя системные функции и параметры категории pppoe_interface. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на 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"`
system_pppoe_interface dictionary	Настройка интерфейсов PPPoE.
ac_name string	Имя узла доступа PPPoE (AC).
auth_type string	Тип аутентификации PPP. Варианты: `"auto"` `"pap"` `"chap"` `"mschapv1"` `"mschapv2"`
device string	Имя физического интерфейса. Источник: system.interface.name.
dial_on_demand string	Включить или отключить дозвон по требованию для установки соединения через интерфейс PPPoE при маршрутизации пакетов на этот интерфейс. Варианты: `"enable"` `"disable"`
disc_retry_timeout integer	Значение тайм-аута инициализации обнаружения PPPoE (0–4294967295 с).
idle_timeout integer	Автоматическое отключение PPPoE по тайм-ауту бездействия (0–4294967295 с).
ipunnumbered string	Ненумерованный IP-адрес PPPoE.
ipv6 string	Включить или отключить протокол управления IPv6 (IPv6CP). Варианты: `"enable"` `"disable"`
lcp_echo_interval integer	Интервал в секундах между эхо-запросами протокола управления каналом PPPoE (LCP).
lcp_max_echo_fails integer	Максимальное число пропущенных эхо-сообщений LCP до отключения.
mrru integer	MRRU для PPP (296–65535).
multilink string	Включить или отключить поддержку многоканального PPP. Варианты: `"enable"` `"disable"`
name string / обязательный	Имя интерфейса PPPoE.
padt_retry_timeout integer	Значение тайм-аута завершения PPPoE (0–4294967295 с).
password string	Введите пароль.
pppoe_egress_cos string	CoS в теге VLAN для исходящих пакетов PPPoE/PPP. Варианты: `"cos0"` `"cos1"` `"cos2"` `"cos3"` `"cos4"` `"cos5"` `"cos6"` `"cos7"`
pppoe_unnumbered_negotiate string	Включить или отключить согласование ненумерованного PPPoE. Варианты: `"enable"` `"disable"`
service_name string	Имя службы PPPoE.
username string	Имя пользователя.
vdom string	Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure the PPPoE interfaces.
  fortinet.fortios.fortios_system_pppoe_interface:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_pppoe_interface:
          ac_name: "<your_own_value>"
          auth_type: "auto"
          device: "<your_own_value> (source system.interface.name)"
          dial_on_demand: "enable"
          disc_retry_timeout: "1"
          idle_timeout: "0"
          ipunnumbered: "<your_own_value>"
          ipv6: "enable"
          lcp_echo_interval: "5"
          lcp_max_echo_fails: "3"
          mrru: "1500"
          multilink: "enable"
          name: "default_name_15"
          padt_retry_timeout: "1"
          password: "<your_own_value>"
          pppoe_egress_cos: "cos0"
          pppoe_unnumbered_negotiate: "enable"
          service_name: "<your_own_value>"
          username: "<your_own_value>"

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

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

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