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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токенов. Сгенерировано в графическом интерфейсе Fortigate.
enable_log булево	Включить/выключить протоколирование для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов несколько. Параметр, помеченный как member_path, подходит для операций с членами.
member_state строка	Добавить или удалить члена по указанному пути атрибута. Когда member_state задан, опция state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_group словарь	Настройка групп пользователей.
auth_concurrent_override строка	Включить/выключить переопределение глобального числа одновременных сессий аутентификации для этой группы пользователей. Варианты: `"enable"` `"disable"`
auth_concurrent_value целое число	Максимальное количество одновременных аутентифицированных подключений на пользователя (0 - 100).
authtimeout целое число	Тайм-аут аутентификации в минутах для этой группы пользователей. 0 — использовать глобальную настройку auth-timeout.
company строка	Установите действие для поля компании гостевого пользователя. Варианты: `"optional"` `"mandatory"` `"disabled"`
email строка	Включить/выключить поле адреса электронной почты гостевого пользователя. Варианты: `"disable"` `"enable"`
expire целое число	Время в секундах до истечения срока действия учетных записей гостевых пользователей (1 - 31536000).
expire_type строка	Определить, когда начинается отсчет до истечения срока действия. Варианты: `"immediately"` `"first-successful-login"`
group_type строка	Установите группу для аутентификации брандмауэра, FSSO, RSSO или гостевых пользователей. Варианты: `"firewall"` `"fsso-service"` `"rsso"` `"guest"`
guest список / элементы=словарь	Гостевой пользователь.
comment строка	Комментарий.
company строка	Установите действие для поля компании гостевого пользователя.
email строка	Электронная почта.
expiration строка	Время истечения срока действия.
id целое число / обязательно	ID гостевого пользователя. См. <a href=’#notes’>Примечания</a>.
mobile_phone строка	Мобильный телефон.
name строка	Имя гостевого пользователя.

password string	Пароль гостя.
sponsor string	Установите действие для поля пользователя-спонсора гостя.
user_id string	ID гостя.
http_digest_realm string	Атрибут области для аутентификации MD5-digest.
id integer	ID группы.
match list / elements=dictionary	Сопоставления групп.
group_name string	Имя совпадающего пользователя или группы на удаленном сервере аутентификации.
id integer / required	ID. см. <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-серверов или внешних IDP-серверов, которые нужно добавить в группу пользователей.
name string / required	Имя участника группы. Источник 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 / required	Имя группы.
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	Тип ID пользователя-гостя. Варианты: `"email"` `"auto-generate"` `"specify"`
user_name string	Включить/отключить ввод имени пользователя-гостя. Варианты: `"disable"` `"enable"`

vdom

string

Виртуальный домен, среди ранее определенных. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный модуль.

Default: "root"

Примечания

Примечание

Устаревший fortiosapi был заменен, httpapi — предпочтительный способ запуска playbooks
Модуль поддерживает 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 string	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при последней примененной операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name string	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom string	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_group_module.html