Spec-Zone.ru › Ansible 2.9

fortios_authentication_rule – Настройка правил аутентификации в Fortinet’s FortiOS и FortiGate

Новое в версии 2.8.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

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

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
authentication_rule
словарь
Значение по умолчанию:
null
Настройка правил аутентификации.
active_auth_method
строка
Выбор активного метода аутентификации. Источник authentication.scheme.name.
comments
строка
Комментарий.
ip_based
строка
    Варианты:
  • enable
  • disable
Включить/выключить аутентификацию по IP-адресу. После аутентификации пользователя, весь трафик с IP-адреса, с которого произошла аутентификация, разрешается.
name
строка / обязательно
Имя правила аутентификации.
protocol
строка
    Варианты:
  • http
  • ftp
  • socks
  • ssh
Выбор протокола для использования при аутентификации. Пользователи подключаются к FortiGate с использованием этого протокола и их просят пройти аутентификацию.
srcaddr
список
Выбор IPv4 адреса источника из доступных вариантов. Требуется для аутентификации веб-прокси.
name
строка / обязательно
Имя адреса. Источник firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name.
srcaddr6
список
Выбор IPv6 адреса источника. Требуется для аутентификации веб-прокси.
name
строка / обязательно
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name.
sso_auth_method
строка
Выбор метода аутентификации с единым входом (SSO). Источник authentication.scheme.name.
state
строка
    Варианты:
  • present
  • absent
Устарело
Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
status
строка
    Варианты:
  • enable
  • disable
Включить/выключить это правило аутентификации.
transaction_based
строка
    Варианты:
  • enable
  • disable
Включить/выключить аутентификацию на основе транзакций.
web_auth_cookie
строка
    Варианты:
  • enable
  • disable
Включить/выключить файлы cookie веб-аутентификации.
host
строка
IP-адрес FortiOS или FortiGate.
https
логическое
    Варианты:
  • нет
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
строка
Значение по умолчанию:
""
Пароль FortiOS или FortiGate.
ssl_verify
логическое
добавлено в 2.9
    Варианты:
  • нет
  • да ←
Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации.
state
строка
добавлено в 2.9
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перемещён на этот внешний уровень.
username
строка
Имя пользователя FortiOS или FortiGate.
vdom
строка
Значение по умолчанию:
"root"
Виртуальная область, среди тех, которые были определены ранее. Vdom — виртуальная экземпляр FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Выполняется как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure Authentication Rules.
    fortios_authentication_rule:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      authentication_rule:
        active_auth_method: "<your_own_value> (source authentication.scheme.name)"
        comments: "<your_own_value>"
        ip_based: "enable"
        name: "default_name_6"
        protocol: "http"
        srcaddr:
         -
            name: "default_name_9 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)"
        srcaddr6:
         -
            name: "default_name_11 (source firewall.address6.name firewall.addrgrp6.name)"
        sso_auth_method: "<your_own_value> (source authentication.scheme.name)"
        status: "enable"
        transaction_based: "enable"
        web_auth_cookie: "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
строка
всегда
Указание результата операции

Пример:
успешно
vdom
строка
всегда
Используемый виртуальный домен

Пример:
root
version
строка
всегда
Версия FortiGate

Пример:
v5.6.3


Статус

  • Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_authentication_rule_module.html

Spec-Zone.ru

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