8a3b52c9889919b0b4a3f9b05e63493b5c57f8b7
[multipath-tools/.git] / libmpathpersist / mpath_persistent_reserve_out.3
1 .\"
2 .TH MPATH_PERSISTENT_RESERVE_OUT 3  2011-04-08 "Linux Manpage"
3 .SH NAME
4 mpath_persistent_reserve_out
5 .SH SYNOPSIS
6 .B #include <mpath_persist.h>
7 .sp
8 .BI "int mpath_persistent_reserve_out (int fd, int rq_servact, struct prin_resp *resp, int noisy, int verbose)"
9 .sp
10 .SH DESCRIPTION
11 The function in the
12 .BR mpath_persistent_reserve_out ()
13 sends PR OUT command to the DM device and gets the response.
14 .br
15 .BI Parameters:
16 .br
17 .I fd
18 .B The file descriptor of a multipath device. Input argument.
19 .br
20 .I rq_servact
21 .B PROUT command service action. Input argument
22 .br
23 .I rq_scope
24 .B Persistent reservation scope. The value should be always LU_SCOPE (0h).
25 .br
26 .I rq_type
27 .B Persistent reservation type. The valid values of persistent reservation types are
28       5h (Write exclusive - registrants only)
29       6h (Exclusive access - registrants only)
30       7h (Write exclusive - All registrants)
31       8h (Exclusive access - All registrants).
32 .br
33 .I paramp
34 .B PROUT command parameter data. The paramp is a struct which describes PROUT parameter list. Caller should manage the memory allocation of this structure.
35 .br
36 .I noisy
37 .B Turn on debugging trace: Input argument. 0->Disable, 1->Enable.
38 .br
39 .I verbose
40 .B Set verbosity level. Input argument. value: 0 to 3. 0->Crits and Errors, 1->Warnings, 2->Info, 3->Debug
41
42 .SH "RETURNS"
43 .I MPATH_PR_SUCCESS
44 .B if PR command successful else returns any one of the status mentioned below
45 .br
46 .I MPATH_PR_SYNTAX_ERROR
47 .B if  syntax error or invalid parameter
48 .br
49 .I MPATH_PR_SENSE_NOT_READY
50 .B  if command fails with [sk,asc,ascq: 0x2,*,*]
51 .br
52 .I MPATH_PR_SENSE_MEDIUM_ERROR
53 .B  if command fails with [sk,asc,ascq: 0x3,*,*]
54 .br
55 .I MPATH_PR_SENSE_HARDWARE_ERROR
56 .B  if command fails with [sk,asc,ascq: 0x4,*,*]
57 .br
58 .I MPATH_PR_SENSE_INVALID_OP
59 .B  if command fails with [sk,asc,ascq: 0x5,0x20,0x0]
60 .br
61 .I MPATH_PR_ILLEGAL_REQ
62 .B  if command fails with [sk,asc,ascq: 0x5,*,*]
63 .br
64 .I MPATH_PR_SENSE_UNIT_ATTENTION
65 .B  if command fails with [sk,asc,ascq: 0x6,*,*]
66 .br
67 .I MPATH_PR_SENSE_ABORTED_COMMAND
68 .B  if command fails with [sk,asc,ascq: 0xb,*,*]
69 .br
70 .I MPATH_PR_NO_SENSE
71 .B  if command fails with [sk,asc,ascq: 0x0,*,*]
72 .br
73 .I MPATH_PR_SENSE_MALFORMED
74 .B if command fails with SCSI command malformed
75 .br
76 .I MPATH_PR_RESERV_CONFLICT
77 .B if command fails with reservation conflict
78 .br
79 .I MPATH_PR_FILE_ERROR
80 .B if command fails while accessing file (device node) problems(e.g. not found)
81 .br
82 .I MPATH_PR_DMMP_ERROR
83 .B if Device Mapper related error.(e.g Error in getting dm info)
84 .br
85 .I MPATH_PR_OTHER
86 .B if other error/warning has occurred(e.g transport or driver error)
87 .br
88
89
90 .SH "SEE ALSO"
91 .I mpath_persistent_reserve_in mpathpersist /usr/share/doc/mpathpersist/README
92 .br