Invalid error code when using multipathd CLI
[multipath-tools/.git] / mpathpersist / mpathpersist.8
1 .\" ----------------------------------------------------------------------------
2 .\" Update the date below if you make any significant change.
3 .\" Make sure there are no errors with:
4 .\" groff -z -wall -b -e -t mpathpersist/mpathpersist.8
5 .\"
6 .\" ----------------------------------------------------------------------------
7 .
8 .TH MPATHPERSIST 8 2016-10-30 "Linux"
9 .
10 .
11 .\" ----------------------------------------------------------------------------
12 .SH NAME
13 .\" ----------------------------------------------------------------------------
14 .
15 mpathpersist \- Manages SCSI persistent reservations on dm multipath devices.
16 .
17 .
18 .\" ----------------------------------------------------------------------------
19 .SH SYNOPSIS
20 .\" ----------------------------------------------------------------------------
21 .
22 .B mpathpersist
23 .RB [\| OPTIONS \|]
24 .I device
25 .
26 .
27 .\" ----------------------------------------------------------------------------
28 .SH DESCRIPTION
29 .\" ----------------------------------------------------------------------------
30 .
31 This utility is used to manage SCSI persistent reservations on Device Mapper
32 Multipath devices. To be able to use this functionality, the \fIreservation_key\fR
33 attribute must be defined in the \fI/etc/multipath.conf\fR file. Otherwise the
34 \fBmultipathd\fR daemon will not check for persistent reservation for newly
35 discovered paths or reinstated paths.
36 .
37 .
38 .\" ----------------------------------------------------------------------------
39 .SH OPTIONS
40 .\" ----------------------------------------------------------------------------
41 .
42 .TP
43 .BI \-verbose|\-v " level"
44 Verbosity:
45 .RS
46 .TP 5
47 .I 0
48 Critical messages.
49 .TP
50 .I 1
51 Error messages.
52 .TP
53 .I 2
54 Warning messages.
55 .TP
56 .I 3
57 Informational messages.
58 .TP
59 .I 4
60 Informational messages with trace enabled.
61 .RE
62 .
63 .TP
64 .BI \--device=\fIDEVICE\fB|\-d " DEVICE"
65 Query or change DEVICE.
66 .
67 .TP
68 .B \--help|\-h
69 Output this usage message.
70 .
71 .TP
72 .B \--hex|\-H
73 Output response in hex.
74 .
75 .TP
76 .B \--in|\-i
77 Request PR In command.
78 .
79 .TP
80 .B \--out|\-o
81 Request PR Out command.
82 .
83 .TP
84 .B \--param-aptpl|\-Z
85 PR Out parameter 'APTPL'.
86 .
87 .TP
88 .B \--read-keys|\-k
89 PR In: Read Keys.
90 .
91 .TP
92 .BI \--param-sark=\fISARK\fB|\-S " SARK"
93 PR Out parameter service action reservation key (SARK is in hex).
94 .
95 .TP
96 .B \--preempt|\-P
97 PR Out: Preempt.
98 .
99 .TP
100 .B \--preempt-abort|\-A
101 PR Out: Preempt and Abort.
102 .
103 .TP
104 .BI \--prout-type=\fITYPE\fB|\-T " TYPE"
105 PR Out command type.
106 .
107 .TP
108 .B \--read-full-status|\-s
109 PR In: Read Full Status.
110 .
111 .TP
112 .B \--read-keys|\-k
113 PR In: Read Keys.
114 .
115 .TP
116 .B \--read-reservation|\-r
117 PR In: Read Reservation.
118 .
119 .TP
120 .B \--register|\-G
121 PR Out: Register.
122 .
123 .TP
124 .B \--register-ignore|\-I
125 PR Out: Register and Ignore.
126 .
127 .TP
128 .B \--release|\-L
129 PR Out: Release.
130 .
131 .TP
132 .B \--report-capabilities|\-c
133 PR In: Report Capabilities.
134 .
135 .TP
136 .B \--reserve|\-R
137 PR Out: Reserve.
138 .
139 .TP
140 .BI \--transport-id=\fITIDS\fB|\-X " TIDS"
141 TransportIDs can be mentioned in several forms.
142 .
143 .
144 .\" ----------------------------------------------------------------------------
145 .SH EXAMPLE
146 .\" ----------------------------------------------------------------------------
147 .
148 .TP
149 Register the Service Action Reservation Key for the /dev/mapper/mpath9 device:
150 \fBmpathpersist --out --register --param-sark=\fI123abc \fB--prout-type=\fI5 /dev/mapper/mpath9\fR
151 .TP
152 Read the Service Action Reservation Key for the /dev/mapper/mpath9 device:
153 \fBmpathpersist -i -k \fI/dev/mapper/mpath9\fR
154 .TP
155 Reserve the Service Action Reservation Key for the /dev/mapper/mpath9 device:
156 \fBmpathpersist --out --reserve --param-sark=\fI123abc \fB--prout-type=\fI8 \fB-d \fI/dev/mapper/mpath9\fR
157 .TP
158 Read the reservation status of the /dev/mapper/mpath9 device:
159 \fBmpathpersist -i -s -d \fI/dev/mapper/mpath9\fR
160 .
161 .
162 .\" ----------------------------------------------------------------------------
163 .SH "SEE ALSO"
164 .\" ----------------------------------------------------------------------------
165 .
166 .BR multipath (8),
167 .BR multipathd (8).
168 .
169 .
170 .\" ----------------------------------------------------------------------------
171 .SH AUTHORS
172 .\" ----------------------------------------------------------------------------
173 .
174 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
175 and others.
176 .\" EOF