NAME¶

sap_suse_cluster_connector - handle sapstartsrv cluster calls

SYNOPSIS¶

sap_suse_cluster_connector command options-and-parameters

sap_vendor_cluster_connector command options-and-parameters

DESCRIPTION¶

sap_suse_cluster_connector (or in general sap_vendor_cluster_connector) is the interface between the SAP HA cluster library and the cluster software. Currently it needs to serve calls like queries about cluster status or to request cluster resource actions.

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/start 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 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

PARAMETERS¶

SID SAP System Identifier (3 alphanum)

INO SAP Instance Number (2 digits)

ACT Cluster action "start" or "stop"

FILE Outputfile for result parsing

RES Cluster Resource Identifier

NODE Cluster Node Name

NMODE Maintenance mode

OUTPUT FIELDS¶

All param identifiers like SID might also be referenced in output formats (see detailed command description). Additionaly there are some referenced output fields, which 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)
Perform some basic tests, if the cluster software is installed and the cluster framework is started. 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 strarted?" 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.

Optionaly: This command could also implement some initializations, if needed.

Parameters None.

Return Codes
0: cluster software seams to be installed proper 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, if a given action on a SAP Instance is already running

Parameters - all parameters are mandatory.
--res RES Cluster resource to be queried
--act ACT Action type (start/stop) to be queried.

Return Codes
0: found pending action of queried type
1: did not found 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 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

fra (fire resource action)
This command fires 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 given FILE.
- One single row (data set).
- Values are separated by a colon (':').
- Format: RES:GRP:CURR_NODE:PRIO_NODES

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 /tmp/myfile00.txt –sid C11 –ino 02
Look-up for the SAP instance number 02 of the SAP system C11 and return the cluster resource name. 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 /tmp/myfile01.txt –res rsc_sap_C11_D02
Look-up for the current cluster node and all possible cluster nodes to run the cluster resource named rsc_sap_C11_D02. 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.

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

EXIT STATUS¶

See detailled descrition of the command. In general:

0 successfull command termination or "yes" to a yes-no-query

1 unsucessfull command termination or "no" to a yes-no-query

2 error occurred during command termination - mostly bad parameters

REQUIREMENTS¶

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

BUGS¶

No known bugs yet.

SEE ALSO¶

ocf_heartbeat_SAPInstance(7), ocf_suse_SAPStartSrv(7), crm(8), stonith_sbd(7), sbd(8), stonith(8), ClusterTools2(7)

AUTHOR¶

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

COPYRIGHT¶

(c) 2011-2016 SUSE Linux Products GmbH (c) 2016-2017 SUSE Linux GmbH (c) 2018-2024 SUSE LLC
sap_suse_cluster_conenctor comes with ABSOLUTELY NO WARRANTY.
For details see the GNU General Public License at http://www.gnu.org/licenses/gpl.html