cmviewcl(1m) cmviewcl(1m)
NAME
cmviewcl - view information about a high availability cluster
SYNOPSIS
cmviewcl [-v] [-f format] [-s config] [-l type] [-r release]
[-c cluster_name]
[{-n node_name}... | {-p package_name}... | {-S site_name}...]
DESCRIPTION
cmviewcl displays the current status information of a cluster. Output can be displayed for the whole cluster or it may be limited to par-
ticular nodes or packages.
To view cluster information, a user must either be a superuser with effective user ID of zero (see id(1) and su(1)), or have an access pol-
icy of MONITOR allowed in the cluster configuration file, or have a policy of PACKAGE_ADMIN in a package's configuration file. See access
policy in cmquerycl(1m) or cmmakepkg(1m).
Options
cmviewcl supports the following options:
-c cluster_name Name of the cluster to view. If this option is omitted, cmviewcl will display information about the current clus-
ter that the local node belongs to.
-f format Select the output format to display. The format parameter may be one of the following values:
table This option displays a human readable tabular output format. This is the default output format if no -f is
specified on the command line.
line This option displays a machine parsable output format. Data items are displayed, one per line, in a way that
makes them easy to manipulate with tools such as grep(1) and awk(1). This option also shows additional
information not available in the table output format. Some of these are detailed under Specialized Line
Output. Please refer to cmviewcl(5) for further details.
-l type Limit the type of data displayed. If this option is specified, cmviewcl will only display information related to
type. Valid values are:
cluster Only display status or configuration information related to the cluster.
group Only display information related to groups as defined by the OPS or RAC group membership services. This
is only displayed in clusters created using Serviceguard Extension for RAC.
node Only display status or configuration related to the nodes in the cluster.
package Only display status or configuration related to the packages in the cluster.
-n node_name View information only about the specific node_name, including information about the packages that are running on
these nodes.
-p package_name View information only about the specific package_name(s).
-S site_name View information only about the specific site_name(s), the nodes assigned to the site(s), and relevant packages.
A package is considered relevant to a site if it matches any of these conditions:
1. It is a failover package and it is running on a node within the site.
2. It is a failover package, and is only configured for nodes within the site.
3. It is a system multi-node package, or it is a multi-node package and is configured for any node within the
site.
For example, consider a failover package configured for all nodes in a cluster. If it is not running on one of the
nodes in the site(s) specified with the -S option, then it will not be displayed in the output.
This option should only be used on clusters configured using an HP approved, site-aware, disaster tolerant solu-
tion on HP-UX.
-r release Make the tabular formatted output mimic that of the specified release. This option has been provided for compati-
bility with existing scripts that parse the tabular form of cmviewcl output. This option is not allowed with the
'-f line' option. It is recommended that newly created scripts utilize the line oriented output format. This
option is only available on HP-UX.
Valid values for release are:
A.11.12 or 11.12
A.11.16 or 11.16
-s config Displays only the static configuration information, not the dynamic status information. This option can only be
used when '-f line' option is also specified.
-v Verbose output will be displayed. When the tabular output has been selected, this option provides additional
detailed status information. When line oriented output has been selected, this option provides additional configu-
ration and status information.
Tabular output format
The tabular output format contains the following information:
CLUSTER Name of the cluster. This name will be used to identify the cluster.
STATUS Status of the cluster, node, package, etc. Status is either up, down, starting, halting, or unknown, unknown is a
special status that indicates insufficient information was collected to exactly determine whether the item is up
or down, e.g., when some of the nodes in the cluster cannot be reached over the network. Please see the
cmviewcl(5) manpage for more details.
GROUP Name of a group as defined by the OPS or RAC group membership services. This is only displayed in clusters cre-
ated using Serviceguard Extension for RAC
MEMBER ID number of a member of a group.
PID Process ID of the group member.
MEMBER_NODE Node on which the group member is running.
NODE Name of the node.
STATE The action that the node or package is currently taking (if any). The normal state is running. However, a node
may be reforming which means that a new node is joining the cluster, or one or more nodes have lost connection
with each other. For information on the package state, please see the cmviewcl(5) manpage.
SITE_NAME Site name to which nodes have been assigned. (HP-UX only) This is only displayed in clusters configured using an
HP approved site aware disaster tolerant solution.
Package_Weight_Default_Parameters:
This section contains the listing of default values for package weights.
NAME Weight name.
VALUE The default value for the weight. This applies to all packages unless it is overridden in the package configura-
tion file.
Quorum_Server_Status:
This section contains information on the configured quorum server for the given node.
NAME The host name or IP address of the quorum server.
STATUS Status of the quorum server; can be up or down or unknown. Status indicates whether the quorum server is avail-
able to the node as a tie breaking service.
STATE The state of the quorum server with respect to the node. The normal state is running, the cluster tie-breaking
service is available. Other states may appear as the node interacts with the quorum server.
Cluster_Lock_LUN: This section contains information on the configured lock LUN for a given node.
DEVICE Full device path name of the cluster lock LUN device as seen from the specified node.
STATUS Status of the cluster lock LUN indicates whether the cluster lock is available to the node as a tie breaking ser-
vice. Status can be up, down or unknown. It is up when the device responds as expected. It is down when the
device experiences known errors.
Cluster_Lock_LVM: This section contains information on the configured LVM lock for a given node. (This is HP-UX only.)
VOLUME_GROUP This is the path of the volume group that holds the cluster lock.
PHYSICAL_VOLUME This physical volume contains the path to the disk holding the cluster for this node.
STATUS Status of the cluster lock LVM indicates whether the cluster lock is available to the node as a tie breaking ser-
vice. Status can be up, down or unknown. It is up when the device responds as expected. It is down when the
device experiences known errors.
Network_Parameters:
This section contains the listing of the network interfaces for the given node.
INTERFACE A network interface is either a PRIMARY interface or a STANDBY interface.
NAME Name of the hardware path and interface for the network.
STATUS Status and state of the network interface. Status can be up, down, or unknown. Status indicates the current
physical status of the interface. State can only be disabled. If the interface has been disabled via the cmmod-
net command, then the state will be shown as disabled (next to status). If only status is shown, it implies that
the interface is not disabled.
Capacity_Parameters:
This section contains the listing of capacities for the given node.
NAME Capacity name.
LIMIT Maximum value for this capacity.
USED Amount of capacity used by packages on the node.
PERCENT_USED Percentage of capacity currently used.
PACKAGE Name of the package.
AUTO_RUN Value of the global switching flag for the package. Switching is either enabled or disabled. The value enabled
means that in the event of a failure, the package will automatically move to the next available node. The value
disabled means the package will not be restarted after a failure. (Formerly PKG_SWITCH)
Script_Parameters:
This section contains a listing of items specific to the package.
ITEM Service, subnet, cluster interconnect subnet(HP-UX only) or resource information for the package. Cluster inter-
connect subnet is only displayed in clusters created using Serviceguard Extension for RAC.
NAME The "value" of the item. For example, this would be a subnet address or the name of a service or resource.
MAX_RESTARTS If a service fails, this is the maximum number of times it will be attempted to be restarted (as defined by the
SERVICE_RESTART parameter in a package's RUN_SCRIPT).
RESTARTS The number of times that the service has failed and was restarted.
Node_Switching_Parameters
This section contains a listing of the nodes on which the package can run.
NODE_TYPE A node is either a PRIMARY or an ALTERNATE node.
SWITCHING Value of the node switching flag for the package. Switching is either enabled or disabled. This indicates
whether or not a package can switch to the node if a failure occurs, provided that global switching is enabled for
the package.
Policy_Parameters:
This section contains a listing of the policies that have been configured for this package. See cmmakepkg(1m) for
details of the possible package policies.
POLICY_NAME The name of the package policy being described.
CONFIGURED_VALUE The configured value of the policy described by POLICY_NAME . See cmmakepkg(1m) for details of the possible pol-
icy values.
Dependency_Parameters:
This section contains information about the current state of this package's configured dependencies on other pack-
ages within the cluster
DEPENDENCY_NAME Unique identifier for the dependency
SATISFIED May have values of yes or no.
Weight_Parameters:
This section contains the listing of weights configured for the given package.
WEIGHT_NAME Weight name. This corresponds to a node capacity of the same name.
WEIGHT_VALUE Weight value
Other_Attributes: This section contains a listing of other important attributes of the package being described
ATTRIBUTE_NAME Name of attribute.
ATTRIBUTE_VALUE The value of the Attribute described by ATTRIBUTE_NAME.
Style Style of the package can be either legacy or modular. The style describes the configuration style of
the package.
Priority Priority of the package can be either a numerical value between 1 and 3000 or "no_priority". If the
priorty is configured as no_priority or if it is not configured then the value is displayed as "no_pri-
ority".
MULTI_NODE_PACKAGES (HP-UX only)
A list of packages that can run parallel instances on multiple nodes. (Formerly SYSTEM_MULTI_NODE_PACKAGES)
UNOWNED_PACKAGES A listing of packages not currently running.
Line output format
The line output format is designed for simple machine parsing using tools such as grep(1), cut(1) or awk(1).
Each line of output is composed of the form:
name=value
The value field is a string that describes a single piece of configuration or status data related to name.
The name field uniquely identifies a single configuration or data item and is composed of one or more elements, separated by a pipe charac-
ter. In cases where the output contains multiple lines with the same type of name element, the name element is further qualified by an ele-
ment identifier.
The name element identifier is appended to the name element and separated by a colon. The name element identifier is used to distinguish
which object the configuration or status information corresponds to.
In the following example, the name element path for current package status is package|status. Since multiple package status elements are
being displayed, the package element is further qualified with the element identifiers PKG3 and PKG1 which correspond to the names of the
packages for which the status item applies.
# cmviewcl -f line -l package | grep -e status
package:PKG3|status=up
package:PKG1|status=up
When the cmviewcl command line unambiguously selects a single object, the initial name element is not included since the context has been
specified by the command. As an example:
# cmviewcl -f line -l package -p PKG1 | grep -e status
status=up
EXAMPLES
Display the current status of all packages
cmviewcl -l package
Display a detailed status of a particular package
cmviewcl -v -l package -p PKG1
Display just the current state of the cluster
cmviewcl -f line -l cluster | grep status | cut -d= -f2'
Print the name of packages that have global switching disabled
cmviewcl -v -f line | grep '^package:[^.]*.autorun=dis' | sed -e 's/^.*://' -e 's/|auto.*//'
RETURN VALUE
cmviewcl returns the following value:
0 Successful completion.
1 Command failed.
WARNINGS
In some cases, the command may fail to view the cluster configuration. Here are some possible causes:
o The node from which the command is issued is not configured in the cluster.
o The binary cluster configuration file is missing or corrupt.
o cmclconfd is missing or is corrupt or is not configured properly in the /etc/inetd.conf file (or /etc/xinetd.d directory).
o The user is not allowed access to the cluster in the security files. Version of Serviceguard earlier than A.11.16, specify access
in the node's .rhosts or cmclnodelist files. Version A.11.16 and later, prior to the existence of a cluster configuration file,
specify access in node's .rhosts or cmclnodelist files. However, once a cluster is configured, specify access in the cluster or
package configuration files.
o NOTE: When this command is run by an authorized user who is not the superuser(UID=0), only those entries that match the user run-
ning the command and the node where the command is run are displayed.
AUTHOR
cmviewcl was developed by HP.
SEE ALSO
cmhaltcl(1m), cmhaltnode(1m), cmhaltpkg(1m), cmruncl(1m), cmrunnode(1m), cmrunpkg(1m), cmquerycl(1m), cmmakepkg(1m), cmviewcl(5).
Requires Optional Serviceguard Software cmviewcl(1m)