sap.sap_operations.ha_get_failoverconfig_info module – Run sap host agent function HAGetFailoverConfig

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

New in sap.sap_operations 1.16.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_get_failoverconfig_info
  sap.sap_operations.ha_get_failoverconfig_info:
    instance_number: "00"

Return Values

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

Key	Description
ha_get_failoverconfig_info dictionary	Result of HAGetFailoverConfig method execution on host with SAP HANA installed Returned: success Sample: {"HAActive": true, "HAActiveNode": "s4hana09", "HADocumentation": "https://github.com/ClusterLabs/sap_cluster_connector", "HANodes": "s4hana09", "HAProductVersion": "Pacemaker", "HASAPInterfaceVersion": "sap_cluster_connector"}
HAActive string	HA active Returned: success Sample: "TRUE"
HAActiveNode string	HA active node Returned: success Sample: "s4hana09"
HADocumentation string	HA documentation Returned: success Sample: "https://github.com/ClusterLabs/sap_cluster_connector"
HAProductVersion string	HA product version Returned: success Sample: "Pacemaker"
HASAPInterfaceVersion string	HA SAP interface version Returned: success Sample: "sap_cluster_connector"

Authors

• Kirill Satarin (@kksat)

• Ondra Machacek (@machacekondra)