Skip to content

Commit

Permalink
add sapcontrol (#2)
Browse files Browse the repository at this point in the history 
* add sapcontrol
  • Loading branch information
@rainerleber
rainerleber authored May 17, 2022
1 parent bcf6e6d commit ce1facc
Show file tree
Hide file tree
Showing 3 changed files with 519 additions and 0 deletions.
1 change: 1 addition & 0 deletions plugins/modules/sapcontrol.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
system/sapcontrol.py
389 changes: 389 additions & 0 deletions plugins/modules/system/sapcontrol.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,389 @@
#!/usr/bin/python

# Copyright: (c) 2022, Rainer Leber [email protected], [email protected],
# Robert Kraemer @rkpobe, [email protected]
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

DOCUMENTATION = r'''
---
module: sapcontrol
short_description: Manages SAPCONTROL
version_added: "1.1.0"
description:
- Provides support for sapstartsrv formaly known as sapcontrol
- A complete information of all functions and the parameters can be found here
U(https://www.sap.com/documents/2016/09/0a40e60d-8b7c-0010-82c7-eda71af511fa.html)
options:
sysnr:
description:
- The system number of the instance.
required: false
type: str
port:
description:
- The port number of the sapstartsrv.
required: false
type: int
username:
description:
- The username to connect to the sapstartsrv.
required: false
type: str
password:
description:
- The password to connect to the sapstartsrv.
required: false
type: str
hostname:
description:
- The hostname to connect to the sapstartsrv.
- Could be an IP address, FQDN or hostname.
required: false
default: localhost
type: str
function:
description:
- The function to execute.
required: true
choices:
- 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
type: str
parameter:
description:
- The parameter to pass to the function.
required: false
type: str
force:
description:
- Forces the execution of the function C(Stop).
required: false
default: false
type: bool
author:
- Rainer Leber (@RainerLeber)
- Robert Kraemer (@rkpobe)
notes:
- Does not support C(check_mode).
'''

EXAMPLES = r"""
- name: GetProcessList with sysnr
community.sap_libs.sapcontrol:
hostname: 192.168.8.15
sysnr: "01"
function: GetProcessList
- name: GetProcessList with custom port
community.sap_libs.sapcontrol:
hostname: 192.168.8.15
function: GetProcessList
port: 50113
- name: ParameterValue
community.sap_libs.sapcontrol:
hostname: 192.168.8.15
sysnr: "01"
username: hdbadm
password: test1234#
function: ParameterValue
parameter: ztta
"""

RETURN = r'''
msg:
description: Success-message with functionname.
type: str
returned: always
sample: 'Succesful execution of: GetProcessList'
out:
description: The full output of the required function.
type: list
elements: dict
returned: always
sample: [{
"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"
}
]
}]
'''

from ansible.module_utils.basic import AnsibleModule, missing_required_lib
import traceback
try:
from suds.client import Client
from suds.sudsobject import asdict
except ImportError:
HAS_SUDS_LIBRARY = False
SUDS_LIBRARY_IMPORT_ERROR = traceback.format_exc()
else:
HAS_SUDS_LIBRARY = True


def choices():
retlist = ["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']
return retlist


# converts recursively the suds object to a dictionary e.g. {'item': [{'name': hdbdaemon, 'value': '1'}]}
def recursive_dict(suds_object):
out = {}
if isinstance(suds_object, str):
return suds_object
for k, v in asdict(suds_object).items():
if hasattr(v, '__keylist__'):
out[k] = recursive_dict(v)
elif isinstance(v, list):
out[k] = []
for item in v:
if hasattr(item, '__keylist__'):
out[k].append(recursive_dict(item))
else:
out[k].append(item)
else:
out[k] = v
return out


def connection(hostname, port, username, password, function, parameter):
url = 'http://{0}:{1}/sapcontrol?wsdl'.format(hostname, port)
client = Client(url, username=username, password=password)
_function = getattr(client.service, function)
if parameter is not None:
result = _function(parameter)
else:
result = _function()

return result


def main():
module = AnsibleModule(
argument_spec=dict(
sysnr=dict(type='str', required=False),
port=dict(type='int', required=False),
username=dict(type='str', required=False),
password=dict(type='str', no_log=True, required=False),
hostname=dict(type='str', default="localhost"),
function=dict(type='str', required=True, choices=choices()),
parameter=dict(type='str', required=False),
force=dict(type='bool', default=False),
),
required_one_of=[('sysnr', 'port')],
mutually_exclusive=[('sysnr', 'port')],
supports_check_mode=False,
)
result = dict(changed=False, msg='', out={}, error='')
params = module.params

sysnr = params['sysnr']
port = params['port']
username = params['username']
password = params['password']
hostname = params['hostname']
function = params['function']
parameter = params['parameter']
force = params['force']

if not HAS_SUDS_LIBRARY:
module.fail_json(
msg=missing_required_lib('suds'),
exception=SUDS_LIBRARY_IMPORT_ERROR)

if function == "Stop":
if force is False:
module.fail_json(msg="Stop function requires force: True")

if port is None:
try:
try:
conn = connection(hostname, "5{0}14".format((sysnr).zfill(2)), username, password, function, parameter)
except Exception:
conn = connection(hostname, "5{0}13".format((sysnr).zfill(2)), username, password, function, parameter)
except Exception as err:
result['error'] = str(err)
else:
try:
conn = connection(hostname, port, username, password, function, parameter)
except Exception as err:
result['error'] = str(err)

if result['error'] != '':
result['msg'] = 'Something went wrong connecting to the SAPCONTROL SOAP API.'
module.fail_json(**result)

returned_data = recursive_dict(conn)

result['changed'] = True
result['msg'] = "Succesful execution of: " + function
result['out'] = [returned_data]

module.exit_json(**result)


if __name__ == '__main__':
main()
Loading

0 comments on commit ce1facc

Please sign in to comment.