RSiGetClusterData or RSiGetClusterDatax Subroutine

Purpose

Request that xmtopas command send the cluster aggregation data.

Library

RSI library (libSpmi.a)

Syntax

#include sys/Rsi.h
int RSiGetClusterData(rsh, cluster_stats, node_stats);
RsiHandle rsh;
Cluster_Stats **cluster_stats;
Node_Stats **node_stats;

int RSiGetClusterDatax (rshx, cluster_stats, node_stats);
RsiHandlex rshx;
Cluster_Stats **cluster_stats;
Node_Stats **node_stats;

Description

The RSiGetClusterData or RSiGetClusterDatax subroutine returns the Aggregated Statistics for a Cluster and also returns the statistics of individual nodes of the monitored cluster. This routine allocates memory for Cluster & Node statistics data structures. The count of individual nodes is available in the Cluster_Stats structure. If an error, the subroutine returns -1.

Parameters

rsh: Must point to a valid RSiHandle handle, which was previously initialized by the RSiOpen (RSiOpen or RSiOpenx Subroutine) subroutine.
rshx: Must point to a valid RSiHandlex handle, which was previously initialized by the RSiOpenx subroutine.
cluster_stats: Must be a pointer to point to a structure of type struct Cluster_Stats.
node_stats: Must be a pointer to point to a structure of type struct Node_Stats.

Return Values

If successful, the subroutine returns 0.

If an error occurs, the subroutine returns -1 and error text is placed in the RSiEMsg external character array.

Error Codes

All Remote Statistic Interface (RSI) subroutines use external variables to provide error information. To access these variables, an application program must define the following external variables:

extern char RSiEMsg[];
extern int RSiErrno;

If the subroutine returns without an error, the RSiErrno variable is set to RSiOkay and the RSiEMsg character array is empty. If an error is detected, the RSiErrno variable returns an error code, as defined in the enum RSiErrorType.

Files

: /usr/include/sys/Rsi.h Declares the subroutines, data structures, handles, and macros that an application program can use to access the RSI.