Модуль fortinet.fortimanager.fmgr_user_group — Настройка групп пользователей.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для завершения задачи с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успешного завершения задачи.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_group словарь	Установленные параметры верхнего уровня.
auth-concurrent-override строка	Устарело, пожалуйста, переименуйте его в auth_concurrent_override. Включение/выключение переопределения глобального числа кон… Варианты: `"disable"` `"enable"`
auth-concurrent-value целое число	Устарело, пожалуйста, переименуйте его в auth_concurrent_value. Максимальное количество одновременных аутентифицированных подключений на пользователя
authtimeout целое число	Таймаут аутентификации в минутах для этой группы пользователей.
company строка	Установите действие для поля гостевого пользователя компании. Варианты: `"optional"` `"mandatory"` `"disabled"`
dynamic_mapping список / элементы=словарь	Динамическое отображение.
_scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
auth-concurrent-override строка	Устарело, пожалуйста, переименуйте его в auth_concurrent_override. Включение/выключение переопределения глобального числа… Варианты: `"disable"` `"enable"`
auth-concurrent-value целое число	Устарело, пожалуйста, переименуйте его в auth_concurrent_value. Максимальное количество одновременных аутентифицированных подключений на пользователя
authtimeout целое число	Таймаут аутентификации в минутах для этой группы пользователей.

company string	Установите действие для поля гостевого пользователя компании. Варианты: `"optional"` `"mandatory"` `"disabled"`
email string	Включить/отключить поле адреса электронной почты гостевого пользователя. Варианты: `"disable"` `"enable"`
expire integer	Время в секундах до истечения срока действия учетных записей гостевых пользователей
expire-type string	Устарело, переименуйте в expire_type. Определите, когда начинается обратный отсчет до истечения срока действия. Варианты: `"immediately"` `"first-successful-login"`
group-type string	Устарело, переименуйте в group_type. Установите группу для аутентификации брандмауэра, FSSO, RSSO или гостя … Варианты: `"firewall"` `"directory-service"` `"fsso-service"` `"guest"` `"rsso"`
guest list / elements=dictionary	Гость.
comment string	Комментарий.
company string	Установите действие для поля гостевого пользователя компании.
email string	Электронная почта.
expiration string	Время истечения срока действия.
group string	Группа.
id integer	Идентификатор гостя.
mobile-phone string	Устарело, переименуйте в mobile_phone. Мобильный телефон.
name string	Имя гостя.
password any	(list) Пароль гостя.
sponsor string	Установите действие для поля спонсора гостевого пользователя.
user-id string	Устарело, переименуйте в user_id. Идентификатор гостя.
http-digest-realm string	Устарело, переименуйте в http_digest_realm. Атрибут области для аутентификации MD5-digest.
id integer	Идентификатор группы.
ldap-memberof string	Устарело, переименуйте в ldap_memberof. Член LDAP.
logic-type string	Устарело, переименуйте в logic_type. Тип логики. Варианты: `"or"` `"and"`
match list / elements=dictionary	Соответствие.
_gui_meta string	Метаданные GUI.
group-name string	Устарело, переименуйте в group_name. Имя соответствующего пользователя или группы на удаленном сервере аутентификации.

