Модуль community.sap_libs.sap_user — управление сущностями пользователей в среде SAP S4/HANA

Примечание

Этот модуль входит в коллекцию community.sap_libs (версия 1.7.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.sap_libs. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.sap_libs.sap_user.

Добавлено в community.sap_libs 1.0.0

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

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

Модуль community.sap_libs.sap_user зависит от библиотеки Python pyrfc (версии 2.4.0 и выше). В зависимости от используемого дистрибутива может потребоваться установить дополнительные пакеты.
Этот модуль использует следующие BAPI для управления сущностями пользователей. - BAPI_USER_GET_DETAIL - BAPI_USER_DELETE - BAPI_USER_CREATE1 - BAPI_USER_CHANGE - BAPI_USER_ACTGROUPS_ASSIGN - BAPI_USER_PROFILES_ASSIGN - BAPI_USER_UNLOCK - BAPI_USER_LOCK

Требования

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

pyrfc >= 2.4.0

Параметры

Параметр	Комментарии
client строка	Номер клиента для подключения. Заключите значение в кавычки, чтобы сохранить ведущие нули. По умолчанию: `"000"`
company строка	Компания, к которой относится пользователь. Название компании должно быть доступно в системе SAP.
conn_password строка / обязательный	Пароль для подключения к системе SAP.
conn_username строка / обязательный	Имя пользователя для подключения к системе SAP.
email строка	Адрес электронной почты пользователя в системе SAP.
firstname строка	Имя пользователя в системе SAP.
force логическое значение	Значение должно быть `'True'`, если пароль или тип необходимо перезаписать. Варианты: `false` ← (по умолчанию) `true`
host строка / обязательный	Имя хоста системы SAP. Может быть полным доменным именем (FQDN) или IP-адресом.
lastname строка	Фамилия пользователя в системе SAP.
password строка	Пароль пользователя в системе SAP.
profiles список / элементы=строка	Назначить пользователю профили. Значения должны быть в верхнем регистре, например `'SAP_NEW'` или `'SAP_ALL'`. По умолчанию: `[""]`
roles список / элементы=строка	Назначить пользователю роли. По умолчанию: `[""]`
state строка	Действие, которое необходимо выполнить с пользователем. Варианты: `"present"` ← (по умолчанию) `"absent"` `"lock"` `"unlock"`
sysnr строка	Номер системы SAP. Заключите значение в кавычки, чтобы сохранить ведущие нули. По умолчанию: `"00"`
user_type строка	Тип пользователя в системе SAP. `'A'` — диалоговый пользователь, `'B'` — системный пользователь, `'C'` — пользователь для обмена данными, `'S'` — сервисный пользователь, `'L'` — эталонный пользователь. Значение должно быть в верхнем регистре. Варианты: `"A"` ← (по умолчанию) `"B"` `"C"` `"S"` `"L"`
useralias строка	Псевдоним пользователя в системе SAP.
username строка / обязательный	Имя пользователя.

Примечания

Примечание

Не поддерживает check_mode.

Примеры

- name: Create SAP User
  community.sap_libs.sap_user:
    conn_username: 'DDIC'
    conn_password: 'Test123'
    host: 192.168.1.150
    sysnr: '01'
    client: '000'
    state: present
    username: ADMIN
    firstname: first_admin
    lastname: last_admin
    email: admin@test.de
    password: Test123456
    useralias: ADMIN
    company: DEFAULT_COMPANY
    roles:
      - "SAP_ALL"

- name: Force change SAP User
  community.sap_libs.sap_user:
    conn_username: 'DDIC'
    conn_password: 'Test123'
    host: 192.168.1.150
    sysnr: '01'
    client: '000'
    state: present
    force: true
    username: ADMIN
    firstname: first_admin
    lastname: last_admin
    email: admin@test.de
    password: Test123456
    useralias: ADMIN
    company: DEFAULT_COMPANY
    roles:
      - "SAP_ALL"

- name: Delete SAP User
  community.sap_libs.sap_user:
    conn_username: 'DDIC'
    conn_password: 'Test123'
    host: 192.168.1.150
    sysnr: '01'
    client: '000'
    state: absent
    force: true
    username: ADMIN

- name: Unlock SAP User
  community.sap_libs.sap_user:
    conn_username: 'DDIC'
    conn_password: 'Test123'
    host: 192.168.1.150
    sysnr: '01'
    client: '000'
    state: unlock
    force: true
    username: ADMIN

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

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

Ключ	Описание
msg строка	Краткое описание выполненного действия с пользователем. Возвращается: всегда Пример: `"User ADMIN created"`
out список / элементы=словарь	Подробное описание выполненного действия с пользователем. Возвращается: при успешном выполнении Пример: `["...", {"RETURN": [{"FIELD": "BNAME", "ID": "01", "LOG_MSG_NO": "000000", "LOG_NO": "", "MESSAGE": "User ADMIN created", "MESSAGE_V1": "ADMIN", "MESSAGE_V2": "", "MESSAGE_V3": "", "MESSAGE_V4": "", "NUMBER": "102", "PARAMETER": "", "ROW": 0, "SYSTEM": "", "TYPE": "S"}], "SAPUSER_UUID_HIST": []}]`

Ключ

Описание

msg

строка

Краткое описание выполненного действия с пользователем.

Возвращается: всегда

Пример: "User ADMIN created"

out

список / элементы=словарь

Подробное описание выполненного действия с пользователем.

Возвращается: при успешном выполнении

Пример: ["...", {"RETURN": [{"FIELD": "BNAME", "ID": "01", "LOG_MSG_NO": "000000", "LOG_NO": "", "MESSAGE": "User ADMIN created", "MESSAGE_V1": "ADMIN", "MESSAGE_V2": "", "MESSAGE_V3": "", "MESSAGE_V4": "", "NUMBER": "102", "PARAMETER": "", "ROW": 0, "SYSTEM": "", "TYPE": "S"}], "SAPUSER_UUID_HIST": []}]

Авторы

Rainer Leber (@rainerleber)

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

© 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/community/sap_libs/sap_user_module.html