Модуль community.sap_libs.sap_task_list_execute — выполнение списка задач SAP

Примечание

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

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

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

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

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

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

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

Модуль community.sap_libs.sap_task_list_execute зависит от библиотеки Python pyrfc (версии 2.4.0 и выше). В зависимости от используемого дистрибутива может потребоваться установить дополнительные пакеты.
Задачи в списке, требующие ручного выполнения, будут подтверждены автоматически.
Этот модуль использует RFC-пакет STC_TM_API.

Требования

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

pyrfc >= 2.4.0
xmltodict

Параметры

Параметр	Комментарии
client string	Номер клиента для подключения. Значение необходимо заключить в кавычки, чтобы сохранить начальные нули. По умолчанию: `"000"`
conn_password string / обязательный	Необходимый пароль для системы SAP.
conn_username string / обязательный	Необходимое имя пользователя для системы SAP.
host string / обязательный	Необходимый хост системы SAP. Может быть полным доменным именем (FQDN) или IP-адресом.
sysnr string	Номер системы SAP. Значение необходимо заключить в кавычки, чтобы сохранить начальные нули. По умолчанию: `"00"`
task_parameters list / элементы=словарь	Задачи и параметры для выполнения. Если для списка задач не требуются параметры, это значение может быть пустым. Если необходимо выполнить только определенные задачи из списка, нужно указать эти задачи, даже если для них не требуются параметры, и задать параметр модуля task_skip=true.
FIELDNAME string	Имя поля задачи.
TASKNAME string / обязательный	Имя задачи в списке задач.
VALUE any	Значение, которое необходимо задать.
task_settings list / элементы=строка	Настройки выполнения списка задач. Это могут быть параметры, описанные для TCODE SE80: режим проверки `CHECKRUN`, активная фоновая обработка `BATCH` (значение по умолчанию), асинхронное выполнение `ASYNC`, режим трассировки `TRACE`, имя сервера `BATCH_TARGET`. По умолчанию: `["BATCH"]`
task_skip boolean	Если для этого параметра задано значение `true`, задачи, не указанные в task_parameters, пропускаются. Это может потребоваться, если из списка задач нужно выполнить только определенные задачи. Варианты: `false` ← (по умолчанию) `true`
task_to_execute string / обязательный	Список задач, который будет выполнен.

Примечания

Примечание

Не поддерживает check_mode. Всегда возвращает, что состояние изменилось.

Примеры

# Pass in a message
- name: Test task execution
  community.sap_libs.sap_task_list_execute:
    conn_username: DDIC
    conn_password: Passwd1234
    host: 10.1.8.10
    sysnr: '01'
    client: '000'
    task_to_execute: SAP_BASIS_SSL_CHECK
    task_settings: batch

- name: Pass in input parameters
  community.sap_libs.sap_task_list_execute:
    conn_username: DDIC
    conn_password: Passwd1234
    host: 10.1.8.10
    sysnr: '00'
    client: '000'
    task_to_execute: SAP_BASIS_SSL_CHECK
    task_parameters :
      - { 'TASKNAME': 'CL_STCT_CHECK_SEC_CRYPTO', 'FIELDNAME': 'P_OPT2', 'VALUE': 'X' }
      - TASKNAME: CL_STCT_CHECK_SEC_CRYPTO
        FIELDNAME: P_OPT3
        VALUE: X
    task_settings: batch

# Exported environment variables
- name: Hint if module will fail with error message like ImportError libsapnwrfc.so...
  community.sap_libs.sap_task_list_execute:
    conn_username: DDIC
    conn_password: Passwd1234
    host: 10.1.8.10
    sysnr: '00'
    client: '000'
    task_to_execute: SAP_BASIS_SSL_CHECK
    task_settings: batch
  environment:
    SAPNWRFC_HOME: /usr/local/sap/nwrfcsdk
    LD_LIBRARY_PATH: /usr/local/sap/nwrfcsdk/lib

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

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

Ключ	Описание
msg string	Краткое описание выполнения. Возвращается: всегда Пример: `"Successful"`
out list / элементы=словарь	Полное описание выполненных задач, если оно доступно. Возвращается: при успешном выполнении Пример: ["...", {"LOG": {"STCTM_S_LOG": [{"ACTIVITY": "U_CONFIG", "ACTIVITY_DESCR": "Configuration changed", "DETAILS": null, "EXEC_ID": "20210728184903.815739", "FIELD": null, "ID": "STC_TASK", "LOG_MSG_NO": "000000", "LOG_NO": null, "MESSAGE": "For radiobutton group ICM too many options are set; choose only one option", "MESSAGE_V1": "ICM", "MESSAGE_V2": null, "MESSAGE_V3": null, "MESSAGE_V4": null, "NUMBER": "048", "PARAMETER": null, "PERIOD": "M", "PERIOD_DESCR": "Maintenance", "ROW": "0", "SRC_LINE": "170", "SRC_OBJECT": "CL_STCTM_REPORT_UI IF_STCTM_UI_TASK~SET_PARAMETERS", "SYSTEM": null, "TIMESTMP": "20210728184903", "TSTPNM": "DDIC", "TYPE": "E"}, "..."]}}]

Ключ

Описание

msg

string

Краткое описание выполнения.

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

Пример: "Successful"

out

list / элементы=словарь

Полное описание выполненных задач, если оно доступно.

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

Пример: ["...", {"LOG": {"STCTM_S_LOG": [{"ACTIVITY": "U_CONFIG", "ACTIVITY_DESCR": "Configuration changed", "DETAILS": null, "EXEC_ID": "20210728184903.815739", "FIELD": null, "ID": "STC_TASK", "LOG_MSG_NO": "000000", "LOG_NO": null, "MESSAGE": "For radiobutton group ICM too many options are set; choose only one option", "MESSAGE_V1": "ICM", "MESSAGE_V2": null, "MESSAGE_V3": null, "MESSAGE_V4": null, "NUMBER": "048", "PARAMETER": null, "PERIOD": "M", "PERIOD_DESCR": "Maintenance", "ROW": "0", "SRC_LINE": "170", "SRC_OBJECT": "CL_STCTM_REPORT_UI IF_STCTM_UI_TASK~SET_PARAMETERS", "SYSTEM": null, "TIMESTMP": "20210728184903", "TSTPNM": "DDIC", "TYPE": "E"}, "..."]}}]

Авторы

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_task_list_execute_module.html