id integer	Идентификатор.
server-name string	Устарело, переименуйте в server_name. Имя удаленного сервера аутентификации.
max-accounts integer	Устарело, переименуйте в max_accounts. Максимальное количество гостевых учетных записей, которые могут быть созданы для этой группы
member any	(список или строка) Имена пользователей, пиров, LDAP-серверов или RADIUS-серверов, которые нужно добавить в группу пользователей.
mobile-phone string	Устарело, переименуйте в mobile_phone. Включить/отключить поле номера мобильного телефона гостевого пользователя. Варианты: `"disable"` `"enable"`
multiple-guest-add string	Устарело, переименуйте в multiple_guest_add. Включить/отключить добавление нескольких гостей. Варианты: `"disable"` `"enable"`
password string	Тип пароля гостевого пользователя. Варианты: `"auto-generate"` `"specify"` `"disable"`
redir-url string	Устарело, переименуйте в redir_url. URL перенаправления.
sms-custom-server string	Устарело, переименуйте в sms_custom_server. SMS-сервер.
sms-server string	Устарело, переименуйте в sms_server. Отправка SMS через FortiGuard или другой внешний сервер. Варианты: `"fortiguard"` `"custom"`
sponsor string	Установить действие для поля спонсора гостевого пользователя. Варианты: `"optional"` `"mandatory"` `"disabled"`
sslvpn-bookmarks-group any	(список или строка) Устарело, переименуйте в sslvpn_bookmarks_group. Группа закладок SSL VPN.
sslvpn-cache-cleaner string	Устарело, переименуйте в sslvpn_cache_cleaner. Очистка кэша SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-client-check list / elements=string	Устарело, переименуйте в sslvpn_client_check. Проверка клиента SSL VPN. Варианты: `"forticlient"` `"forticlient-av"` `"forticlient-fw"` `"3rdAV"` `"3rdFW"`
sslvpn-ftp string	Устарело, переименуйте в sslvpn_ftp. SSL VPN FTP. Варианты: `"disable"` `"enable"`
sslvpn-http string	Устарело, переименуйте в sslvpn_http. SSL VPN HTTP. Варианты: `"disable"` `"enable"`
sslvpn-os-check string	Устарело, переименуйте в sslvpn_os_check. Проверка ОС SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-os-check-list dictionary	Устарело, переименуйте в sslvpn_os_check_list. Список проверок ОС SSL VPN.
action string	Действие. Варианты: `"allow"` `"check-up-to-date"` `"deny"`
latest-patch-level string	Устарело, переименуйте в latest_patch_level. Последний уровень патча.

name string	Имя.
tolerance integer	Допуск.
sslvpn-portal any	(list or str) Устарело, переименуйте в sslvpn_portal. Портал SSL VPN.
sslvpn-portal-heading string	Устарело, переименуйте в sslvpn_portal_heading. Заголовок портала SSL VPN.
sslvpn-rdp string	Устарело, переименуйте в sslvpn_rdp. RDP для SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-samba string	Устарело, переименуйте в sslvpn_samba. Samba для SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-split-tunneling string	Устарело, переименуйте в sslvpn_split_tunneling. Разделение туннелирования SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-ssh string	Устарело, переименуйте в sslvpn_ssh. SSH для SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-telnet string	Устарело, переименуйте в sslvpn_telnet. Telnet для SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-tunnel string	Устарело, переименуйте в sslvpn_tunnel. Туннель SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-tunnel-endip string	Устарело, переименуйте в sslvpn_tunnel_endip. Конечный IP туннеля SSL VPN.
sslvpn-tunnel-ip-mode string	Устарело, переименуйте в sslvpn_tunnel_ip_mode. Режим IP туннеля SSL VPN. Варианты: `"range"` `"usrgrp"`
sslvpn-tunnel-startip string	Устарело, переименуйте в sslvpn_tunnel_startip. Начальный IP туннеля SSL VPN.
sslvpn-virtual-desktop string	Устарело, переименуйте в sslvpn_virtual_desktop. Виртуальный рабочий стол SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-vnc string	Устарело, переименуйте в sslvpn_vnc. VNC для SSL VPN. Варианты: `"disable"` `"enable"`
sslvpn-webapp string	Устарело, переименуйте в sslvpn_webapp. Веб-приложение SSL VPN. Варианты: `"disable"` `"enable"`
sso-attribute-value string	Устарело, переименуйте в sso_attribute_value. Имя группы пользователей RADIUS, которую представляет эта локальная группа польз…
user-id string	Устарело, переименуйте в user_id. Тип ID гостевого пользователя. Варианты: `"email"` `"auto-generate"` `"specify"`
user-name string	Устарело, переименуйте в user_name. Включить/выключить ввод имени гостевого пользователя. Варианты: `"disable"` `"enable"`

