Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_router_auth_path — настройка маршрутизации на основе аутентификации в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

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

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

router_auth_path

dictionary

Настройка маршрутизации на основе аутентификации.

device

string

Исходящий интерфейс. Источник: system.interface.name.

gateway

string

IP-адрес шлюза.

name

string / обязательный

Имя записи.

state

string / обязательный

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

Возможные значения:

  • "present"
  • "absent"

vdom

string

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

По умолчанию: "root"

Примечания

Примечание

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

Примеры

- name: Configure authentication based routing.
  fortinet.fortios.fortios_router_auth_path:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_auth_path:
          device: "<your_own_value> (source system.interface.name)"
          gateway: "<your_own_value>"
          name: "default_name_5"

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

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

Ключ

Описание

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_router_auth_path_module.html

Spec-Zone.ru

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