Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

scha_cluster_get (8HA)

Name

scha_cluster_get - access cluster information

Synopsis

scha_cluster_get -O optag [-Z zone-cluster-name] [args]

Description

The scha_cluster_get command accesses and generates information about a cluster. You can access information about the cluster, nodes, host names, resource groups, resource types, and states.

The command is intended for use in shell script implementations of callback methods for resource types. These callback methods for resource types represent services that are controlled by the cluster's Resource Group Manager (RGM). This command provides the same information as the scha_resource_get() function.

This command sends output to the standard output (stdout) in formatted strings on separate lines, as described in the scha_cmds(8HA) man page. You can store the output in shell variables. You can also parse the output with shell commands such as the awk command.

Options

The following options are supported:

–O optag

The optag argument indicates the information to be accessed. Depending on the optag, an additional argument may be needed to indicate the cluster node for which information is to be retrieved.


Note -  optag options, such as NODENAME_LOCAL and NODENAME_NODEID, are not case sensitive. You can use any combination of uppercase and lowercase letters when you specify optag options.

The following optag values are supported:

ALL_LOADLIMITS

Generates on successive lines all the loadlimit names defined in the global cluster or zone cluster.

ALL_NODEIDS

Generates on successive lines the numeric node identifiers of all nodes in the cluster.

ALL_NODENAMES

Generates on successive lines the names of all nodes in the cluster.

ALL_PRIVATELINK_HOSTNAMES

Generates on successive lines the host names by which all cluster nodes are addressed on the cluster interconnect.

ALL_PSTRINGS

Generates on successive lines the names, but not the values, of all private strings in the cluster. For more information about private strings, see the clpstring(8CL) man page.

ALL_RESOURCEGROUPS

Generates on successive lines the names of all the resource groups that are being managed in the cluster.

ALL_RESOURCETYPES

Generates on successive lines the names of all the resource types that are registered in the cluster.

CLUSTERNAME

Generates the name of the cluster.

HARD_LOADLIMIT

Generates on successive lines the hard limit set for a specific limit-name for all nodes in the global cluster or zone cluster. It requires an additional unflagged string argument that is a load limit name string.

Each element of the string array output is of the format "%s=%d", where the left-side string is a nodename, and the right-side integer is the hard load limit value for the specified limit name on that node. If no hard limit is specified, the value of -1 is displayed for the hard limit.

LOADLIMIT_PROPS

Generates on successive lines the hard and soft limits (delimited by /) for all nodes in the global cluster or zone cluster. It requires an additional unflagged string argument that is a load limit name string.

Each element of the string array output is a string of the format "%s=%d/%d", where the left-side string is a nodename, the first integer is the soft limit, and the second integer is the hard limit. If no hard limit is specified, the value of -1 is displayed for the hard limit. If no soft limit is specified, the value 0 is displayed for the soft limit.

LOADLIMITS_NODE

Generates on successive lines the load limits (delimited by /) set for a specific node. It requires an additional unflagged string argument that is a load limit name string.

Each element of the string array output is a string of the format "%s=%d/%d", where the string is a limit name defined on the specified node, the first, integer is the soft limit value, and the second integer is the hard limit value. If no hard limit is specified, the value of -1 is displayed for the hard limit. If no soft limit is specified, the value 0 is displayed for the soft limit.

NODEID_LOCAL

Generates the numeric node identifier for the node where the command is executed.

NODEID_NODENAME

Generates the numeric node identifier of the node indicated by the name. Requires an additional unflagged argument that is the name of a cluster node.

NODENAME_LOCAL

Generates the name of the cluster node where the command is executed.

NODENAME_NODEID

Generates the name of the cluster node indicated by the numeric identifier. Requires an additional unflagged argument that is a numeric cluster node identifier.

NODESTATE_LOCAL

Generates UP or DOWN depending on the state of the node where the command is executed.

NODESTATE_NODE

Generates UP or DOWN depending on the state of the named node. Requires an additional unflagged argument that is the name of a cluster node.

PRIVATELINK_HOSTNAME_LOCAL

Generates the host name by which the node on which the command is run is addressed over the cluster interconnect.

PRIVATELINK_HOSTNAME_NODE

Generates the host name by which the named node is addressed on the cluster interconnect. Requires an additional unflagged argument that is the name of a cluster node.

PSTRING

Generates the clear text value of a private string. Requires an additional unflagged argument that is the name of a private string. Users other than the root user require solaris.cluster.modify authorization to use this query tag. For more information on private strings, see the clpstring(8CL) man page.

RESOURCE_SECURITY

