Fix lintian complaint about bad whatis entry
[multipath-tools/.git] / libmpathpersist / mpath_persistent_reserve_in.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_in.3
5 .\"
6 .\" ----------------------------------------------------------------------------
7 .
8 .TH MPATH_PERSISTENT_RESERVE_IN 3 2016-11-01 "Linux"
9 .
10 .
11 .\" ----------------------------------------------------------------------------
12 .SH NAME
13 .\" ----------------------------------------------------------------------------
14 .
15 mpath_persistent_reserve_in \- send PRIN 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_in" "(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_in ()\fR sends PRIN 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 PRIN command service action. Input argument.
43 .TP
44 .I resp
45 The response from PRIN service action. The caller should manage the memory allocation of this structure.
46 .TP
47 .I noisy
48 Turn on debugging trace: Input argument. 0->Disable, 1->Enable.
49 .TP
50 .I verbose
51 Set verbosity level. Input argument. value:[0-3]. 0->Crits and Errors, 1->Warnings, 2->Info, 3->Debug.
52 .RE
53 .
54 .
55 .\" ----------------------------------------------------------------------------
56 .SH RETURNS
57 .\" ----------------------------------------------------------------------------
58 .
59 .TP 12
60 .B MPATH_PR_SUCCESS
61 If PR command successful.
62 .TP
63 .B MPATH_PR_SYNTAX_ERROR
64 If syntax error or invalid parameter.
65 .TP
66 .B MPATH_PR_SENSE_NOT_READY
67 If command fails with [sk,asc,ascq: 0x2,*,*].
68 .TP
69 .B MPATH_PR_SENSE_MEDIUM_ERROR
70 If command fails with [sk,asc,ascq: 0x3,*,*].
71 .TP
72 .B MPATH_PR_SENSE_HARDWARE_ERROR
73 If command fails with [sk,asc,ascq: 0x4,*,*].
74 .TP
75 .B MPATH_PR_SENSE_INVALID_OP
76 If command fails with [sk,asc,ascq: 0x5,0x20,0x0].
77 .TP
78 .B MPATH_PR_ILLEGAL_REQ
79 If command fails with [sk,asc,ascq: 0x5,*,*].
80 .TP
81 .B MPATH_PR_SENSE_UNIT_ATTENTION
82 If command fails with [sk,asc,ascq: 0x6,*,*].
83 .TP
84 .B MPATH_PR_SENSE_ABORTED_COMMAND
85 If command fails with [sk,asc,ascq: 0xb,*,*].
86 .TP
87 .B MPATH_PR_NO_SENSE
88 If command fails with [sk,asc,ascq: 0x0,*,*].
89 .TP
90 .B MPATH_PR_SENSE_MALFORMED
91 If command fails with SCSI command malformed.
92 .TP
93 .B MPATH_PR_FILE_ERROR
94 If command fails while accessing file (device node) problems(e.g. not found).
95 .TP
96 .B MPATH_PR_DMMP_ERROR
97 If Device Mapper related error.(e.g Error in getting dm info).
98 .TP
99 .B MPATH_PR_OTHER
100 If other error/warning has occurred(e.g transport or driver error).
101 .
102 .
103 .\" ----------------------------------------------------------------------------
104 .SH "SEE ALSO"
105 .\" ----------------------------------------------------------------------------
106 .
107 .BR mpathpersist (8).
108 .
109 .
110 .\" ----------------------------------------------------------------------------
111 .SH AUTHORS
112 .\" ----------------------------------------------------------------------------
113 .
114 \fImultipath-tools\fR was developed by Christophe Varoqui <christophe.varoqui@opensvc.com>
115 and others.
116 .\" EOF