fortinet.fortimanager.fmgr_sys_login_challenge — Ответ на вопрос проверки входа, используемый после команды login/user или login/challenge.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_sys_login_challenge.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль способен настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием, исходя из данных источников.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed list / elements=string | список кодов rc, при которых условия будут считаться выполненными | ||
| rc_succeeded list / elements=string | список кодов rc, при которых условия будут считаться выполненными | ||
| sys_login_challenge dictionary | установленные параметры верхнего уровня | ||
| answer string | Ответ на вопрос проверки входа из предыдущего запроса. | ||
| session string | Идентификатор сессии, возвращенный командой login/user или предыдущей командой login/challenge. | ||
| workspace_locking_adom string | домен, который нужно заблокировать для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout integer | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область | |
Примечания
Примечание
- В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия завершения ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Answer a log in challenge question, used following a login/user or login/challenge command.
fmgr_sys_login_challenge:
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, ...]
sys_login_challenge:
answer: <value of string>
session: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_sys_login_challenge_module.html
