SAPHanaSR

NAME¶

SAPHanaSR-showAttr - Shows Linux cluster attributes for SAP HANA system replication.

SYNOPSIS¶

SAPHanaSR-showAttr [ --help | --version ]
SAPHanaSR-showAttr [ --sid SID ] [ --select SELECT ] [ --sort SORT ] [ --format FORMAT ] [ --cib OFFLINE_CIB_FILE [...] ] [ --from DATE ] [ --to DATE ] [ --properties PROPERTIES_FILE ]

DESCRIPTION¶

SAPHanaSR-showAttr shows Linux cluster attributes for SAP HANA system replication automation. The overall system replication (SR) state is shown as well as the HANA state on each node. Because the HANA srHook methods srConnectionChanged() and preTakeover() are used, respective information shows up as well. The information is fetched from the Linux cluster information base (CIB), not from HANA directly. Fields to be shown can be specified by pre-defined selections via command line option.

The output shows four sections, containing all or some of the listed fields:

Global section: global (Global)
sequence number of record (cib-update)
maintenance status of Linux cluster (maintenance)
filter for resource agent logging (filter)
designated coordinater node id (dcid)
HANA primary replication site (prim)
HANA secondary replication site (sec)
HANA system identifier (sid)
HANA topology (topology)
Resources section: name of Linux cluster resources (Resources)
maintenance status of Linux cluster resources (maintenance)
promotability of Linux cluster clone resources (promotable)
target role of the Linux cluster resources (target-role)
Sites section: HANA site name (Sites)
SAPHanaSR last primary timestamp (lpt)
HANA landscape status (lss)
HANA current master nameserver for that site (mns)
HANA replication operation mode (opMode)
HANA system replication status from srConnectionChanged() (srHook)
HANA system replication mode (srMode)
HANA system replication status from RA monitor (srPoll)
HANA system replication role (srr)
Hosts section: Linux hostname (Hosts)
state of the Linux cluster resource (clone_state)
actual and configured roles for HANA on that node (roles)
actual master score on that node (score)
HANA site where the host sits (site)
maintenance state of Linux cluster node (standby)
HANA system replication takeover action from preTakeover() (sra)
HANA system replication takeover action history (srah)
Linux cluster node fence status (terminate)
HANA version (version)
HANA virtual host name (vhost)

Some fields are generated dynamically from the CIB. That fields are missing, if no corresponding attribute exists, e.g. the standby field. An incomplete compilation on field details and purpose follows below.

Global - the string global

Value: global

The Global field is used as root for the whole data structure. The Global section shows overall information on the system.

Hosts - Linux hostname

Value: [ HOSTNAME ]

Hostnames of HANA nodes managed by the Linux cluster. The hostname has to follow UNIX RFC 1178. Additional rules specific to SAP apply. E.g. length of hostname is limited to 13 characters. , See also the fields remoteHost and vhost. The Hosts section shows one line per host, containing details on that host and the HANA instance there.

Resources - name of Linux cluster resources

Value: [ RESOURCENAME ]

Name of the multi-state resource controlled by SAPHanaController, occasionally also the clone resource SAPHanaTopology. The Resources section shows the HANA cluster resources and their cluster maintenance attribute´s status.

Sites - HANA site

Value: [ HANA_SITE ]

The HANA sites are detected by SAPHanaTopology. Two sites are managed by the Linux cluster. Optionally a third site could be connected thru multi-target system replication outside the cluster. The Sites section shows information on the sites known to the Linux cluster and the HANA system replication status.

clone_state - clone state of the Linux cluster resource

This variable is set by the SAPHanaController resource agent.
PROMOTED marks on scale-up the master state of an instance, which makes an HANA SR primary. On scale-out it indicates the master nameserver of the primary site.
DEMOTED makes on scale-up an HANA SR secondary. On scale-out all running nodes except the primary master nameserver are marked as DEMOTED. The DEMOTED state can be transient, on the way to promoting.
WAITING4LPA indicates potential risk of a dual primary situation. The cluster is waiting for DUPLICATE_PRIMARY_TIMEOUT seconds before registering the former HANA primary as new secondary.
WAITING4PRIM indicates the cluster is waiting for the HANA primary becoming ready in order to register the HANA secondary.
WAITING4NODES indicates on scale-out that not enough nodes are available to bring up a functional site, according to the HANA landscape configuration.
WAITING4REG indicates potential risk of a dual primary situation. The cluster is waiting for the administrator to manually register the former HANA primary as new secondary.
See also AUTOMATED_REGISTER and DUPLICATE_PRIMARY_TIMEOUT in ocf_suse_SAPHanaController(7).

