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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
pkg строка / обязательно	Параметр (pkg) в запрошенном URL.
pkg_authentication_rule словарь	Настройка параметров верхнего уровня.
active_auth_method строка	Устаревшее, пожалуйста, переименуйте на active_auth_method. Выбор активного метода аутентификации.
cert_auth_cookie строка	Устаревшее, пожалуйста, переименуйте на cert_auth_cookie. Включить/выключить использование сертификата устройства в качестве куки аутентификации Варианты: `"disable"` `"enable"`
comments строка	Комментарий.
cors_depth целое число	Устаревшее, пожалуйста, переименуйте на cors_depth. Глубина для разрешения доступа CORS
cors_stateful строка	Устаревшее, пожалуйста, переименуйте на cors_stateful. Включить/выключить разрешение доступа CORS Варианты: `"disable"` `"enable"`
dstaddr любой	(список или строка) Выберите IPv4 адрес назначения из доступных вариантов.
dstaddr6 любой	(список или строка) Выберите IPv6 адрес назначения из доступных вариантов.
ip_based строка	Устаревшее, пожалуйста, переименуйте на ip_based. Включить/выключить аутентификацию на основе IP. Варианты: `"disable"` `"enable"`
name строка / обязательно	Имя правила аутентификации.
protocol строка	Выбор протокола для использования в процессе аутентификации Варианты: `"http"` `"ftp"` `"socks"` `"ssh"`
srcaddr любой	(список или строка) Выберите IPv4 адрес источника из доступных вариантов.
srcaddr6 любой	(список или строка) Выберите IPv6 адрес источника.
srcintf любой	(список или строка) Входящий
sso_auth_method строка	Устаревшее, пожалуйста, переименуйте на sso_auth_method. Выбор метода single sign-on

END_OF_DOCUMENT_MARKER

status string	Включить/выключить данное правило аутентификации. Варианты: `"disable"` `"enable"`
transaction-based string	Устарело, пожалуйста, переименуйте на transaction_based. Включить/выключить аутентификацию на основе транзакций Варианты: `"disable"` `"enable"`
web-auth-cookie string	Устарело, пожалуйста, переименуйте на web_auth_cookie. Включить/выключить куки аутентификации веб-сайта Варианты: `"disable"` `"enable"`
web-portal string	Устарело, пожалуйста, переименуйте на web_portal. Включить/выключить веб-портал для политики прозрачного прокси Варианты: `"disable"` `"enable"`
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc-кодов, при которых условия будут нарушены.
rc_succeeded list / elements=integer	Список rc-кодов, при которых условия будут выполнены.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	Область, которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Authentication Rules.
      fortinet.fortimanager.fmgr_pkg_authentication_rule:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_authentication_rule:
          active_auth_method: <string>
          comments: <string>
          ip_based: <value in [disable, enable]>
          name: <string>
          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]>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_pkg_authentication_rule_module.html