sap.sap_operations.ha_check_config_info module – Run sap host agent function HACheckConfig

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.ha_check_config_info.

New in sap.sap_operations 1.14.0

Synopsis

  • Collect information about installed SAP instances on the host

  • SAP start framework is used to collect information and perform actions from host level

Requirements

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

  • python >= 3.6

  • pyrfc >= 2.7.0

Parameters

Parameter

Comments

ca_file

path

ca_file - path to file with CA certificate to secure the communication. if not provided system CA store is used.

Required if security is set to custom

hostname

string

hostname of the SAP system, will be used to connect to SAP host agent web services

Parameters username password and hostname should be provided together.

instance_number

string

Instance number

Default: "00"

password

string

password of the OS user that will connect to SAP host agent web services (sapadm, or <sid>adm, or any other user with necessary permissions

Parameters username password and hostname should be provided together.

security

string

Parameter security specifies how secure communication should be enforced.

By default system CA (certification authority) store is used (parameter value is system).

If custom CA (certification authority) has to be used, parameter ca_file should be set to path to CA public certificate.

If set to none https communication is possible, but server certificate will not be checked for trust.

Choices:

  • "system" ← (default)

  • "custom"

  • "none"

username

string

username of the OS user that will connect to SAP host agent web services (sapadm, or <sid>adm, or any other user with necessary permissions)

Parameters username password and hostname should be provided together.

Examples

- name: Run ha_check_config_info
  sap.sap_operations.ha_check_config_info:
    instance_number: "00"

Return Values

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

Key

Description

ha_check_config_info

list / elements=dictionary

Result of HACheckConfig method execution on host with SAP HANA installed

Returned: success

Sample: [{"category": "SAPControl-SAP-CONFIGURATION", "comment": "0 ABAP instances detected", "description": "Redundant ABAP instance configuration", "state": "SAPControl-HA-SUCCESS"}, {"category": "SAPControl-SAP-CONFIGURATION", "comment": "0 Java instances detected", "description": "Redundant Java instance configuration", "state": "SAPControl-HA-SUCCESS"}, {"category": "SAPControl-SAP-CONFIGURATION", "comment": "All Enqueue server separated from application server", "description": "Enqueue separation", "state": "SAPControl-HA-SUCCESS"}, {"category": "SAPControl-SAP-CONFIGURATION", "comment": "All MessageServer separated from application server", "description": "MessageServer separation", "state": "SAPControl-HA-SUCCESS"}]

Authors

  • Kirill Satarin (@kksat)

  • Ondra Machacek (@machacekondra)