maintenance - maintenance status of Linux cluster or cluster resource

Value: [ true | false ]

This is a Linux cluster node attribute. It is set by an admin. The attribute is shown after it has been changed from the default. The field might appear or disappear, depending on cluster maintenance tasks. See also the standby attribute below.

promotable - promotability of Linux cluster clone resource

Value: [ true ]

This is a Linux cluster clone resource attribute. It is set as resource configuration meta attribute. The attribute is shown after it has been changed from the default. For the SAPHanaController multi-state clone resource this has to be "true". See also ocf_suse_SAPHanaController(7).

target-role - target role of the Linux cluster promotable clone resources

Value: [ started | disabled ]

Should the resource be started or stopped (disabled) by the Linux cluster. The attribute is shown after it has been changed from the default. The field might appear or disappear, depending on cluster maintenance tasks.

filter - SAPHanaController filter for logging

Value: [ filter ]

The filter is defined by hana_<sid>_glob_filter . See ocf_suse_SAPHanaController(7) for details.

lpt - last primary timestamp

Value: [ UNIX_EPOCH | 30 | 20 | 10 | 0 ]

The node attribute lpa_<sid>_lpt or cluster attribute hana_<sid>_site_lpt_<site> is set by the SAPHanaController resource agent. When the RA detects a running HANA SR primary on the node, it records the Unix Epoch time. See section DUPLICATE_PRIMARY_TIMEOUT ocf_suse_SAPHanaController(7).
Auxiliary values are set for an HANA SR secondary. 30 means the instance is evictable for primary. 10 means: not yet ready.

lss - landscape status

Value: [ 4 | 3 | 2 | 1 | 0 ]

The site attribute lss shows the return code of HANA's landscapeHostConfiguration.py.
Value: [ 4 | 3 | 2 | 1 | 0 ]
This field contains the return code of landscapHostConfiguration.py. The parameter does not tell you if the secondary system is ready for a takeover. The meaning is different from common Linux return codes. The SAPHanaController and SAPHanaTopology RAs will interpret return code 0 as FATAL, 1 as NOT-RUNNING (or ERROR) and return codes 2+3+4 as RUNNING.
4 = OK - Everything looks perfect on the HANA primary.
3 = WARNING - An internal HANA action is ongoing, e.g. host auto-failover.
2 = INFO - The landscape is completely functional, but the actual host role differs from the configured role.
1 = DOWN - There are not enough active hosts.
0 = FATAL - Internal script error, the state could not be determined.
See landscapeHostConfiguration.py an ocf_suse_SAPHanaController(7).

mns - master nameserver

Value: [ HANA_MASTERNAMESERVER ]

The cluster attribute hana_<sid>_site_mns_<site> shows the current HANA master nameserver for the given site. It is empty for sites outside the Linux cluster.

srr - system replication role

Value: [ "P"rimary | "S"econdary | "N"one ]

The site attribute srr shows the current HANA system replication role for the given scale-out site. It is empty for sites outside the Linux cluster. For scale-up see roles sub-field B of the Hosts section.

Value: [ online | offline ]

opMode - HANA SR operations mode

Value: [ logreplay | delta_datashipping | logreplay_readaccess ]

The node attribute hana_<sid>_op_mode is set by SAPHanaTopology, according to the running HANA. The attribute is used by the SAPHanaController resource agent for setting up system replication. delta_datashipping is not recommended in the context of Linux clusters.

remoteHost - HANA SR remote host

Value: [ HOSTNAME ]

The node attribute hana_<sid>_remoteHost is set by SAPHanaTopology, according to the running HANA. The attribute is used by the SAPHanaController resource agent for setting up system replication. See also the fields Hosts and vhost.

