community.sap_libs.sap_user 模块 – 此模块将在 SAP S4/HANA 环境中管理用户实体

注意

此模块是 community.sap_libs 集合（1.4.2 版）的一部分。

如果您正在使用 ansible 包，则您可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.sap_libs。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：community.sap_libs.sap_user。

community.sap_libs 1.0.0 中的新增功能

概要 

community.sap_libs.sap_user 模块依赖于 pyrfc Python 库（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: [email protected]
    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: [email protected]
    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": []}]`

作者

Rainer Leber (@rainerleber)