Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_pppoe_interface — Настройка интерфейсов PPPoE в 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_pppoe_interface.

Новый в fortinet.fortios 2.0.0

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

Описание

  • Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные параметры и категорию pppoe_interface. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на 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"

state

строка / обязательно

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

system_pppoe_interface

словарь

Настройка интерфейсов PPPoE.

ac_name

строка

Имя PPPoE AC.

auth_type

строка

Тип аутентификации PPP.

Варианты:

  • "auto"
  • "pap"
  • "chap"
  • "mschapv1"
  • "mschapv2"

device

строка

Имя физического интерфейса. Источник system.interface.name.

dial_on_demand

строка

Включить/отключить настройка вызова по требованию для вызова интерфейса PPPoE, когда пакеты маршрутизируются в интерфейс PPPoE.

Варианты:

  • "enable"
  • "disable"

disc_retry_timeout

целое число

Значение таймаута инициализации обнаружения PPPoE в (0-4294967295 сек).

idle_timeout

целое число

Автоматическое отключение PPPoE после таймаута простоя (0-4294967295 сек).

ipunnumbered

строка

Нечисловой IP-адрес PPPoE.

ipv6

строка

Включить/отключить IPv6 Control Protocol (IPv6CP).

Варианты:

  • "enable"
  • "disable"

lcp_echo_interval

целое число

Время в секундах между запросами эха PPPoE Link Control Protocol (LCP).

lcp_max_echo_fails

целое число

Максимальное количество пропущенных сообщений эха LCP перед отключением.

name

строка / обязательно

Имя интерфейса PPPoE.

padt_retry_timeout

целое число

Значение таймаута завершения PPPoE в (0-4294967295 сек).

password

строка

Введите пароль.

pppoe_unnumbered_negotiate

строка

Включить/выключить согласование PPPoE без номера.

Варианты:

  • "enable"
  • "disable"

service_name

строка

Имя службы PPPoE.

username

строка

Имя пользователя.

END_OF_DOCUMENT_MARKER

vdom

string

Виртуальный домен, среди ранее определенных. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный модуль.

Default: "root"

Примечания

Примечание

  • Устаревший fortiosapi был заменен, httpapi — предпочтительный способ запуска playbooks
  • Модуль поддерживает 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"
          name: "default_name_13"
          padt_retry_timeout: "1"
          password: "<your_own_value>"
          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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_pppoe_interface_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API