Generates the current setting of the resource_security cluster property.

RG_FAILOVER_LOG

Generates a log of recent failover and manual switchover events for resource groups configured on the cluster. Accepts an additional unflagged argument which is an unsigned integer from 1 to 7 inclusive, indicating the number of days of history for which you want to retrieve logs. If you do not specify the number of days, the default of one day is used.

Each log entry in the output contains the following semicolon-separated fields:

resource-group-name;source-nodes;target-nodes;time-stamp
  • The source-nodes field is a comma-separated list of those nodes from which the resource group failed over or was switched manually. A source-nodes field that is empty indicates an event where the resource group was switched online manually or during a cluster boot-up.

  • The target-nodes field is a comma-separated list of those nodes to which the resource group failed over or was switched manually. A target-nodes field that is empty indicates that the resource group went offline.

  • The time-stamp value is written in ctime format. For more information about the ctime() function, see the ctime(3C)man page.

See Example 3 for a sample of RG_FAILOVER_LOG output.

SOFT_LOADLIMIT

Generates on successive lines the soft load limit set for a specific limit-name for all nodes in the cluster. It requires an additional unflagged string argument that is a load limit name string.

Each element of the string array output is of the format "%s=%d", where the left-side string is a nodename, and the right-side integer is the soft load limit value for the specified limit name on that node. If no soft limit is specified, the value of 0 is displayed for the soft limit.

SYSLOG_FACILITY

Generates the number of the syslog(3C) facility that the RGM uses for log messages. The value is 24, which corresponds to the daemon facility. You can use this value as the facility level in the logger(1) command to log messages in the cluster log.

–Z zone-cluster-name

Specifies the cluster on which you want to operate. This option is applicable when the command is executed in the global zone but needs to operate on a specified zone cluster. It cannot be used within a zone cluster to access a different zone cluster.

zone-cluster-name

Specifies that the query is to be performed in the zone cluster named zone-cluster-name.

If the –Z option is omitted, the query is performed in the cluster in which the command is executed.

Examples

Example 1 Using the scha_cluster_get Command in a Shell Script

The following shell script uses the scha_cluster_get command to print whether each cluster node is up or down:

#!/bin/sh
nodenames=`scha_cluster_get -O All_Nodenames`
for node in $nodenames
do
 state=`scha_cluster_get -O NodeState_Node $node`
 printf "State of node: %s\n exit: %d\n value: %s\n" "$node" $? "$state"
done
Example 2 Using the scha_cluster_get Command to View a Node's Load Limits

The following command displays all load limits that were defined for node node1.

# scha_cluster_get -O LOADLIMITS_NODE node1
factor1=50/100
factor2=0/4
Example 3 Using the scha_cluster_get Command to View Event Logs

The following command displays the cluster's failover and manual switchover event logs for the last three days. The output is listed in the form of resource-group-name;source-nodes;target-nodes;time-stamp.

# scha_cluster_get -O RG_FAILOVER_LOG 3
geo-infrastructure;schost1c;;Mon Jul 21 15:50:51 2014
geo-clusterstate;schost2c,schost1c;schost2c;Mon Jul 21 15:50:51 2014
oracle-rg;schost1c;;Mon Jul 21 15:58:04 2014
asm-dg-rg;schost2c,schost1c;schost2c;Mon Jul 21 15:58:04 2014
asm-inst-rg;schost2c,schost1c;schost2c;Mon Jul 21 15:58:51 2014
oracle-rg;;schost2c;Mon Jul 21 15:58:51 2014
geo-infrastructure;;schost2c;Mon Jul 21 15:59:19 2014
geo-clusterstate;schost2c;schost2c,schost1c;Mon Jul 21 16:01:51 2014
asm-inst-rg;schost2c;schost2c,schost1c;Mon Jul 21 16:02:10 2014
asm-dg-rg;schost2c;schost2c,schost1c;Mon Jul 21 16:02:10 2014
oracle-rg;schost2c;;Tue Jul 22 16:58:02 2014
oracle-rg;;schost1c;Tue Jul 22 16:59:05 2014
oracle-rg;schost1c;schost1c;Tue Jul 22 17:05:33 2014

Exit Status

The following exit status codes are returned:

0

Successful completion.

nonzero

An error occurred.

Error codes are described in scha_calls(3HA).

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
ha-cluster/developer/api
Interface Stability
Stable

See Also

awk(1), logger(1), sh(1), syslog(3C), scha_calls(3HA), scha_cluster_open(3HA), attributes(7), rg_properties(7), scha_cmds(8HA)