Модуль community.sap_libs.sap_control_exec — модуль Ansible для выполнения SAPCONTROL

Примечание

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

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

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

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

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

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

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

Предоставляет поддержку sapstartsrv, ранее известного как sapcontrol
Полную информацию обо всех функциях и параметрах можно найти здесь https://www.sap.com/documents/2016/09/0a40e60d-8b7c-0010-82c7-eda71af511fa.html
Если hostname — ‘localhost’, указан sysnr и не предоставлены имя пользователя и пароль, модуль попытается использовать локальную аутентификацию через Unix-сокет (работает с повышением привилегий ‘become’).

Псевдонимы: sapcontrol

Параметры

Параметр	Комментарии
force boolean	Принудительно выполняет функцию `Stop`. Варианты: `false` ← (по умолчанию) `true`
function string / обязательный	Функция для выполнения. Варианты: `"Start"` `"Stop"` `"Shutdown"` `"InstanceStart"` `"InstanceStop"` `"Bootstrap"` `"ParameterValue"` `"GetProcessList"` `"GetProcessList2"` `"GetStartProfile"` `"GetTraceFile"` `"GetAlertTree"` `"GetAlerts"` `"RestartService"` `"StopService"` `"GetEnvironment"` `"ListDeveloperTraces"` `"ListLogFiles"` `"ReadDeveloperTrace"` `"ReadLogFile"` `"AnalyseLogFile"` `"ConfigureLogFileList"` `"GetLogFileList"` `"RestartInstance"` `"SendSignal"` `"GetVersionInfo"` `"GetQueueStatistic"` `"GetInstanceProperties"` `"OSExecute"` `"AnalyseLogFiles"` `"GetAccessPointList"` `"GetSystemInstanceList"` `"StartSystem"` `"StopSystem"` `"RestartSystem"` `"AccessCheck"` `"GetProcessParameter"` `"SetProcessParameter"` `"SetProcessParameter2"` `"ShmDetach"` `"CreateSnapshot"` `"ReadSnapshot"` `"ListSnapshots"` `"DeleteSnapshots"` `"RequestLogonFile"` `"GetNetworkId"` `"GetSecNetworkId"` `"UpdateSystem"` `"GetSystemUpdateList"` `"UpdateSCSInstance"` `"ABAPReadSyslog"` `"ABAPReadRawSyslog"` `"ABAPGetWPTable"` `"ABAPAcknoledgeAlerts"` `"CMGetThreadList"` `"ICMGetConnectionList"` `"ICMGetCacheEntries"` `"ICMGetProxyConnectionList"` `"WebDispGetServerList"` `"WebDispGetGroupList"` `"WebDispGetVirtHostList"` `"WebDispGeUrlPrefixList"` `"EnqGetLockTable"` `"EnqRemoveLocks"` `"EnqGetStatistic"`
hostname string	Имя хоста для подключения к sapstartsrv. Может быть IP-адресом, FQDN или именем хоста. По умолчанию: `"localhost"`
parameter any	Параметр, передаваемый функции. Для некоторых функций требуется определить сложные параметры. См. пример для InstanceStart.
password string	Пароль для подключения к sapstartsrv.
port integer	Номер порта sapstartsrv. Если указан, модуль всегда будет использовать HTTP-подключение вместо локального сокета.
sysnr string	Номер системы экземпляра.
username string	Имя пользователя для подключения к sapstartsrv.

Примечания

Примечание

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

Примеры

- name: GetProcessList with sysnr
  community.sap_libs.sap_control_exec:
    hostname: 192.168.8.15
    sysnr: "01"
    function: GetProcessList

- name: GetProcessList with custom port
  community.sap_libs.sap_control_exec:
    hostname: 192.168.8.15
    function: GetProcessList
    port: 50113

- name: ParameterValue with authentication
  community.sap_libs.sap_control_exec:
    hostname: 192.168.8.15
    sysnr: "01"
    username: hdbadm
    password: test1234
    function: ParameterValue
    parameter: ztta

- name: GetVersionInfo using local Unix socket (requires become)
  community.sap_libs.sap_control_exec:
    sysnr: "00"
    function: GetVersionInfo
  become: true

- name: GetProcessList using local Unix socket as SAP admin user
  community.sap_libs.sap_control_exec:
    sysnr: "00"
    function: GetProcessList
  become: true
  become_user: "{{ sap_sid | lower }}adm"

- name: InstanceStart with complex parameter
  community.sap_libs.sap_control_exec:
    sysnr: "00"
    function: InstanceStart
  become: true
  parameter:
    host: "s4hana"
    nr: "00"

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

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

Ключ	Описание
msg string	Сообщение об успешном выполнении с именем функции. Возвращается: всегда Пример: `"Succesful execution of: GetProcessList"`
out list / элементы=dictionary	Полный вывод запрошенной функции. Возвращается: всегда Пример: [{"item": [{"description": "MessageServer", "dispstatus": "SAPControl-GREEN", "elapsedtime": "412:30:50", "name": "msg_server", "pid": 70643, "starttime": "2022 03 13 15:22:42", "textstatus": "Running"}, {"description": "EnqueueServer", "dispstatus": "SAPControl-GREEN", "elapsedtime": "412:30:50", "name": "enserver", "pid": 70644, "starttime": "2022 03 13 15:22:42", "textstatus": "Running"}, {"description": "Gateway", "dispstatus": "SAPControl-GREEN", "elapsedtime": "412:30:50", "name": "gwrd", "pid": 70645, "starttime": "2022 03 13 15:22:42", "textstatus": "Running"}]}]

Ключ

Описание

msg

string

Сообщение об успешном выполнении с именем функции.

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

Пример: "Succesful execution of: GetProcessList"

out

list / элементы=dictionary

Полный вывод запрошенной функции.

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

Пример: [{"item": [{"description": "MessageServer", "dispstatus": "SAPControl-GREEN", "elapsedtime": "412:30:50", "name": "msg_server", "pid": 70643, "starttime": "2022 03 13 15:22:42", "textstatus": "Running"}, {"description": "EnqueueServer", "dispstatus": "SAPControl-GREEN", "elapsedtime": "412:30:50", "name": "enserver", "pid": 70644, "starttime": "2022 03 13 15:22:42", "textstatus": "Running"}, {"description": "Gateway", "dispstatus": "SAPControl-GREEN", "elapsedtime": "412:30:50", "name": "gwrd", "pid": 70645, "starttime": "2022 03 13 15:22:42", "textstatus": "Running"}]}]

Авторы

Rainer Leber (@RainerLeber)
Robert Kraemer (@rkpobe)

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

© 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_control_exec_module.html