fortinet.fortimanager.fmgr_user_group – Настройка групп пользователей.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_user_group.
Новое в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation булево |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия отказа будут переопределены | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия успеха будут переопределены | |||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | ||
| user_group словарь | параметры верхнего уровня | |||
| auth-concurrent-override строка |
| Включить/отключить переопределение глобального числа одновременных сессий аутентификации для этой группы пользователей. | ||
| auth-concurrent-value целое число | Максимальное количество одновременных аутентифицированных подключений на пользователя (0 - 100). | |||
| authtimeout целое число | Тайм-аут аутентификации в минутах для этой группы пользователей. 0 - использовать глобальную настройку auth-timeout. | |||
| company строка |
| Установить действие для поля компании гостевого пользователя. | ||
| email строка |
| Включить/отключить поле адреса электронной почты гостевого пользователя. | ||
| expire целое число | Время в секундах до истечения срока действия учетных записей гостевых пользователей. (1 - 31536000 сек) | |||
| expire-type строка |
| Определить, когда начинается обратный отсчет срока действия. | ||
| group-type строка |
| Установить группу для аутентификации через брандмауэр, FSSO, RSSO или гостевых пользователей. | ||
| guest список / элементы=строка | нет описания | |||
| comment строка | Комментарий. | |||
| company строка | Установить действие для поля компании гостевого пользователя. | |||
| email строка | Электронная почта. | |||
| expiration строка | Время истечения срока действия. | |||
| mobile-phone строка | Мобильный телефон. | |||
| name строка | Имя гостевого пользователя. | |||
| password строка | нет описания | |||
| sponsor строка | Установить действие для поля спонсора гостевого пользователя. | |||
| user-id строка | Идентификатор гостевого пользователя. | |||
| http-digest-realm строка | Атрибут домена для аутентификации MD5-digest. | |||
| id целое число | Идентификатор группы. | |||
| match список / элементы=строка | нет описания | |||
| _gui_meta строка | нет описания | |||
| group-name строка | Имя соответствующей группы на удаленном сервере аутентификации. | |||
| id целое число | Идентификатор. | |||
| server-name строка | Имя удаленного сервера аутентификации. | |||
| max-accounts целое число | Максимальное количество учетных записей гостевых пользователей, которые могут быть созданы для этой группы (0 означает неограниченное количество). | |||
| member строка | Имена пользователей, узлов, LDAP-серверов или RADIUS-серверов для добавления в группу пользователей. | |||
| mobile-phone строка |
| Включить/отключить поле номера мобильного телефона гостевого пользователя. | ||
| multiple-guest-add строка |
| Включить/отключить добавление нескольких гостей. | ||
| name строка | Имя группы. | |||
| password строка |
| Тип пароля гостевого пользователя. | ||
| sms-custom-server строка | Сервер SMS. | |||
| sms-server строка |
| Отправка SMS через FortiGuard или другой внешний сервер. | ||
| sponsor строка |
| Установить действие для поля спонсора гостевого пользователя. | ||
| sso-attribute-value строка | Имя RADIUS-группы пользователей, которую представляет эта локальная группа пользователей. | |||
| user-id строка |
| Тип идентификатора гостевого пользователя. | ||
| user-name строка |
| Включить/отключить ввод имени гостевого пользователя. | ||
| workspace_locking_adom строка | 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 user groups.
fmgr_user_group:
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_group:
auth-concurrent-override: <value in [disable, enable]>
auth-concurrent-value: <value of integer>
authtimeout: <value of integer>
company: <value in [optional, mandatory, disabled]>
email: <value in [disable, enable]>
expire: <value of integer>
expire-type: <value in [immediately, first-successful-login]>
group-type: <value in [firewall, directory-service, fsso-service, ...]>
guest:
-
comment: <value of string>
company: <value of string>
email: <value of string>
expiration: <value of string>
mobile-phone: <value of string>
name: <value of string>
password: <value of string>
sponsor: <value of string>
user-id: <value of string>
http-digest-realm: <value of string>
id: <value of integer>
match:
-
_gui_meta: <value of string>
group-name: <value of string>
id: <value of integer>
server-name: <value of string>
max-accounts: <value of integer>
member: <value of string>
mobile-phone: <value in [disable, enable]>
multiple-guest-add: <value in [disable, enable]>
name: <value of string>
password: <value in [auto-generate, specify, disable]>
sms-custom-server: <value of string>
sms-server: <value in [fortiguard, custom]>
sponsor: <value in [optional, mandatory, disabled]>
sso-attribute-value: <value of string>
user-id: <value in [email, auto-generate, specify]>
user-name: <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_group_module.html
