sap.sap_operations.enq_admin_locks_info module – Get information about enque server locks for ENSA2 SAP instances

Note

This module is part of the sap.sap_operations collection.

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install sap.sap_operations. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: sap.sap_operations.enq_admin_locks_info.

New in sap.sap_operations 1.29.0

Synopsis

• Get information about enque server locks for ENSA2 SAP instances

Requirements

The below requirements are needed on the host that executes this module.

• only for ENSA2 instances with enq_admin tool installed

Parameters

Parameter	Comments
argument string	Pattern for lock argument Default: "*"
client string	Pattern for client Default: "*"
hostname aliases: host string	hostname where enque process is running
n aliases: number string	Number of locks to retrieve Default: "*"
name string	Pattern for lock name Default: "*"
port integer	Port where enque process is running
profile_filepath aliases: pf, profile path	A path to the profile file Either profile_filepath or sid, hostname and port required sid, hostname and port are required together
sid string	SAP system id
user string	Pattern for user name Default: "*"

Notes

Note

• This module is community supported

• Module interface (parameters, output) expected to be stable but not guaranteed

• Module planned to be released on Ansible Automation Hub after collecting some feedback

• There is no guarantee that this module will be officially supported by Red Hat

See Also

See also

Architecture of the Standalone Enqueue Server 2

Architecture of the Standalone Enqueue Server 2

Parameter Reference of Standalone Enqueue Server 2

Parameter Reference of Standalone Enqueue Server 2

Examples

---
- name: Get information about locks from enq_admin tool for ENSA2 systems
  sap.sap_operations.enq_admin_locks_info:
    pf: /usr/sap/S4H/SYS/profile/S4H_ASCS20_s4ascsa

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
enq_admin_locks_info list / elements=dictionary	List of locks, filtered by provided parameters Returned: success Sample: [{"Argument": "0", "BCK": false, "Client": "000", "Count 1": "1", "Count 2": "0", "Name": "ANSIBLE2", "Object": "E_FILL", "Owner 1": "DIAG", "Owner 2": "", "TCODE": "SFILL", "Type": "Exclusive", "User": "FILL_USER"}, {"Argument": "O", "BCK": false, "Client": "000", "Count 1": "1", "Count 2": "0", "Name": "ANSIBLE", "Object": "E_FILL", "Owner 1": "DIAG", "Owner 2": "", "TCODE": "SFILL", "Type": "Optimistic", "User": "FILL_USER"}]
stdout string	Standard output of the enq_admin tool Returned: always Sample: "Enqueue Server 2\nLID=(17591/1714468346); RN=(300151); Current=20; Peak=30; Maximum=250000\n\nLocks:\nType;Count 1;Count 2;BCK;Object;User;Client;TCODE;Owner 1;Owner 2;Name;Argument;\nExclusive;1;0;false;E_FILL;FILL_USER;000;SFILL;DIAG;;ANSIBLE2;0;\nOptimistic;1;0;false;E_FILL;FILL_USER;000;SFILL;DIAG;;ANSIBLE;O;\n\n2024-05-03 15:36:25; OK; 'Lock List'; Response=578 usec\n===================================================================================================\n"

Authors

• Kirill Satarin (@kksat)