roles - actual and configured roles for HANA on that node

The roles field in the Hosts section has four sub-fields (A:B:C:D). For scale-up that four fields should be master1:master:worker:master.

Field B: NameServer Actual Role
Value: [ master | slave | standby | shtdown ]

Field D: IndexServer Actual Role
Value: [ master | worker | slave | standby | shtdown ]

score - actual master score on that node

Value: [ 150 | 145 | 140 | 115 | 110 | 100 | 90 | 80 | 70 | 60 | 10 | 5 | 0 | -1 | -9000 | -10000 | -12200 | -22100 | -22200 | -32300 | -33333 | -INFINITY ]

This is a variable of the SAPHanaController resource agent. It is calculated based on an internal scoring table. A value of 150 should cause the Linux cluster promoting the local resource instance to HANA SR primary master nameserver. 140 indicates a HANA primary master nameserver candidate. 100 indicates the HANA secondary master nameserver. This field should not be empty.

Note: The effective resource scoring used by the Linux cluster differs from the above values because the cluster engine takes into account other factors as well.

sid - HANA system indentifier

Value: [ SID ]

The SID is the same for the pair of HANA system replication databases in the Linux cluster. Also an HANA database connected thru mulit-target replication outside the cluster has this SID.

site - HANA site where the host sits

Value: [ HANA_SITE ]

The node attribute hana_<sid>_site is set by SAPHanaTopology, according to the running HANA. The attribute is used by the SAPHanaController resource agent for setting up system replication. A dash (-) indicates the RA did not run or did not recognize the site.

srMode - HANA SR mode

Value: [ sync | syncmem ]

The node attribute hana_<sid>_glob_srmode is set by SAPHanaTopology, according to the running HANA. The attribute is used by the SAPHanaController resource agent for setting up system replication. SAP HANA knows also async and fullsync (see URLs below). Those do not make sense for automating HANA system replication by an Linux cluster.

standby - maintenance state of Linux cluster node

Value: [ on | off ]

srPoll - HANA SR status

Value: [ SOK | SFAIL | SWAIT | SREG | PRIM ]

The cluster property hana_<sid>_glob_sync_state is set by the SAPHanaController resource agent. The first three values are representing an HANA system replication status, recognized at latest RA run, see ocf_suse_SAPHanaController(7) and systemReplicationStatus.py .
The 4th value (PRIM) just indicates an HANA SR primary.

sra - HANA system replication action

Value: [ T | R | F | - ]

The node attribute system replication action is checked by the HA/DR provider susTkOver.py using the API method preTakeover(). It is set by the SAPHanaController resource agent. It indicates whether a takeover or registration is ongoing. This attribute may not be persisted in pengine files.
T = Takeover on new primary (sr_takeover) ongoing.
R = Registration on new secondary (sr_register) ongoing.
F = Takeover failed.
- = No action pending.

srah - HANA system replication action history

Value: [ T | R | F | - ]

The node attribute system replication action history stores actions in CIB attributes for later use, for root cause analysis.

srHook - HANA replication channel state, indicated by srConnectionChanged

Value: [ SOK | SFAIL | SWAIT | SREG | PRIM ]

The cluster attributes related to srHook is hana_<sid>_site_srHook_<site>. It represents the HANA SR status from HA/DR provider API method srConnectionChanged(). See SAPHanaSR(7) and SAPHanaSR-ScaleOut(7) for supported API versions and scenarios. The attribute is not updated if the cluster is not running. Thus if the cluster is shut down while HANA remains running, the content of srHook might be outdated on cluster start until the next srConnectionChanged() event. See susHanaSR.py(7) and susHanaSrMultiTarget.py(7) for details.

terminate - Linux cluster node fence status

Value: [ true ]

Indicates whether that node is requested for being fenced from outside the Linux cluster. The attribute is removed as soon as the node has been successfully fenced.

version - HANA version

Value: [ HANA_VERSION ]

Version of the HANA instance on that node. Of course, should be supported for the given Linux version. Should be same on all nodes, except during specific HANA upgrade procedure.

vhost - HANA virtual hostname

