fortinet.fortimanager.fmgr_user_local – Настройка локальных пользователей.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_user_local
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль способен настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое |
| устанавливать в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполняться без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, по которым будут переопределены условия ошибки | ||
| rc_succeeded список / элементы=строка | список кодов rc, по которым будут переопределены условия успешного выполнения | ||
| state строка / обязательно |
| инструкция для создания, обновления или удаления объекта | |
| user_local словарь | настроенные параметры верхнего уровня | ||
| auth-concurrent-override строка |
| Включение/выключение переопределения политики policy-auth-concurrent в глобальных настройках конфигурации. | |
| auth-concurrent-value целое число | Максимальное количество одновременных входов одного пользователя. | ||
| authtimeout целое число | Время в минутах до истечения таймаута аутентификации пользователя. | ||
| email-to строка | Электронный адрес получателя двухфакторной аутентификации. | ||
| fortitoken строка | Серийный номер FortiToken получателя двухфакторной аутентификации. | ||
| id целое число | Идентификатор пользователя. | ||
| ldap-server строка | Имя сервера LDAP, с которым пользователь должен пройти аутентификацию. | ||
| name строка | Имя пользователя. | ||
| passwd строка | без описания | ||
| passwd-policy строка | Политика паролей, применяемая к пользователю, как определено в конфигурации config user password-policy. | ||
| ppk-identity строка | Идентификатор предварительно настроенного ключа IKEv2 Postquantum. | ||
| ppk-secret строка | без описания | ||
| radius-server строка | Имя сервера RADIUS, с которым пользователь должен пройти аутентификацию. | ||
| sms-custom-server строка | Сервер SMS для двухфакторной аутентификации. | ||
| sms-phone строка | Номер мобильного телефона получателя двухфакторной аутентификации. | ||
| sms-server строка |
| Отправка SMS через FortiGuard или другой внешний сервер. | |
| status строка |
| Включение/выключение возможности аутентификации локального пользователя на устройстве FortiGate. | |
| tacacs+-server строка | Имя сервера TACACS+, с которым пользователь должен пройти аутентификацию. | ||
| two-factor строка |
| Включение/выключение двухфакторной аутентификации. | |
| type строка |
| Метод аутентификации. | |
| workstation строка | Имя удаленного рабочего места пользователя, если нужно ограничить аутентификацию только с определённого рабочего места. | ||
| workspace_locking_adom строка | область, подлежащая блокировке, для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корень | ||
| 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 local users.
fmgr_user_local:
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_local:
auth-concurrent-override: <value in [disable, enable]>
auth-concurrent-value: <value of integer>
authtimeout: <value of integer>
email-to: <value of string>
fortitoken: <value of string>
id: <value of integer>
ldap-server: <value of string>
name: <value of string>
passwd: <value of string>
passwd-policy: <value of string>
ppk-identity: <value of string>
ppk-secret: <value of string>
radius-server: <value of string>
sms-custom-server: <value of string>
sms-phone: <value of string>
sms-server: <value in [fortiguard, custom]>
status: <value in [disable, enable]>
tacacs+-server: <value of string>
two-factor: <value in [disable, fortitoken, email, ...]>
type: <value in [password, radius, tacacs+, ...]>
workstation: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_local_module.html
