fortinet.fortimanager.fmgr_user_peer – Настройка пользователей-пиров.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_user_peer.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, прежде чем использовать данные из источников данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия успешного завершения | ||
| state строка / обязательный |
| направление для создания, обновления или удаления объекта | |
| user_peer словарь | настройки параметров верхнего уровня | ||
| ca строка | Имя сертификата CA, возвращаемого командой execute vpn certificate ca list. | ||
| cn строка | Общее имя сертификата пира. | ||
| cn-type строка |
| Тип общего имени сертификата пира. | |
| ldap-mode строка |
| Режим аутентификации пира LDAP. | |
| ldap-password строка | нет описания | ||
| ldap-server строка | Имя сервера LDAP, определённого с помощью команды user ldap. Выполняет проверку прав доступа клиента. | ||
| ldap-username строка | Имя пользователя для привязки к серверу LDAP. | ||
| mandatory-ca-verify строка |
| Определяет, что произойдёт с пиром, если сертификат CA не установлен. Отключить, чтобы автоматически учитывать сертификат пи... | |
| name строка | Имя пира. | ||
| ocsp-override-server строка | Сервер протокола OCSP (Online Certificate Status Protocol) для извлечения сертификата. | ||
| passwd строка | нет описания | ||
| subject строка | Ограничения имени сертификата пира. | ||
| two-factor строка |
| Включение/выключение двухфакторной аутентификации, применяя аутентификацию на основе сертификата и пароля. | |
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout целое число | По умолчанию: 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: Configure peer users.
fmgr_user_peer:
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>
state: <value in [present, absent]>
user_peer:
ca: <value of string>
cn: <value of string>
cn-type: <value in [string, email, FQDN, ...]>
ldap-mode: <value in [password, principal-name]>
ldap-password: <value of string>
ldap-server: <value of string>
ldap-username: <value of string>
mandatory-ca-verify: <value in [disable, enable]>
name: <value of string>
ocsp-override-server: <value of string>
passwd: <value of string>
subject: <value of string>
two-factor: <value in [disable, enable]>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запросённый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа 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_user_peer_module.html