Value: [ HANA_VIRT_HOSTNAME ]

The virtual hostname is used by the HANA instance instead of Linux hostname. The node attribute hana_<sid>_vhost is set by SAPHanaTopology, according to the running HANA. The attribute is used by the SAPHanaController resource agent for setting up system replication. See also the fields Hosts and remoteHost. SAPHanaTopology needs the SAPHOSTAGENT to map from the local hostname to the HANA virtual hostname.

OPTIONS¶

--help: show help.
--version: show version.
--cib OFFLINE_CIB_FILE: read data from given offline CIB file(s).
--format FORMAT: output format. Allowed values: [ script | tables | json | tester | csv | cache ]. Default is tables.
--from FROM_DATE: point in time to show data from. Format: "YYYY-MM-DD HH:MM:SS".
--properties PROPERTIES_FILE: specify a properties file, see also SAPHanaSR-showAttr_properties(5).
--select SELECT: show selected information only. Allowed values: [ all | default | minimal | sr | cluster | cluster2 | cluster3 | sitelist | tester ]. Default is default.
--sid SID: use SAP system ID SID. Should be autodetected, if there is only one SAP HANA instance installed on the local cluster node. The SAP system ID is a 3 alphanum string with a valid SAP system name like SLE, HAE, FH1, C11, or P42.
--sort FIELD: sort Hosts section table by field. Allowed values: [ roles | site ]. Default is sort by hostnames.
--to TO_DATE: point in time to show data up to. Format: "YYYY-MM-DD HH:MM:SS".

RETURN CODES¶

0 Successful program execution.
>0 Usage, syntax or execution errors.

EXAMPLES¶

# SAPHanaSR-showAttr: show all SAPHanaSR attributes and relevant cluster maintenance states.
If the roles sub-fields are :::: landscapeHostConfiguration.py has not been able to detect the HANA roles during last recent RA monitor operation. Likely HANA was down or sudo <sid>adm failed.
# SAPHanaSR-showAttr --sort roles: show all SAPHanaSR attributes in the cluster and sort host table output by roles.
# SAPHanaSR-showAttr --sid HA1 --cib ./hb_report-17-07-2019/grauenstein01/cib.xml: show all SAPHanaSR attributes for SAP System ID HA1 and instance number 10 from given CIB file.
# SAPHanaSR-showAttr | grep -e master: -e worker: -e slave:: show SAPHanaSR promotion scores on running nodes.
# SAPHanaSR-showAttr --format script | egrep -v '/(version|op_mode|vhost|remoteHost|site)=' | SAPHanaSR-showAttr --path2table: reduce output to selected fields.
# watch -n9 "crm_mon -1r --include=none,nodes,resources,failures;echo; \: SAPHanaSR-showAttr;cs_clusterstate -i|grep -v '#'"
display comprehensive overview on Linux cluster and HANA resources, update every nine seconds.

FILES¶

/usr/bin/SAPHanaSR-showAttr: the program itself.
/usr/lib/SAPHanaSR-angi/: needed libraries.
/usr/sap/hostctrl/exe/saphostctrl: the SAP host control command.

REQUIREMENTS¶

* Attribute names shall not contain the underscore "_", except attribute name "clone_state".

BUGS¶

Formatting and content of this script's output will change, since this script is under development.
In case of any problem, please use your favourite SAP support process to open a request for the component BC-OP-LNX-SUSE. Please report any other feedback and suggestions to feedback@suse.com.

AUTHORS¶

A.Briel, F.Herschel, L.Pinne.

COPYRIGHT¶

(c) 2014 SUSE Linux Products GmbH, Germany.
(c) 2015-2017 SUSE Linux GmbH, Germany.
(c) 2018-2025 SUSE LLC
SAPHanaSR-showAttr comes with ABSOLUTELY NO WARRANTY.
For details see the GNU General Public License at http://www.gnu.org/licenses/gpl.html

06 Feb 2025

Source file:	SAPHanaSR-showAttr.8.en.gz (from SAPHanaSR-angi 1.2.10-160000.1.2)
Source last updated:	2025-03-07T17:39:26Z
Converted to HTML:	2025-04-28T10:08:24Z