7712 mandoc -Tlint does always exit with error code 0
[unleashed.git] / usr / src / man / man1m / medstat.1m
blob07c9c5599935f31692c7559e1b553e86d2b9551c
1 '\" te
2 .\" Copyright (c) 2001, 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 MEDSTAT 1M "Jan 18, 2001"
7 .SH NAME
8 medstat \- check the status of mediator hosts for a given diskset
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/sbin/medstat\fR [\fB-q\fR] \fB-s\fR \fIsetname\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 If a specified diskset has been configured for mediators, \fBmedstat\fR
19 attempts to contact these hosts to see if they are accessible and returns the
20 results of the communication.
21 .SH OPTIONS
22 .sp
23 .ne 2
24 .na
25 \fB\fB-q\fR \fR
26 .ad
27 .RS 15n
28 This optional argument disables the printing of informative text. When used
29 with \fB-q\fR, \fBmedstat\fR still prints error messages and returns a result
30 code.
31 .RE
33 .sp
34 .ne 2
35 .na
36 \fB\fB-s\fR \fB\fIsetname\fR\fR \fR
37 .ad
38 .RS 15n
39 Specifies the name of a diskset on which \fBmedstat\fR will work.
40 .RE
42 .SH EXAMPLES
43 .LP
44 \fBExample 1 \fR Checking diskset
45 .sp
46 .LP
47 This example checks the mediator hosts for the selected diskset.
49 .sp
50 .in +2
51 .nf
52 # medstat -s relo-red
53 .fi
54 .in -2
55 .sp
57 .sp
58 .LP
59 The name of the diskset is \fBrelo-red\fR. The \fBmedstat\fR command prints the
60 status for each mediator host. Additionally, if the mediator quorum is met,
61 either through a ``golden'' mediator host or because half+1 of the mediator
62 hosts respond, the exit code is 0. If the quorum is not met, then the exit code
63 is 1. If no mediator hosts have been configured for the named diskset, the exit
64 code is 2. The status field will contain one of the following values:
65 Unreachable, Bad, Fatal, or Ok, where Unreachable indicates an
66 RPC/communication problem, Bad indicates an error in the mediator data, Fatal
67 indicates any other error condition, and Ok indicates no error conditions.
69 .SH FILES
70 .sp
71 .ne 2
72 .na
73 \fB\fB/etc/lvm/meddb\fR\fR
74 .ad
75 .RS 18n
76 Contains the mediator data for a host that has been selected as a mediator
77 host.
78 .RE
80 .SH EXIT STATUS
81 .sp
82 .LP
83 The following exit values are returned:
84 .sp
85 .ne 2
86 .na
87 \fB\fB0\fR\fR
88 .ad
89 .RS 6n
90 Successful completion.
91 .RE
93 .sp
94 .ne 2
95 .na
96 \fB>0\fR
97 .ad
98 .RS 6n
99 An error occurred.
102 .SH ATTRIBUTES
105 See \fBattributes\fR(5) for descriptions of the following attributes:
110 box;
111 c | c
112 l | l .
113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
115 Interface Stability     Evolving
118 .SH SEE ALSO
121 \fBmetaclear\fR(1M), \fBmetadb\fR(1M), \fBmetadetach\fR(1M), \fBmetahs\fR(1M),
122 \fBmetainit\fR(1M), \fBmetaoffline\fR(1M), \fBmetaonline\fR(1M),
123 \fBmetaparam\fR(1M), \fBmetareplace\fR(1M), \fBmetaroot\fR(1M),
124 \fBmetaset\fR(1M), \fBmetastat\fR(1M), \fBmetasync\fR(1M), \fBmetattach\fR(1M),
125 \fBmd.cf\fR(4), \fBmd.tab\fR(4), \fBmddb.cf\fR(4), \fBmeddb\fR(4),
126 \fBmediator\fR(7D)
129 Sun Cluster documentation, \fISolaris Volume Manager Administration Guide\fR
130 .SH NOTES
133 This command is designed for use in the high availability product.