Модуль fortinet.fortimanager.fmgr_user_group — настройка групп пользователей.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_group.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах указаны все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых переопределяются условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, для которых переопределяются условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
user_group dictionary | Набор параметров верхнего уровня. |
|
auth_concurrent_override псевдонимы: auth-concurrent-override string |
Включить/отключить переопределение глобального числа одновременных сеансов аутентификации для этой группы пользователей. Варианты:
|
|
auth_concurrent_value псевдонимы: auth-concurrent-value integer |
Максимальное количество одновременных аутентифицированных подключений на пользователя |
|
authtimeout integer |
Тайм-аут аутентификации в минутах для этой группы пользователей. |
|
company string |
Задать действие для поля компании гостевого пользователя. Варианты:
|
|
dynamic_mapping list / elements=dictionary |
Динамическое сопоставление. |
|
_scope list / elements=dictionary |
Область действия. |
|
name string |
Имя. |
|
vdom string |
VDOM. |
|
auth_concurrent_override псевдонимы: auth-concurrent-override string |
Включить/отключить переопределение глобального числа одновременных сеансов аутентификации для этой группы пользователей. Варианты:
|
|
auth_concurrent_value псевдонимы: auth-concurrent-value integer |
Максимальное количество одновременных аутентифицированных подключений на пользователя |
|
authtimeout integer |
Тайм-аут аутентификации в минутах для этой группы пользователей. |
|
company string |
Задать действие для поля компании гостевого пользователя. Варианты:
|
|
string |
Включить/отключить поле адреса электронной почты гостевого пользователя. Варианты:
|
|
expire integer |
Время в секундах до истечения срока действия учетных записей гостевых пользователей |
|
expire_type псевдонимы: expire-type string |
Определяет, когда начинается отсчет времени до истечения срока действия. Варианты:
|
|
group_type псевдонимы: group-type string |
Задать тип группы: для аутентификации на межсетевом экране, FSSO, RSSO или гостевых пользователей. Варианты:
|
|
guest list / elements=dictionary |
Гость. |
|
comment string |
Комментарий. |
|
company string |
Задать действие для поля компании гостевого пользователя. |
|
string |
|
|
expiration string |
Время истечения срока действия. |
|
group string |
Группа. |
|
id integer |
ID гостя. |
|
mobile_phone псевдонимы: mobile-phone string |
Мобильный телефон. |
|
name string |
Имя гостя. |
|
password any |
(список) Пароль гостя. |
|
sponsor string |
Задать действие для поля спонсора гостевого пользователя. |
|
user_id псевдонимы: user-id string |
ID гостя. |
|
http_digest_realm псевдонимы: http-digest-realm string |
Атрибут области для аутентификации с дайджестом MD5. |
|
id integer |
ID группы. |
|
ldap_memberof псевдонимы: ldap-memberof string |
Членство в группах LDAP. |
|
logic_type псевдонимы: logic-type string |
Тип логики. Варианты:
|
|
match list / elements=dictionary |
Соответствие. |
|
_gui_meta string |
Метаданные графического интерфейса. |
|
group_name псевдонимы: group-name string |
Имя соответствующего пользователя или группы на удаленном сервере аутентификации. |
|
id integer |
ID. |
|
server_name псевдонимы: server-name string |
Имя удаленного сервера аутентификации. |
|
max_accounts псевдонимы: max-accounts integer |
Максимальное количество гостевых учетных записей, которые можно создать для этой группы |
|
member any | (список или строка) Имена пользователей, узлов, LDAP-серверов или RADIUS-серверов, которые следует добавить в группу пользователей. |
|
mobile_phone псевдонимы: mobile-phone string |
Включить/отключить поле номера мобильного телефона гостевого пользователя. Варианты:
|
|
multiple_guest_add псевдонимы: multiple-guest-add string |
Включить/отключить добавление нескольких гостей. Варианты:
|
|
negate string |
Инвертировать. Варианты:
|
|
password string |
Тип пароля гостевого пользователя. Варианты:
|
|
redir_url псевдонимы: redir-url string |
URL перенаправления. |
|
sms_custom_server псевдонимы: sms-custom-server string |
SMS-сервер. |
|
sms_server псевдонимы: sms-server string |
Отправлять SMS через FortiGuard или другой внешний сервер. Варианты:
|
|
sponsor string |
Задать действие для поля спонсора гостевого пользователя. Варианты:
|
|
sslvpn_bookmarks_group aliases: sslvpn-bookmarks-group any |
(list or str) Группа закладок SSL VPN. |
|
sslvpn_cache_cleaner aliases: sslvpn-cache-cleaner string |
Очистка кэша SSL VPN. Варианты:
|
|
sslvpn_client_check aliases: sslvpn-client-check list / elements=string |
Проверка клиента SSL VPN. Варианты:
|
|
sslvpn_ftp aliases: sslvpn-ftp string |
FTP через SSL VPN. Варианты:
|
|
sslvpn_http aliases: sslvpn-http string |
HTTP через SSL VPN. Варианты:
|
|
sslvpn_os_check aliases: sslvpn-os-check string |
Проверка ОС для SSL VPN. Варианты:
|
|
sslvpn_os_check_list aliases: sslvpn-os-check-list dictionary |
Список проверок ОС для SSL VPN. |
|
action string |
Действие. Варианты:
|
|
latest_patch_level aliases: latest-patch-level string |
Последний уровень исправлений. |
|
name string |
Имя. |
|
tolerance integer |
Допуск. |
|
sslvpn_portal aliases: sslvpn-portal any |
(list or str) Портал SSL VPN. |
|
sslvpn_portal_heading aliases: sslvpn-portal-heading string |
Заголовок портала SSL VPN. |
|
sslvpn_rdp aliases: sslvpn-rdp string |
RDP через SSL VPN. Варианты:
|
|
sslvpn_samba aliases: sslvpn-samba string |
Samba через SSL VPN. Варианты:
|
|
sslvpn_split_tunneling aliases: sslvpn-split-tunneling string |
Раздельное туннелирование SSL VPN. Варианты:
|
|
sslvpn_ssh aliases: sslvpn-ssh string |
SSH через SSL VPN. Варианты:
|
|
sslvpn_telnet aliases: sslvpn-telnet string |
Telnet через SSL VPN. Варианты:
|
|
sslvpn_tunnel aliases: sslvpn-tunnel string |
Туннель SSL VPN. Варианты:
|
|
sslvpn_tunnel_endip aliases: sslvpn-tunnel-endip string |
Конечный IP-адрес туннеля SSL VPN. |
|
sslvpn_tunnel_ip_mode aliases: sslvpn-tunnel-ip-mode string |
Режим IP-адреса туннеля SSL VPN. Варианты:
|
|
sslvpn_tunnel_startip aliases: sslvpn-tunnel-startip string |
Начальный IP-адрес туннеля SSL VPN. |
|
sslvpn_virtual_desktop aliases: sslvpn-virtual-desktop string |
Виртуальный рабочий стол SSL VPN. Варианты:
|
|
sslvpn_vnc aliases: sslvpn-vnc string |
VNC через SSL VPN. Варианты:
|
|
sslvpn_webapp aliases: sslvpn-webapp string |
Веб-приложение SSL VPN. Варианты:
|
|
sso_attribute_value aliases: sso-attribute-value string |
Имя группы пользователей RADIUS, которую представляет эта локальная группа пользователей. |
|
user_id aliases: user-id string |
Тип идентификатора гостевого пользователя. Варианты:
|
|
user_name aliases: user-name string |
Включить/отключить поле ввода имени гостевого пользователя. Варианты:
|
|
string |
Включить/отключить поле адреса электронной почты гостевого пользователя. Варианты:
|
|
expire integer |
Время в секундах до истечения срока действия учетных записей гостевых пользователей. |
|
expire_type aliases: expire-type string |
Определяет, когда начинается отсчет времени до истечения срока действия. Варианты:
|
|
group_type aliases: group-type string |
Указывает, предназначена ли группа для аутентификации на межсетевом экране, FSSO, RSSO или гостевых пользователей. Варианты:
|
|
guest list / elements=dictionary |
Гость. |
|
comment string |
Комментарий. |
|
company string |
Задает действие для поля компании гостевого пользователя. |
|
string |
|
|
expiration string |
Время истечения срока действия. |
|
group string |
Имя гостя. |
|
id integer |
Идентификатор гостя. |
|
mobile_phone aliases: mobile-phone string |
Мобильный телефон. |
|
name string |
Имя гостя. |
|
password any |
(list) Пароль гостя. |
|
sponsor string |
Задает действие для поля спонсора гостевого пользователя. |
|
user_id aliases: user-id string |
Идентификатор гостя. |
|
http_digest_realm aliases: http-digest-realm string |
Атрибут области для аутентификации с дайджестом MD5. |
|
id integer |
Идентификатор группы. |
|
logic_type aliases: logic-type string |
Задает логику между участниками или совпадающими записями. Варианты:
|
|
match list / elements=dictionary |
Сопоставление. |
|
_gui_meta string |
Метаданные графического интерфейса. |
|
group_name aliases: group-name string |
Имя совпадающей группы на удаленном сервере аутентификации. |
|
id integer |
Идентификатор. |
|
server_name aliases: server-name string |
Имя удаленного сервера аутентификации. |
|
max_accounts aliases: max-accounts integer |
Максимальное количество гостевых учетных записей, которые можно создать для этой группы |
|
member list / elements=string |
Имена пользователей, узлов, серверов LDAP или серверов RADIUS, добавляемых в группу пользователей. |
|
mobile_phone псевдонимы: mobile-phone строка |
Включить или отключить поле номера мобильного телефона гостевого пользователя. Варианты:
|
|
multiple_guest_add псевдонимы: multiple-guest-add строка |
Включить или отключить добавление нескольких гостей. Варианты:
|
|
name строка / обязательный |
Имя группы. |
|
negate строка |
Отрицание. Варианты:
|
|
password строка |
Тип пароля гостевого пользователя. Варианты:
|
|
sms_custom_server псевдонимы: sms-custom-server строка |
Сервер SMS. |
|
sms_server псевдонимы: sms-server строка |
Отправлять SMS через FortiGuard или другой внешний сервер. Варианты:
|
|
sponsor строка |
Задать действие для поля спонсора гостевого пользователя. Варианты:
|
|
sso_attribute_value псевдонимы: sso-attribute-value строка |
Имя группы пользователей RADIUS, которую представляет эта локальная группа пользователей. |
|
user_id псевдонимы: user-id строка |
Тип идентификатора гостевого пользователя. Варианты:
|
|
user_name псевдонимы: user-name строка |
Включить или отключить ввод имени гостевого пользователя. Варианты:
|
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global и другие значения, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчеркиваний (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании выводятся предупреждения об устаревании. Чтобы отключить эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого кода rc. Условия завершения с ошибкой или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure user groups.
fortinet.fortimanager.fmgr_user_group:
bypass_validation: false
adom: FortiCarrier
state: present
user_group:
id: 1
name: ansible-test-group
password: specify # <value in [auto-generate, specify, disable]>
user_id: email # <value in [email, auto-generate, specify]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the user groups
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_group"
params:
adom: "ansible"
group: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_user_group_module.html