email string	Включить/выключить поле адреса электронной почты гостевого пользователя. Choices: `"disable"` `"enable"`
expire integer	Время в секундах до истечения срока действия учетных записей гостевых пользователей.
expire-type string	Устарело, пожалуйста, переименуйте в expire_type. Определите, когда начинается обратный отсчет до истечения срока действия. Choices: `"immediately"` `"first-successful-login"`
group-type string	Устарело, пожалуйста, переименуйте в group_type. Установите группу для аутентификации брандмауэра, FSSO, RSSO или гостевых пользователей. Choices: `"firewall"` `"directory-service"` `"fsso-service"` `"guest"` `"rsso"`
guest list / elements=dictionary	Гость.
comment string	Комментарий.
company string	Установите действие для поля гостевого пользователя компании.
email string	Электронная почта.
expiration string	Время истечения срока действия.
group string	Имя гостя.
id integer	ID гостя.
mobile-phone string	Устарело, пожалуйста, переименуйте в mobile_phone. Мобильный телефон.
name string	Имя гостя.
password any	(list) Пароль гостя.
sponsor string	Установите действие для поля спонсора гостевого пользователя.
user-id string	Устарело, пожалуйста, переименуйте в user_id. ID гостя.
http-digest-realm string	Устарело, пожалуйста, переименуйте в http_digest_realm. Атрибут области для аутентификации MD5-digest.
id integer	ID группы.
match list / elements=dictionary	Соответствие.
_gui_meta string	Метаданные GUI.
group-name string	Устарело, пожалуйста, переименуйте в group_name. Имя совпадающей группы на удаленном сервере аутентификации.
id integer	ID.
server-name string	Устарело, пожалуйста, переименуйте в server_name. Имя удаленного сервера аутентификации.
max-accounts integer	Устарело, пожалуйста, переименуйте в max_accounts. Максимальное количество гостевых учетных записей, которые могут быть созданы для этой группы.
member list / elements=string	Имена пользователей, узлов, серверов LDAP или серверов RADIUS, которые нужно добавить в группу пользователей.

mobile-phone string	Устаревший параметр, пожалуйста, переименуйте его в mobile_phone. Включить/выключить поле номера мобильного телефона пользователя-гостя. Варианты: `"disable"` `"enable"`
multiple-guest-add string	Устаревший параметр, пожалуйста, переименуйте его в multiple_guest_add. Включить/выключить возможность добавления нескольких гостей. Варианты: `"disable"` `"enable"`
name string / обязательный	Имя группы.
password string	Тип пароля пользователя-гостя. Варианты: `"auto-generate"` `"specify"` `"disable"`
sms-custom-server string	Устаревший параметр, пожалуйста, переименуйте его в sms_custom_server. SMS-сервер.
sms-server string	Устаревший параметр, пожалуйста, переименуйте его в sms_server. Отправка SMS через FortiGuard или другой внешний сервер. Варианты: `"fortiguard"` `"custom"`
sponsor string	Установите действие для поля спонсора пользователя-гостя. Варианты: `"optional"` `"mandatory"` `"disabled"`
sso-attribute-value string	Устаревший параметр, пожалуйста, переименуйте его в sso_attribute_value. Название группы пользователей RADIUS, которую представляет эта локальная группа пользователей.
user-id string	Устаревший параметр, пожалуйста, переименуйте его в user_id. Тип идентификатора пользователя-гостя. Варианты: `"email"` `"auto-generate"` `"specify"`
user-name string	Устаревший параметр, пожалуйста, переименуйте его в user_name. Включить/выключить ввод имени пользователя-гостя. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM для блокировки рабочего пространства в режиме FortiManager, значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочего пространства реализована в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться сбоем, когда возвращается ненулевой rc. Вы также можете переопределить условия завершения сбоем или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_group_module.html