.\"Generated by nroff_template.wdt (12-Sep-06). Do NOT edit this output file. Instead, edit the source FM+SGML file.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH ovclusterinfo "" "" ""
.ds )H Hewlett-Packard Company
.ds ]L
.ds ]W June 2007
.SH NAME
ovclusterinfo - obtain information about clusters, cluster nodes, or high-availability (HA) resource groups.
.SH "SYNOPSIS"

.PP
ovclusterinfo  -h | -help 

.PP
ovclusterinfo  -v | -version 

.PP
ovclusterinfo  -a | -all 

.PP
ovclusterinfo  -c | -cluster {-ty | -type} | {-nm | -name} | {-st | -state} | {-nds | -nodes} | {-rgs | -groups} 

.PP
ovclusterinfo  -n | -node <\fInode\fR> {-id} | {-st | -state} 

.PP
ovclusterinfo  -g | -group <\fIgroup\fR> {-id} | {-st | -state} | {-ls | -localState} | {-nds | -nodes} | {-vip | -virtualIPAddress} | {-an | -activeNode} 

.SH "DESCRIPTION"

.LP
The ovclusterinfo command obtains information about high-availability clusters, and cluster nodes, and resource groups including; the name, status, and type of the cluster and, in addition, the nodes configured in the cluster. The ovclusterinfo command also obtains information about high availability (HA) Resource Groups, including; the status, IP address, and the nodes, which the Resource Group contains. An HA Resource Group is a collection of resources, such as files and processes, that are available on one node in a cluster and can be switched to another cluster node as a single entity.

.Sh "Parameters"

.LP
The ovclusterinfo command accepts the following parameters:

.TP
-h | -help

Display all options for the ovclusterinfo command.

.TP
-v | -version

Display the version of the installed command.

.TP
-c | -cluster

Displays information about the named cluster.

.TP
-a | -all

Display all available information about the named cluster, nodes, and resource groups.

.TP
-a | -node 

Display all available information about the named node in the cluster.

.TP
-g | -group 

Display information about the named high-availability resource group.

.Sh "Options"

.LP
You can use the following options with the appropriate command parameters:

.TP
-ty | -type

Display the type of cluster which is installed. Possible values are:

- Microsoft Clustering Services (Windows),

- MC/ServiceGuard (HP-UX),

- VERITAS Cluster Server (Solaris),

- Sun Cluster (Solaris),

- TRU64 Cluster (TCR),

- Red Hat Advanced Server (RHAS),

- HACMP (AIX),

- Unknown.

.TP
-nm |-name

The name of the cluster.

.TP
-st | -state

The status of the cluster on the local node. This can be one of: 

- Cluster is up

- Cluster is down

- State unknown

.TP
-nds | -nodes

Displays the names of the nodes in the cluster on separate lines. Cluster configuration determines how the node information is displayed, for example; short or long hostnames, IP address, and so on.

.TP
-rgs | -groups

All resource groups in the cluster.

.TP
-status

The status of the HA resource group, defined by \fI<rgname>\fR, on the local node.

.TP
-virtualIPaddress

The virtual IP address of the HA resource group, defined by \fI<rgname>\fR.

.TP
-nodes

The list of all nodes to which the HA resource group, defined by \fI<rgname>\fR, can fail over.

.TP
-activeNode

The node that currently hosts the HA resource group, defined by \fI<rgname>\fR.

.SH "AUTHOR"

.LP
ovclusterinfo was developed by Hewlett-Packard Company.

.SH "EXAMPLES"

.LP
The following examples show how to use the ovclusterinfo command:

.TP 3
\(bu 
To display the name of the cluster:

ovclusterinfo -cluster -name

.TP
\(bu 
To display the names of all HA resource groups in the cluster:

ovclusterinfo -cluster -groups

.TP
\(bu 
To display the virtual IP address that is configured for the HA resource group haRG:

ovclusterinfo -group haRG -virtualIPaddress

.TP
\(bu 
To display the name of the node where the HA resource group haRG is currently running.

ovclusterinfo -group haRG -activeNode
.LP

.SH "SEE ALSO"

.LP
ovappinstance, ovconfpar, ovpolicy.