293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / clinfo.1m
blob4eb59dfa9cbf0ca3d1e72cc089223071a85b58d6
1 '\" te
2 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH CLINFO 1M "Mar 12, 2002"
7 .SH NAME
8 clinfo \- display cluster information
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBclinfo\fR [\fB-nh\fR]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBclinfo\fR command displays cluster configuration information about the
19 node from which the command is executed.
20 .sp
21 .LP
22 Without arguments, \fBclinfo\fR returns an exit status of \fB0\fR if the node
23 is configured and booted as part of a cluster. Otherwise, \fBclinfo\fR returns
24 an exit status of \fB1\fR.
25 .SH OPTIONS
26 .sp
27 .LP
28 The following options are supported:
29 .sp
30 .ne 2
31 .na
32 \fB\fB-h\fR\fR
33 .ad
34 .RS 6n
35 Displays the highest node number allowed to be configured. This is different
36 from the maximum number of nodes supported in a given cluster. The current
37 highest configured node number can change immediately after the command returns
38 since new nodes can be dynamically added to a running cluster.
39 .sp
40 For example, \fBclinfo\fR \fB-h\fR might return \fB64\fR, meaning that the
41 highest number you can use to identify a node is \fB64\fR. See the \fISun
42 Cluster 3.0 System Administration Guide\fR for a description of utilities you
43 can use to determine the number of nodes in a cluster.
44 .RE
46 .sp
47 .ne 2
48 .na
49 \fB\fB-n\fR\fR
50 .ad
51 .RS 6n
52 Prints the number of the node from which \fBclinfo\fR is executed.
53 .RE
55 .SH EXIT STATUS
56 .sp
57 .LP
58 The following exit values are returned:
59 .sp
60 .ne 2
61 .na
62 \fB\fB0\fR\fR
63 .ad
64 .RS 5n
65 Successful completion.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB1\fR\fR
72 .ad
73 .RS 5n
74 An error occurred.
75 .sp
76 This is usually because the node is not configured or booted as part of a
77 cluster.
78 .RE
80 .SH SEE ALSO
81 .sp
82 .LP
83 \fBattributes\fR(5)