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

Примечание

Этот модуль является частью коллекции 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_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 строка	Номер клиента для подключения. Вы должны заключить значение в кавычки, чтобы сохранить ведущие нули. Значение по умолчанию: `"000"`
conn_password строка / обязательно	Требуемый пароль для системы SAP.
conn_username строка / обязательно	Требуемое имя пользователя для системы SAP.
host строка / обязательно	Требуемый хост для системы SAP. Может быть либо полным доменным именем, либо IP-адресом.
sysnr строка	Номер системы SAP. Вы должны заключить значение в кавычки, чтобы сохранить ведущие нули. Значение по умолчанию: `"00"`
task_parameters список / элементы=словарь	Задания и параметры для выполнения. Если список задач не требует никаких параметров, это может быть пустым. Если должны выполняться только определенные задачи из списка задач, задачи, даже если параметр не требуется, должны быть предоставлены вместе с параметром модуля task_skip=true.
FIELDNAME строка	Имя поля задачи.
TASKNAME строка / обязательно	Имя задачи в списке задач.
VALUE любое	Значение, которое должно быть установлено.
task_settings список / элементы=строка	Настройка для выполнения списка задач. Это может быть следующее, как описано в TCODE SE80. Режим проверки `CHECKRUN`, фоновая обработка активна `BATCH` (это значение по умолчанию), асинхронное выполнение `ASYNC`, режим трассировки `TRACE`, имя сервера `BATCH_TARGET`. Значение по умолчанию: `["BATCH"]`
task_skip булево	Если этот параметр `true`, не определенные задачи в task_parameters пропускаются. Это может быть в случае, когда должны выполняться только определенные задачи из списка задач. Варианты: `false` ← (по умолчанию) `true`
task_to_execute строка / обязательно	Список задач, который будет выполнен.

Примечания

Примечание

Не поддерживает 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 строка	Небольшое описание выполнения. Возвращается: всегда Пример: `"Successful"`
out список / элементы=словарь	Полное описание выполненных задач. Если это доступно. Возвращается: при успехе Пример: ["...", {"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

строка

Небольшое описание выполнения.

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

Пример: "Successful"

out

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

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

Возвращается: при успехе

Пример: ["...", {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_task_list_execute_module.html