Fix lintian complaint about bad whatis entry
[multipath-tools/.git] / libmpathpersist / mpath_persistent_reserve_out.3
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 libmpathpersist/mpath_persistent_reserve_out.3
5 .\"
6 .\" ----------------------------------------------------------------------------
7 .
8 .TH MPATH_PERSISTENT_RESERVE_OUT 3 2016-11-01 "Linux"
9 .
10 .
11 .\" ----------------------------------------------------------------------------
12 .SH NAME
13 .\" ----------------------------------------------------------------------------
14 .
15 mpath_persistent_reserve_out \- send PROUT command to DM device
16 .
17 .
18 .\" ----------------------------------------------------------------------------
19 .SH SYNOPSIS
20 .\" ----------------------------------------------------------------------------
21 .
22 .B #include <mpath_persist.h>
23 .P
24 .BI "int mpath_persistent_reserve_out" "(int fd, int rq_servact, struct prin_resp *resp, int noisy, int verbose)"
25 .P
26 .
27 .
28 .\" ----------------------------------------------------------------------------
29 .SH DESCRIPTION
30 .\" ----------------------------------------------------------------------------
31 .
32 The function in the \fBmpath_persistent_reserve_out ()\fR sends PROUT command to
33 the DM device and gets the response.
34 .TP
35 .B Parameters:
36 .RS
37 .TP 12
38 .I fd
39 The file descriptor of a multipath device. Input argument.
40 .TP
41 .I rq_servact
42 PROUT command service action. Input argument.
43 .TP
44 .I rq_scope
45 Persistent reservation scope. The value should be always LU_SCOPE (0h).
46 .TP
47 .I rq_type
48 Persistent reservation type. The valid values of persistent reservation types are:
49 .RS
50 .IP
51 5h (Write exclusive - registrants only).
52 .IP
53 6h (Exclusive access - registrants only).
54 .IP
55 7h (Write exclusive - All registrants).
56 .IP
57 8h (Exclusive access - All registrants).
58 .RE
59 .TP
60 .I paramp
61 PROUT command parameter data. The paramp is a struct which describes PROUT
62 parameter list. Caller should manage the memory allocation of this structure.
63 .TP
64 .I noisy
65 Turn on debugging trace: Input argument. 0->Disable, 1->Enable.
66 .TP
67 .I verbose
68 Set verbosity level. Input argument. value: 0 to 3. 0->Crits and Errors, 1->Warnings, 2->Info, 3->Debug.
69 .RE
70 .
71 .
72 .\" ----------------------------------------------------------------------------
73 .SH RETURNS
74 .\" ----------------------------------------------------------------------------
75 .
76 .TP 12
77 .B MPATH_PR_SUCCESS
78 If PR command successful else returns any one of the status mentioned below.
79 .TP
80 .B MPATH_PR_SYNTAX_ERROR
81 If syntax error or invalid parameter.
82 .TP
83 .B MPATH_PR_SENSE_NOT_READY
84 If command fails with [sk,asc,ascq: 0x2,*,*].
85 .TP
86 .B MPATH_PR_SENSE_MEDIUM_ERROR
87 If command fails with [sk,asc,ascq: 0x3,*,*].
88 .TP
89 .B MPATH_PR_SENSE_HARDWARE_ERROR
90 If command fails with [sk,asc,ascq: 0x4,*,*].
91 .TP
92 .B MPATH_PR_SENSE_INVALID_OP
93 If command fails with [sk,asc,ascq: 0x5,0x20,0x0].
94 .TP
95 .B MPATH_PR_ILLEGAL_REQ
96 If command fails with [sk,asc,ascq: 0x5,*,*].
97 .TP
98 .B MPATH_PR_SENSE_UNIT_ATTENTION
99 If command fails with [sk,asc,ascq: 0x6,*,*].
100 .TP
101 .B MPATH_PR_SENSE_ABORTED_COMMAND
102 If command fails with [sk,asc,ascq: 0xb,*,*].
103 .TP
104 .B MPATH_PR_NO_SENSE
105 If command fails with [sk,asc,ascq: 0x0,*,*].
106 .TP
107 .B MPATH_PR_SENSE_MALFORMED
108 If command fails with SCSI command malformed.
109 .TP
110 .B MPATH_PR_FILE_ERROR
111 If command fails while accessing file (device node) problems(e.g. not found).
112 .TP
113 .B MPATH_PR_DMMP_ERROR
114 If Device Mapper related error.(e.g Error in getting dm info).
115 .TP
116 .B MPATH_PR_OTHER
117 If other error/warning has occurred(e.g transport or driver error).
118 .TP
119 .B MPATH_PR_RESERV_CONFLICT
120 If command fails with reservation conflict.
121 .
122 .
123 .\" ----------------------------------------------------------------------------
124 .SH "SEE ALSO"
125 .\" ----------------------------------------------------------------------------
126 .
127 .BR mpathpersist (8).
128 .
129 .
130 .\" ----------------------------------------------------------------------------
131 .SH AUTHORS
132 .\" ----------------------------------------------------------------------------
133 .
134 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
135 and others.
136 .\" EOF