sap_suse_cl...r_connector(8)

📦 version 3.1.4, in opensuse-leap 16.0

🌸 sap_suse_cluster_connector(8) — SAP High Availability 🌸

💖 NAME 💖

okay bestie, this is sap_suse_cluster_connector — the connector that handles sapstartsrv cluster calls. no cap, that's the whole name-vibe ✨

🦋 SYNOPSIS 🦋

sap_suse_cluster_connector command [options-and-parameters]

sap_vendor_cluster_connector command [options-and-parameters]

✨ DESCRIPTION ✨

So sap_suse_cluster_connector — or, more generally, sap_vendor_cluster_connector — is literally the interface between the SAP HA cluster library and the cluster software. Right now it has to serve calls like queries about cluster status or requests for cluster resource actions. main character connector energy, honestly 👑

🎀 COMMANDS 🎀

  • help or --help — print help text and usage.
  • init — check cluster installation and do some optional initialization.
  • cpa --res RES --act ACT — check for specified pending/active actions in the cluster.
  • fra --res RES --act ACT [ --nod NODE ] — fire/initiate a cluster action like start/stop/migrate a resource.
  • gvi [ --out FILE ] — get version information.
  • hcc [ --out FILE ] --sid SID --ino INO — high availability config check.
  • lsn [ --out FILE ] --res RES — list SAP nodes for the specified resource.
  • lsr [ --out FILE ] --sid SID --ino INO — list SAP resources matching the search criteria.
  • smm [ --out FILE ] --sid SID --ino INO --mod NMODE — set or get maintenance mode.

🍓 PARAMETERS 🍓

  • SID — SAP system identifier (3 alphanum)
  • INO — SAP instance number (2 digits)
  • ACT — Cluster action ("start" or "stop")
  • FILE — Output file for result parsing
  • RES — Cluster resource identifier (f.e. rsc_SAPInstance_EN2_ERS10)
  • NODE — Cluster node name
  • NMODE — Maintenance mode ("0" or "1")

🌈 OUTPUT FIELDS 🌈

All parameter identifiers like SID might also be referenced in output formats (see the detailed command description). Additionally, there are some referenced output fields that are not used as parameters:

  • GRP — Cluster Group Identifier
  • CLUSTER_NODES — List of NODE (separated with comma (,)) within the cluster that could run the resource
  • CURR_NODE — NODE which is currently running the resource
  • PRIO_NODES — Priorized List of NODE (separated with comma (,)) within the cluster that could run the resource

🔥 COMMANDS IN DETAIL 🔥

💅 init (initialize)

This is the lil' vibe check: perform some basic tests to see if the cluster software is installed and the cluster framework is started. Bestie, this is not intended to do a cluster validation. The command should only check whether the cluster commands used are available.

The check “cluster framework started?” might be ignored — maybe it does not fit for some cluster architectures. In that case, the check only needs to test the availability of the external and needed cluster commands.

Optionally, this command could also implement some initializations, if needed.

Parameters — None.

Return Codes

  • 0: cluster software seems to be installed properly and cluster framework is started on local node.
  • 1: error during detection of cluster status
  • 2: script notified bad parameters
  • 3: cluster commands are not installed correctly (missing commands)
  • 4: cluster commands are installed correctly but cluster framework is not running (optional)

Output — None.

👑 cpa (check for pending actions)

This command should check properly against the running cluster whether a given action on a SAP Instance is already running.

Parameters — all parameters are mandatory.

  • --res RES — Cluster resource to be queried
  • --act ACT [ start | stop ] — Action type to be queried.

Return Codes

  • 0: found pending action of queried type
  • 1: did not find pending action of queried type
  • 2: script notified bad parameters

Output — None.

🧚 lsr (list sap resources)

This command is used to figure out the cluster resource and optionally group name for a specific SAP system and instance.

Parameters — all parameters are mandatory.

  • --out FILE — Output file to be used.
  • --sid SID — SAP system identifier to be queried.
  • --ino INO — SAP instance number to be queried.

Return Codes

  • 0: success
  • 1: no success / internal error
  • 2: script notified bad parameters

Output — Formatted query answer to the given FILE.

  • Multiple rows (data sets) allowed even if typically there should only be one resource matching the query.
  • Each row / data set covers its values in a colon-separated (':') list.
  • Format: SID:INO:RES:GRP:CLUSTER_NODES

The format is used by multiple cluster vendors. In the SUSE implementation the fields GRP and CLUSTER_NODES are not needed. sap_suse_cluster_connector prints GRP and CLUSTER_NODES as empty fields.

💜 fra (fire resource action)

This command fires/initiates a cluster change like “stop resource XX” or “start resource XX”. It is not intended to wait till the cluster has processed the resource change. The SAP instance is specified by the cluster resource name.

Parameters — only NODE is optional.

  • --res RES — Cluster resource to be controlled.
  • --act ACT — Cluster action (start/stop/migrate) to be “fired”.
  • [ --nod NODE ] — For migrations this defines the destination node.

Return Codes

  • 0: success
  • 1: no success / internal error
  • 2: script notified bad parameters

Output — None.

🌸 lsn (list sap nodes)

This command should list the current node and a priorized list of possible cluster nodes for a specific SAP instance. In this case the SAP instance is queried by the cluster resource name.

Parameters

  • --out FILE — Output file for results.
  • --res RES — Cluster resource to be queried.

Return Codes

  • 0: success
  • 1: no success / internal error
  • 2: script notified bad parameters

