1MPATHPERSIST(8)             System Manager's Manual            MPATHPERSIST(8)
2
3
4

NAME

6       mpathpersist  -  Manages  SCSI  persistent reservations on dm multipath
7       devices.
8

SYNOPSIS

10       mpathpersist [OPTIONS] device
11

DESCRIPTION

13       This utility is used to manage SCSI persistent reservations  on  Device
14       Mapper  Multipath  devices.  To  be able to use this functionality, the
15       reservation_key attribute must be defined  in  the  /etc/multipath.conf
16       file.  Otherwise  the  multipathd  daemon will not check for persistent
17       reservation for newly discovered paths or reinstated paths.
18
19       mpathpersist supports the same command-line options as  the  sg_persist
20       utility.   Consult  the sg_persist (8) manual page for an in-depth dis‐
21       cussion of the various options.
22

OPTIONS

24       -verbose|-v level
25              Verbosity:
26
27              0    Critical messages.
28
29              1    Error messages.
30
31              2    Warning messages.
32
33              3    Informational messages.
34
35              4    Informational messages with trace enabled.
36
37       --device=DEVICE|-d DEVICE
38              Query or change DEVICE.
39
40       --help|-h
41              Output this usage message.
42
43       --hex|-H
44              Output response in hex.
45
46       --in|-i
47              Request PR In command.
48
49       --out|-o
50              Request PR Out command.
51
52       --param-alltgpt|-Y
53              PR Out parameter 'ALL_TG_PT'.
54
55       --param-aptpl|-Z
56              PR Out parameter 'APTPL'.
57
58       --read-keys|-k
59              PR In: Read Keys.
60
61       --param-rk=RK|-K RK
62              PR Out parameter reservation key (RK is in hex, up to 8 bytes).
63
64       --param-sark=SARK|-S SARK
65              PR Out parameter service action  reservation  key  (SARK  is  in
66              hex).
67
68       --preempt|-P
69              PR Out: Preempt.
70
71       --clear|-C
72              PR Out: Clear registrations.
73
74       --preempt-abort|-A
75              PR Out: Preempt and Abort.
76
77       --prout-type=TYPE|-T TYPE
78              PR Out command type.
79
80       --read-full-status|-s
81              PR In: Read Full Status.
82
83       --read-keys|-k
84              PR In: Read Keys.
85
86       --read-reservation|-r
87              PR In: Read Reservation.
88
89       --register|-G
90              PR Out: Register.
91
92       --register-ignore|-I
93              PR Out: Register and Ignore.
94
95       --release|-L
96              PR Out: Release.
97
98       --report-capabilities|-c
99              PR In: Report Capabilities.
100
101       --reserve|-R
102              PR Out: Reserve.
103
104       --transport-id=TIDS|-X TIDS
105              TransportIDs can be mentioned in several forms.
106
107       --alloc-length=LEN|-l LEN
108              PR  In:  maximum  allocation  length.  LEN  is  a decimal number
109              between 0 and 8192.
110

EXAMPLE

112       Register the Service Action Reservation Key for the  /dev/mapper/mpath9
113       device:
114              mpathpersist --out --register --param-sark=123abc --prout-type=5
115              /dev/mapper/mpath9
116
117       Read the Service Action  Reservation  Key  for  the  /dev/mapper/mpath9
118       device:
119              mpathpersist -i -k /dev/mapper/mpath9
120
121       Reserve  the  Service Action Reservation Key for the /dev/mapper/mpath9
122       device:
123              mpathpersist --out --reserve --param-sark=123abc  --prout-type=8
124              -d /dev/mapper/mpath9
125
126       Read the reservation status of the /dev/mapper/mpath9 device:
127              mpathpersist -i -s -d /dev/mapper/mpath9
128

SEE ALSO

130       multipath(8), multipathd(8), sg_persist(8).
131

AUTHORS

133       multipath-tools  was  developed by Christophe Varoqui <christophe.varo‐
134       qui@opensvc.com> and others.
135
136
137
138Linux                             2016-10-30                   MPATHPERSIST(8)