модуль fortinet.fortios.fortios_user_scim — Настройка записей клиентов SCIM в 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_scim.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Допустимые значения: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту участника, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции с участником.
member_state строка	Добавить или удалить участника по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Допустимые значения: `"present"` `"absent"`
state строка / обязательный	Указывает, нужно ли создать или удалить объект. Допустимые значения: `"present"` `"absent"`
user_scim словарь	Настройка записей клиентов SCIM.
auth_method строка	Методы аутентификации клиента TLS. Допустимые значения: `"token"` `"base"`
base_url строка	URL сервера для получения запросов SCIM на создание, чтение, обновление и удаление (CRUD).
cascade строка	Включить или отключить синхронизацию изменений пользователей и групп SCIM из IDP. Допустимые значения: `"disable"` `"enable"`
certificate строка	Сертификат для проверки клиента во время TLS-рукопожатия. Источник: vpn.certificate.ca.name, vpn.certificate.remote.name, certificate.ca.name, certificate.remote.name.
client_authentication_method строка	Методы аутентификации клиента TLS. Допустимые значения: `"token"` `"base"`
client_identity_check строка	Включить или отключить проверку идентификатора клиента. Допустимые значения: `"enable"` `"disable"`
client_secret_token строка	Секретный токен клиента для аутентификации.
id целое число	Идентификатор клиента SCIM.
name строка / обязательный	Имя клиента SCIM.
secret строка	Секрет для проверки токена или базовой аутентификации.
status строка	Включить или отключить System for Cross-domain Identity Management (SCIM). Допустимые значения: `"enable"` `"disable"`
token_certificate строка	Сертификат для проверки токена. Источник: vpn.certificate.remote.name, vpn.certificate.local.name.
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure SCIM client entries.
  fortinet.fortios.fortios_user_scim:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_scim:
          auth_method: "token"
          base_url: "<your_own_value>"
          cascade: "disable"
          certificate: "<your_own_value> (source vpn.certificate.ca.name vpn.certificate.remote.name certificate.ca.name certificate.remote.name)"
          client_authentication_method: "token"
          client_identity_check: "enable"
          client_secret_token: "<your_own_value>"
          id: "10"
          name: "default_name_11"
          secret: "<your_own_value>"
          status: "enable"
          token_certificate: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.local.name)"

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

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

Ключ	Описание
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_scim_module.html