модуль fortinet.fortimanager.fmgr_pkg_authentication_rule — Настройка правил аутентификации.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_pkg_authentication_rule.

Добавлено в fortinet.fortimanager 2.1.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
pkg string / обязательный	Параметр (pkg) в запрашиваемом URL.
pkg_authentication_rule dictionary	Набор параметров верхнего уровня.
active_auth_method псевдонимы: active-auth-method string	Выберите активный метод аутентификации.
cert_auth_cookie псевдонимы: cert-auth-cookie string	Включить/отключить использование сертификата устройства в качестве cookie аутентификации Варианты: `"disable"` `"enable"`
comments string	Комментарий.
cors_depth псевдонимы: cors-depth integer	Глубина разрешенного доступа CORS
cors_stateful псевдонимы: cors-stateful string	Включить/отключить разрешение доступа CORS Варианты: `"disable"` `"enable"`
dstaddr any	(список или строка) Выберите IPv4-адрес назначения из доступных вариантов.
dstaddr6 any	(список или строка) Выберите IPv6-адрес назначения из доступных вариантов.
form_auth_fallback псевдонимы: form-auth-fallback string	Резервный вариант аутентификации через форму. Варианты: `"disable"` `"enable"`
ip_based псевдонимы: ip-based string	Включить/отключить аутентификацию на основе IP-адреса. Варианты: `"disable"` `"enable"`
name string / обязательный	Имя правила аутентификации.
protocol string	Выберите протокол для аутентификации Варианты: `"http"` `"ftp"` `"socks"` `"ssh"` `"ztna-portal"`
session_logout псевдонимы: session-logout string	Включить/отключить выход пользователя из текущего сеанса. Варианты: `"disable"` `"enable"`
srcaddr any	(список или строка) Выберите IPv4-адрес источника из доступных вариантов.
srcaddr6 any	(список или строка) Выберите IPv6-адрес источника.
srcintf any	(список или строка) Входящий интерфейс
sso_auth_method псевдонимы: sso-auth-method string	Выберите метод единого входа
status string	Включить/отключить это правило аутентификации. Варианты: `"disable"` `"enable"`
transaction_based псевдонимы: transaction-based string	Включить/отключить аутентификацию на основе транзакций Варианты: `"disable"` `"enable"`
web_auth_cookie псевдонимы: web-auth-cookie string	Включить/отключить cookie веб-аутентификации Варианты: `"disable"` `"enable"`
web_portal псевдонимы: web-portal string	Включить/отключить веб-портал для прозрачной политики прокси-сервера Варианты: `"disable"` `"enable"`
web_proxy псевдонимы: web-proxy any	(список) Веб-прокси.
proposed_method string	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие варианты, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчёркивания (snake_case). Измените такие аргументы, как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout обеспечивают эту возможность.
Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure Authentication Rules.
      fortinet.fortimanager.fmgr_pkg_authentication_rule:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_authentication_rule:
          name: "your value" # Required variable, string
          # active_auth_method: <string>
          # comments: <string>
          # ip_based: <value in [disable, enable]>
          # protocol: <value in [http, ftp, socks, ...]>
          # srcaddr: <list or string>
          # srcaddr6: <list or string>
          # sso_auth_method: <string>
          # status: <value in [disable, enable]>
          # transaction_based: <value in [disable, enable]>
          # web_auth_cookie: <value in [disable, enable]>
          # web_portal: <value in [disable, enable]>
          # dstaddr: <list or string>
          # dstaddr6: <list or string>
          # srcintf: <list or string>
          # cors_depth: <integer>
          # cors_stateful: <value in [disable, enable]>
          # cert_auth_cookie: <value in [disable, enable]>
          # form_auth_fallback: <value in [disable, enable]>
          # web_proxy: <list or string>
          # session_logout: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при определённых условиях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_pkg_authentication_rule_module.html