Skip to content

Commit 982a21a

Browse files
committed
Update README.md
1 parent f0a88e5 commit 982a21a

File tree

1 file changed

+90
-1
lines changed

1 file changed

+90
-1
lines changed

README.md

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,95 @@ chronme index.html
2626

2727
## Example `/etc/multipath/multipath.conf`
2828

29+
### Multipaths
30+
31+
```text
32+
multipaths {
33+
34+
multipath {
35+
alias mpatha
36+
wwid 360060160e7d0490097a8ea67adc99518
37+
}
38+
}
39+
```
40+
41+
| Option | Purpose |
42+
|----------|--------------------------------------------------|
43+
| `alias` | Human-readable name assigned to the multipath map |
44+
| `wwid` | Worldwide identifier of the LUN/device |
45+
| `mode` | Optional; can control access mode (e.g., 0600) |
46+
| `uid` | Optional; sets user ID for the device |
47+
| `gid` | Optional; sets group ID for the device |
48+
| `path_grouping_policy` | Can override global/default setting |
49+
| `path_selector` | Can override global/default setting |
50+
| `path_checker` | Can override global/default setting |
51+
| `prio` | Can override global/default setting |
52+
| `no_path_retry` | Can override global/default setting |
53+
54+
55+
### Devices
56+
2957
```text
58+
devices {
59+
device {
60+
vendor "DGC"
61+
product "VRAID"
62+
path_grouping_policy "group_by_prio"
63+
getuid_callout "/lib/udev/scsi_id --whitelisted --device=/dev/%n"
64+
path_selector "service-time 0"
65+
path_checker "tur"
66+
hardware_handler "1 alua"
67+
prio "alua"
68+
failback "immediate"
69+
rr_weight "uniform"
70+
no_path_retry 60
71+
}
72+
}
73+
```
74+
75+
| Option | Purpose |
76+
|----------------------|-----------------------------------------------------|
77+
| `vendor`, `product` | Matches your SAN device |
78+
| `path_grouping_policy` | Groups paths by ALUA priority |
79+
| `getuid_callout` | Gets unique WWID per LUN |
80+
| `path_selector` | Uses service-time for I/O scheduling |
81+
| `path_checker` | Uses `tur` (Test Unit Ready) to check path health |
82+
| `hardware_handler` | Enables ALUA for failover control |
83+
| `prio` | Uses ALUA priority to rank paths |
84+
| `failback` | Immediately fail back to preferred path |
85+
| `rr_weight` | Round robin weight for path usage |
86+
| `no_path_retry` | Retry for 60 seconds if paths are lost |
87+
88+
### Defaults
89+
90+
```text
91+
defaults {
92+
user_friendly_names no
93+
find_multipaths yes
94+
polling_interval 10
95+
selector "service-time 0"
96+
path_checker tur
97+
rr_min_io 100
98+
failback immediate
99+
no_path_retry 60
100+
max_fds 8192
101+
mode 0644
102+
uid 0
103+
gid 0
104+
}
105+
```
30106

31-
```
107+
| Option | Purpose |
108+
|----------------------|-------------------------------------------------------------------------|
109+
| `user_friendly_names` | Use alias or `mpathX` naming. Set to `no` to prefer WWIDs or aliases. |
110+
| `find_multipaths` | If `yes`, only create device if multiple paths are detected. |
111+
| `polling_interval` | Time in seconds between path checks. |
112+
| `selector` | Path selection algorithm. `service-time` is commonly used. |
113+
| `path_checker` | Path health checker. `tur` (Test Unit Ready) is suitable for ALUA. |
114+
| `rr_min_io` | Number of I/O requests before switching paths in round-robin mode. |
115+
| `failback` | When a better path returns, fail back to it (`immediate`, `manual`). |
116+
| `no_path_retry` | Retry count or mode (`fail`, `queue`, `N` times) on path failure. |
117+
| `max_fds` | Max number of file descriptors multipathd can open. |
118+
| `mode` | Permissions on multipath devices (e.g., `0644`). |
119+
| `uid` | Owner user ID for device files. Usually `0` (root). |
120+
| `gid` | Owner group ID for device files. Usually `0` (root). |

0 commit comments

Comments
 (0)