Output — Formatted query answer to the given FILE.

  • One single row (data set).
  • Values are separated by a colon (':').
  • Format: RES:GRP:CURR_NODE:PRIO_NODES

🦋 smm (set maintenance mode)

Set or get maintenance mode for a specific SAP instance.

Parameters

  • --out FILE — Output file for results.
  • --sid SID — SAP system identifier.
  • --ino INO — SAP instance number.
  • --mod [ 1 | 0 | -1 ]
    • 0: set maintenance mode off
    • 1: set maintenance mode on
    • -1: get maintenance mode

Return Codes

  • 0: success
  • 1: no success / internal error
  • 2: script notified bad parameters

Output

  • 0: maintenance mode is off
  • 1: maintenance mode is on
  • 2: maintenance mode is unclear

💀 EXIT STATUS 💀

See the detailed description of the command. In general:

  • 0 — successful command termination or “yes” to a yes-no-query
  • 1 — unsuccessful command termination or “no” to a yes-no-query
  • 2 — error occurred during command termination — mostly bad parameters

🌟 EXAMPLES 🌟

  • sap_suse_cluster_connector init — Do a minor check, if the cluster framework command line interface is available.
  • sap_suse_cluster_connector lsr -out - -sid C11 -ino 02 — Look for the SAP instance number 02 of the SAP system C11 and return the cluster resource name.

E.g. C11:02:rsc_sap_C11_D02:grp_sap_C11_Dialog2:ls3198,ls3199 .

  • sap_suse_cluster_connector fra -res rsc_sap_C11_D02 -act start — Start the cluster resource rsc_sap_C11_D02. While the lsr command returned the resource name rsc_sap_C11_D02, the matching SAP instance is C11, instance number 02 (see example before).
  • sap_suse_cluster_connector cpa -res rsc_sap_C11_D02 -act start — Check, if the cluster action to start the SAP instance for system C11 and instance number 02 is already in progress.
  • sap_suse_cluster_connector lsn -out - -res rsc_sap_C11_D02 — Look for the current cluster node and all possible cluster nodes to run the cluster resource named rsc_sap_C11_D02.

E.g. rsc_sap_C11_D02:grp_sap_C11_Dialog2:ls3198:ls3198,ls3199 .

  • sapcontrol -nr 00 -function StartService EN2 — Load the sapstartsrv for EN2 instance 00. Useful to activate the HA script connector library.
  • sapcontrol -nr 00 -function HAGetFailoverConfig — Show HA configuration info for SAP instance 00. Useful to check if the HA script connector has been activated successfully.

SAP instance profile entry to use the HA script connector library:

service/halib = $(DIR_EXECUTABLE)/saphascriptco.so
service/halib_cluster_connector =
/usr/bin/sap_suse_cluster_connector

🎀 FILES 🎀

  • /usr/bin/sap_suse_cluster_connector — main connector executable
  • /usr/share/sap_suse_cluster_connector/run_checks — helper script
  • /usr/sap/$SID/$INST/work/sap_suse_cluster_connector.log — logfile of currently loaded cluster connector
  • /tmp/sapha-tmp-$PID — temporary file from connector invocation, interface to sapstartsrv

🌈 REQUIREMENTS 🌈

  • Perl 5.18 runtime environment or compatible.
  • SAP instance numbers are unique on the Linux cluster nodes.
  • Linux user <sid>adm is member of group haclient. Thus the SAP instance's sapstartsrv has sufficient permissions.
  • sap_suse_cluster_connector needs SAP's saphascriptco.so installed, configured for the SAP instances, and loaded by the respective sapstartsrv processes.
  • sap_suse_cluster_connector needs the SAPInstance RA with feature IS_ERS=true.
  • Cluster pending action logging enabled by setting record-pending=true, log entries in defined format.
  • Sufficient space and read/write permissions in the Linux /tmp filesystem.
  • Reliable access to /sapmnt/$SID and /usr/sap/$SID filesystems is crucial.
  • The connector executable's and helper script's runtime almost completely depends on call-outs to sapstartsrv and Linux cluster. The infrastructure needs to allow these call-outs to return in time.
  • No firewall rules must block any needed port.
  • No SELinux rules must block any needed action.

🙈 BUGS 🙈

In case of any problem, please use your favourite SAP support process to open a request for the component BC-OP-LNX-SUSE.

🫶 SEE ALSO 🫶

👑 AUTHOR 👑

Fabian Herschel (fabian.herschel@suse.com), Distinguished SAP Architect & Technical Manager

okay bestie, legal era — but make it cute 🎀

  • (c) 2011-2016 SUSE Linux Products GmbH
  • (c) 2016-2017 SUSE Linux GmbH
  • (c) 2018-2025 SUSE LLC

And the big one, no cap: sap_suse_cluster_conenctor comes with ABSOLUTELY NO WARRANTY. Like, none. Zero. Zip. If it breaks, that's between you and the universe 😭

For the full deets, the whole thing lives in the GNU General Public License at http://www.gnu.org/licenses/gpl.html — go read it, it's giving required reading fr fr 📜✨

and that's the whole page, bestie!! 🫶 you made it to the very end, which is honestly iconic of you 👑

this was sap_suse_cluster_connector version 3.1, dated 24 Jul 2025, and yeah — the header up top calls it sap_suse_cl...r_connector(8) because manpage titles gotta stay short and mysterious 💅

now go be a main character with your cluster, mwah 💜✨

📦 where this page comes from