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

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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

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

Параметры

Параметр	Комментарии
force boolean	Принудительно выполняет функцию `Stop`. Варианты: `false` ← (по умолчанию) `true`
function строка / обязательно	Функция для выполнения. Варианты: `"Start"` `"Stop"` `"RestartInstance"` `"Shutdown"` `"InstanceStart"` `"GetProcessList"` `"Bootstrap"` `"InstanceStop"` `"StopService"` `"StartService"` `"RestartService"` `"ParameterValue"` `"GetStartProfile"` `"GetTraceFile"` `"GetAlertTree"` `"GetAlerts"` `"GetEnvironment"` `"GetVersionInfo"` `"GetQueueStatistic"` `"GetInstanceProperties"` `"ListDeveloperTraces"` `"ReadDeveloperTrace"` `"ListLogFiles"` `"ReadLogFile"` `"AnalyseLogFiles"` `"ConfigureLogFileList"` `"GetLogFileList"` `"CreateSnapshot"` `"ReadSnapshot"` `"ListSnapshots"` `"DeleteSnapshots"` `"GetAccessPointList"` `"GetProcessParameter"` `"SetProcessParameter"` `"SetProcessParameter2"` `"CheckParameter"` `"OSExecute"` `"SendSignal"` `"GetCallstack"` `"GetSystemInstanceList"` `"StartSystem"` `"StopSystem"` `"RestartSystem"` `"GetSystemUpdateList"` `"UpdateSystem"` `"UpdateSCSInstance"` `"CheckUpdateSystem"` `"AccessCheck"` `"GetSecNetworkId"` `"GetNetworkId"` `"RequestLogonFile"` `"UpdateSystemPKI"` `"UpdateInstancePSE"` `"StorePSE"` `"DeletePSE"` `"CheckPSE"` `"CreatePSECredential"` `"HACheckConfig"` `"HACheckFailoverConfig"` `"HAGetFailoverConfig"` `"HAFailoverToNode"` `"HASetMaintenanceMode"` `"HACheckMaintenanceMode"` `"ABAPReadSyslog"` `"ABAPReadRawSyslog"` `"ABAPGetWPTable"` `"ABAPGetComponentList"` `"ABAPCheckRFCDestinations"` `"ABAPGetSystemWPTable"` `"J2EEControlProcess"` `"J2EEControlCluster"` `"J2EEEnableDbgSession"` `"J2EEDisableDbgSession"` `"J2EEGetProcessList"` `"J2EEGetProcessList2"` `"J2EEGetThreadList"` `"J2EEGetThreadList2"` `"J2EEGetThreadCallStack"` `"J2EEGetThreadTaskStack"` `"J2EEGetSessionList"` `"J2EEGetCacheStatistic"` `"J2EEGetCacheStatistic2"` `"J2EEGetApplicationAliasList"` `"J2EEGetComponentList"` `"J2EEControlComponents"` `"J2EEGetWebSessionList"` `"J2EEGetWebSessionList2"` `"J2EEGetEJBSessionList"` `"J2EEGetRemoteObjectList"` `"J2EEGetVMGCHistory"` `"J2EEGetVMGCHistory2"` `"J2EEGetVMHeapInfo"` `"J2EEGetClusterMsgList"` `"J2EEGetSharedTableInfo"` `"ICMGetThreadList"` `"ICMGetConnectionList"` `"ICMGetProxyConnectionList"` `"ICMGetCacheEntries"` `"WebDispGetServerList"` `"WebDispGetGroupList"` `"WebDispGetVirtHostList"` `"WebDispGetUrlPrefixList"` `"EnqGetStatistic"` `"EnqGetLockTable"` `"EnqRemoveUserLocks"` `"StartWait"` `"StopWait"` `"WaitforStarted"` `"WaitforStopped"` `"RestartServiceWait"` `"WaitforServiceStarted"` `"CheckHostAgent"`
hostname строка	Имя хоста для подключения к sapstartsrv. Может быть IP-адресом, полным доменным именем (FQDN) или именем хоста. По умолчанию: `"localhost"`
parameter строка	Параметр для передачи функции.
password строка	Пароль для подключения к sapstartsrv.
port целое число	Номер порта sapstartsrv.
sysnr строка	Номер системы экземпляра.
username строка	Имя пользователя для подключения к 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
  community.sap_libs.sap_control_exec:
    hostname: 192.168.8.15
    sysnr: "01"
    username: hdbadm
    password: test1234#
    function: ParameterValue
    parameter: ztta

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
msg строка	Сообщение об успехе с именем функции. Возвращается: всегда Пример: `"Succesful execution of: GetProcessList"`
out список / элементы=словарь	Полный вывод требуемой функции. Возвращается: всегда Пример: [{"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

строка

Сообщение об успехе с именем функции.

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

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

out

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

Полный вывод требуемой функции.

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

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