Spec-Zone.ru › Ansible

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

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Создаётся в GUI Fortigate.

authentication_rule

dictionary

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

active_auth_method

string

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

cert_auth_cookie

string

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

Choices:

  • "enable"
  • "disable"

comments

string

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

cors_depth

integer

Глубина для разрешения доступа CORS.

cors_stateful

string

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

Choices:

  • "enable"
  • "disable"

dstaddr

list / elements=dictionary

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

name

string / required

Имя адреса. Источник 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 / required

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

ip_based

string

Включить/выключить IP-based аутентификацию. При включении, ранее аутентифицированные пользователи с того же IP адреса будут освобождены.

Choices:

  • "enable"
  • "disable"

name

string / required

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

protocol

string

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

Choices:

  • "http"
  • "ftp"
  • "socks"
  • "ssh"

srcaddr

list / elements=dictionary

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

name

string / required

Имя адреса. Источник 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 / required

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

srcintf

list / elements=dictionary

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

name

string / required

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

sso_auth_method

string

Выбор метода аутентификации Single Sign-On (SSO). Источник authentication.scheme.name.

status

string

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

Варианты:

  • "enable"
  • "disable"

transaction_based

string

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

Варианты:

  • "enable"
  • "disable"

web_auth_cookie

string

Включить/выключить куки аутентификации веб-сайта.

Варианты:

  • "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 — предпочтительный способ выполнения playbooks
  • Модуль поддерживает режим 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"
          srcaddr:
              -
                  name: "default_name_16 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          srcaddr6:
              -
                  name: "default_name_18 (source firewall.address6.name firewall.addrgrp6.name)"
          srcintf:
              -
                  name: "default_name_20 (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

строка

Номер сборки образа Fortigate

Возвращается: всегда

Пример: "1547"

http_method

строка

Последний метод, используемый для предоставления контента в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

строка

Последний результат, предоставленный FortiGate по последней применённой операции

Возвращается: всегда

Пример: "200"

mkey

строка

Главный ключ (id), используемый в последнем вызове FortiGate

Возвращается: успех

Пример: "id"

name

строка

Имя таблицы, используемой для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

строка

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

Возвращается: всегда

Пример: "webfilter"

revision

строка

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

строка

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

Возвращается: всегда

Пример: "success"

vdom

строка

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

строка

Версия 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_authentication_rule_module.html

Spec-Zone.ru

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