модуль fortinet.fortimanager.fmgr_user_scim – Настройка записей клиентов SCIM.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.10.0

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

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Допустимые значения: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Допустимые значения: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Допустимые значения: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Допустимые значения: `"present"` `"absent"`
user_scim dictionary	Набор параметров верхнего уровня.
auth_method псевдонимы: auth-method string	Методы аутентификации клиента TLS Допустимые значения: `"token"` `"base"`
base_url псевдонимы: base-url string	URL сервера для получения запросов SCIM на создание, чтение, обновление и удаление
cascade string	Включить или отключить синхронизацию изменений пользователей и групп SCIM в IDP. Допустимые значения: `"disable"` `"enable"`
certificate list / elements=string	Сертификат для проверки клиента во время TLS-рукопожатия.
client_authentication_method псевдонимы: client-authentication-method string	Метод аутентификации клиента. Допустимые значения: `"token"` `"base"`
client_identity_check псевдонимы: client-identity-check string	Включить или отключить проверку идентификатора клиента. Допустимые значения: `"disable"` `"enable"`
client_secret_token псевдонимы: client-secret-token string	Секретный токен клиента.
id integer / обязательный	Идентификатор клиента SCIM.
name string	Имя клиента SCIM.
secret list / elements=string	Секрет для проверки токена или базовой аутентификации.
status string	Включить или отключить управление идентификацией между доменами (SCIM) Допустимые значения: `"disable"` `"enable"`
token_certificate псевдонимы: token-certificate list / elements=string	Сертификат для проверки токена.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства. В качестве значения можно указать global и другие ADOM, включая root.
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.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия сбоя или успеха также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure SCIM client entries.
      fortinet.fortimanager.fmgr_user_scim:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_scim:
          id: 0 # Required variable, integer
          # auth_method: <value in [token, base]>
          # base_url: <string>
          # certificate: <list or string>
          # client_authentication_method: <value in [token, base]>
          # client_identity_check: <value in [disable, enable]>
          # client_secret_token: <string>
          # name: <string>
          # secret: <list or string>
          # status: <value in [disable, enable]>
          # token_certificate: <list or string>
          # cascade: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–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_scim_module.html