Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

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

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.

authentication_rule

dictionary

Настройка правил аутентификации.

active_auth_method

string

Выберите активный метод аутентификации. Источник: authentication.scheme.name.

cert_auth_cookie

string

Включить или отключить использование сертификата устройства в качестве cookie аутентификации.

Варианты:

  • "enable"
  • "disable"

comments

string

Комментарий.

cors_depth

integer

Глубина, на которую разрешён доступ CORS.

cors_stateful

string

Включить или отключить разрешение доступа CORS.

Варианты:

  • "enable"
  • "disable"

dstaddr

list / elements=dictionary

Выберите IPv4-адрес назначения из доступных вариантов. Требуется для аутентификации веб-прокси.

name

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

Имя адреса. Источник: firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name.

dstaddr6

list / elements=dictionary

Выберите IPv6-адрес назначения из доступных вариантов. Требуется для аутентификации веб-прокси.

name

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

Имя адреса. Источник: firewall.address6.name firewall.addrgrp6.name.

ip_based

string

Включить или отключить аутентификацию на основе IP-адреса. Если она включена, ранее прошедшие аутентификацию пользователи с того же IP-адреса не будут проходить её повторно.

Варианты:

  • "enable"
  • "disable"

name

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

Имя правила аутентификации.

protocol

string

Для выбранного протокола требуется аутентификация.

Варианты:

  • "http"
  • "ftp"
  • "socks"
  • "ssh"
  • "ztna-portal"

session_logout

string

Включить или отключить выход пользователя из текущего сеанса.

Варианты:

  • "enable"
  • "disable"

srcaddr

list / elements=dictionary

Для выбранного IPv4-адреса источника требуется аутентификация.

name

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

Имя адреса. Источник: firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system .external-resource.name.

srcaddr6

list / elements=dictionary

Для выбранного IPv6-адреса источника требуется аутентификация.

name

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

Имя адреса. Источник: firewall.address6.name firewall.addrgrp6.name.

srcintf

list / elements=dictionary

Входящий интерфейс.

name

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

Имя интерфейса. Источник: system.interface.name system.zone.name system.sdwan.zone.name.

sso_auth_method

string

Выберите метод аутентификации с единой точкой входа (SSO). Источник: authentication.scheme.name.

status

string

Включить или отключить это правило аутентификации.

Варианты:

  • "enable"
  • "disable"

transaction_based

string

Включить или отключить аутентификацию на основе транзакций.

Варианты:

  • "enable"
  • "disable"

web_auth_cookie

string

Включить или отключить cookie веб-аутентификации.

Варианты:

  • "enable"
  • "disable"

web_portal

string

Включить или отключить веб-портал для прозрачной политики прокси.

Варианты:

  • "enable"
  • "disable"

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

Определяет, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Configure Authentication Rules.
  fortinet.fortios.fortios_authentication_rule:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      authentication_rule:
          active_auth_method: "<your_own_value> (source authentication.scheme.name)"
          cert_auth_cookie: "enable"
          comments: "<your_own_value>"
          cors_depth: "3"
          cors_stateful: "enable"
          dstaddr:
              -
                  name: "default_name_9 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          dstaddr6:
              -
                  name: "default_name_11 (source firewall.address6.name firewall.addrgrp6.name)"
          ip_based: "enable"
          name: "default_name_13"
          protocol: "http"
          session_logout: "enable"
          srcaddr:
              -
                  name: "default_name_17 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          srcaddr6:
              -
                  name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name)"
          srcintf:
              -
                  name: "default_name_21 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          sso_auth_method: "<your_own_value> (source authentication.scheme.name)"
          status: "enable"
          transaction_based: "enable"
          web_auth_cookie: "enable"
          web_portal: "enable"

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

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

Ключ

Описание

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

Spec-Zone.ru

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