Модуль fortinet.fortios.fortios_router_auth_path — Настройка маршрутизации, основанной на аутентификации, в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет 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), позволяя пользователю задавать и изменять параметры маршрутизатора и категорию auth_path. Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных. Тестировалось с FOS v6.0.0.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в GUI Fortigate. |
enable_log логический тип | Включение/выключение ведения журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, является допустимым для выполнения операции с членом. |
member_state строка | Добавление или удаление члена в указанном пути атрибута. При указании member_state параметр state игнорируется. Варианты:
|
router_auth_path словарь | Настройка маршрутизации, основанной на аутентификации. |
|
device строка |
Выходящий интерфейс. Источник системы.интерфейс.имя. |
|
gateway строка |
IP-адрес шлюза. |
|
name строка / обязательно |
Имя записи. |
state строка / обязательно | Указывает, необходимо ли создать или удалить объект. Варианты:
|
vdom строка | Виртуальная область, определенная ранее. ВДОМ — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший 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 строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate при последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_router_auth_path_module.html