модуль fortinet.fortios.fortios_user_group – Настройка групп пользователей в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные компоненты; подробные сведения см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_user_group.

Добавлено в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций пользователей и категорий групп. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0

Требования

На узле, на котором выполняется этот модуль, необходимы следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе Fortigate.
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту участника, для которого выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над участником.
member_state string	Добавить или удалить участника по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_group dictionary	Настройка групп пользователей.
auth_concurrent_override string	Включить/отключить переопределение глобального количества одновременных сеансов аутентификации для этой группы пользователей. Варианты: `"enable"` `"disable"`
auth_concurrent_value integer	Максимальное количество одновременных аутентифицированных подключений на пользователя (0–100).
authtimeout integer	Время ожидания аутентификации в минутах для этой группы пользователей. Значение 0 означает использование глобального параметра пользователя auth-timeout.
company string	Задать действие для поля компании гостевого пользователя. Варианты: `"optional"` `"mandatory"` `"disabled"`
email string	Включить/отключить поле адреса электронной почты гостевого пользователя. Варианты: `"disable"` `"enable"`
expire integer	Время в секундах до истечения срока действия учетных записей гостевых пользователей (1–31536000).
expire_type string	Определяет, когда начинается отсчет времени до истечения срока действия. Варианты: `"immediately"` `"first-successful-login"`
group_type string	Задать тип группы: для аутентификации на межсетевом экране, FSSO, RSSO или гостевых пользователей. Варианты: `"firewall"` `"fsso-service"` `"rsso"` `"guest"`
guest list / elements=dictionary	Гостевой пользователь.
comment string	Комментарий.
company string	Задать действие для поля компании гостевого пользователя.
email string
expiration string	Время истечения срока действия.
id integer / обязательный	Идентификатор гостя. см. <a href=’#notes’>Примечания</a>.
mobile_phone string	Мобильный телефон.
name string	Имя гостя.
password string	Пароль гостя.
sponsor string	Задать действие для поля спонсора гостевого пользователя.
user_id string	Идентификатор гостя.
http_digest_realm string	Атрибут realm для аутентификации с дайджестом MD5.
id integer	Идентификатор группы.
match list / elements=dictionary	Соответствия групп.
group_name string	Имя соответствующего пользователя или группы на удаленном сервере аутентификации или в SCIM.
id integer / обязательный	Идентификатор. см. <a href=’#notes’>Примечания</a>.
server_name string	Имя удаленного сервера аутентификации. Источник: user.radius.name user.ldap.name user.tacacs+.name user.saml.name user .external-identity-provider.name.
max_accounts integer	Максимальное количество гостевых учетных записей, которые можно создать для этой группы (0 означает отсутствие ограничений).
member list / elements=dictionary	Имена пользователей, узлов, серверов LDAP, серверов RADIUS или внешних серверов поставщиков удостоверений, добавляемых в группу пользователей.
name string / обязательный	Имя участника группы. Источник: user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.saml.name user .external-identity-provider.name user.adgrp.name user.pop3.name user.certificate.name.
mobile_phone string	Включить/отключить поле номера мобильного телефона гостевого пользователя. Варианты: `"disable"` `"enable"`
multiple_guest_add string	Включить/отключить добавление нескольких гостей. Варианты: `"disable"` `"enable"`
name string / обязательный	Имя группы.
password string	Тип пароля гостевого пользователя. Варианты: `"auto-generate"` `"specify"` `"disable"`
sms_custom_server string	Сервер SMS. Источник: system.sms-server.name.
sms_server string	Отправлять SMS через FortiGuard или другой внешний сервер. Варианты: `"fortiguard"` `"custom"`
sponsor string	Задать действие для поля спонсора гостевого пользователя. Варианты: `"optional"` `"mandatory"` `"disabled"`
sso_attribute_value string	Значение атрибута RADIUS.
user_id string	Тип идентификатора гостевого пользователя. Варианты: `"email"` `"auto-generate"` `"specify"`
user_name string	Включить/отключить ввод имени гостевого пользователя. Варианты: `"disable"` `"enable"`
vdom string	Виртуальный домен из числа ранее определенных. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi
Модуль поддерживает check_mode.

Примеры

- name: Configure user groups.
  fortinet.fortios.fortios_user_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_group:
          auth_concurrent_override: "enable"
          auth_concurrent_value: "0"
          authtimeout: "0"
          company: "optional"
          email: "disable"
          expire: "14400"
          expire_type: "immediately"
          group_type: "firewall"
          guest:
              -
                  comment: "Comment."
                  company: "<your_own_value>"
                  email: "<your_own_value>"
                  expiration: "<your_own_value>"
                  id: "16"
                  mobile_phone: "<your_own_value>"
                  name: "default_name_18"
                  password: "<your_own_value>"
                  sponsor: "<your_own_value>"
                  user_id: "<your_own_value>"
          http_digest_realm: "<your_own_value>"
          id: "23"
          match:
              -
                  group_name: "<your_own_value>"
                  id: "26"
                  server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name user.saml.name user.external-identity-provider
                    .name)"
          max_accounts: "0"
          member:
              -
                  name: "default_name_30 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.saml.name user
                    .external-identity-provider.name user.adgrp.name user.pop3.name user.certificate.name)"
          mobile_phone: "disable"
          multiple_guest_add: "disable"
          name: "default_name_33"
          password: "auto-generate"
          sms_custom_server: "<your_own_value> (source system.sms-server.name)"
          sms_server: "fortiguard"
          sponsor: "optional"
          sso_attribute_value: "<your_own_value>"
          user_id: "email"
          user_name: "disable"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат выполнения операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_user_group_module.html