1ZBD(8) System Manager's Manual ZBD(8)
2
6 zbd - manage zoned block devices
7
10 zbd command [options] device
11
14 zbd is used to manipulate zones of a zoned block device. Zoned block
15 devies are block devices that support the SCSI Zoned Block Commands
16 (ZBC), ATA Zoned-device ATA Commands (ZAC) or NVMe Zoned NameSpace com‐
17 mands (ZNS). The zones to operate on can be specified using the offset
18 and length options.
19 The device argument must be the pathname of the target zoned block de‐
21 vice.
22
25 By default, all commands will operate from the zone at device offset 0
26 and operate on all zones. The common options -ofst and -len can be used
27 to modify the operation range of commands.
28 report
31 The command zbd report is used to obtain and display the device zone
32 information.
33 By default, the command will report all zones from the start of the de‐
35 vice up to the last zone of the device. Options may be used to modify
36 this behavior, changing the starting zone or the size of the report.
37 Report output
39 Zone Zone number
41 type Type of the zone
42 ofst Zone start offset in Bytes
43 len Zone length in Bytes
44 cap Zone usable capacity in Bytes
45 wp Zone write pointer position in Bytes
46 cond Zone condition
47 non_seq Non-sequential write resources active
48 reset Reset write pointer recommended
49 Zone types
51 cnv Conventional
53 swr Sequential write required
54 swp Sequential write preferred
55 ??? Unknown (should not be reported)
56 Zone conditions
58 nw Not write pointer
60 em Empty
61 fu Full
62 oe Explicitly opened
63 oi Implicitly opened
64 cl Closed
65 ol Offline
66 ro Read only
68 ?? Reserved conditions (should not be reported)
69 reset
72 The command zbd reset is used to reset the write pointer of one or more
73 zones.
74 open
77 The command zbd open is used to explicitly open one or more zones.
78 close
81 The command zbd close is used to close one or more zones.
82 finish
85 The command zbd finish is used to finish (transition to full) one or
86 more zones.
87 dump
90 Save the zone information and zone data of a zoned device to files. The
91 files are by default saved in the current working directory. A differ‐
92 ent output path can be specified using the option -d. The file names
93 are prefixed by default using the device base name. The device zone in‐
94 formation is saved in the file <devname>_zone_info.dump and the device
95 zone data is saved in the file <devname>_zone_data.dump. The file name
96 prefix can be changed using the option -f.
97 The dump command will save the data of all conventional zones and the
100 written data of all sequential zones in the operation range. The op‐
101 tions -ofst and -len can be used to limit in size the operation range.
102 The zone information file always saves zone information for all zones
105 of the device, regardless of the specified operation range. This file
106 can be specified in place of a device name with the report command to
107 inspect its content.
108 restore
111 Set a zoned block device zone status and zone data according to the
112 zone information and zoned data saved in files generated using the dump
113 command. The resulting state of the target device will be identical to
114 that of the device used to generate the dump files. The restore command
115 will only operate on the zone range that was used with the dump com‐
116 mand. The target zoned block device must be compatible with the zoned
117 block device used as the source for the dump operation. That is, the
118 target device must have the same capacity and zone configuration (zone
119 type, zone size and zone capacity) as the source device.
120 The path and name prefix of the dump files to use for restoring a de‐
123 vice can be changed using the options -d and -f.
124
127 Options applicable to all commands are as follows.
128 -v Verbose mode (for debug).
130 -i Display device information before executing the command.
132 -ofst offset
134 Start offset in Bytes of the first zone to operate on.
135 -len length
137 Length in Bytes of the range of zones to operate on.
138 -h, --help
140 Display help text and exit.
141 Options applicable only to the zbd report command are as follows.
143 -csv Output zone information using the comma-separated (csv) format.
145 -n Display the number of zones that are to be reported.
147 -c Display the total capacity of all reported zones. When used with
149 the -n and -csv options, the number of zones is output first.
150 -ro filter
152 Sepcify reporting option to filter the zone report. filter can
153 be one of the following.
154 em Empty zones
156 oi Implicitly opened zones
157 oe Explicitly opened zones
158 cl Closed zones
159 fu Full zones
160 ro Read only zones
161 ol Offline zones
162 nw Conventional zones
163 ns Non_seq write resource zones
164 rw Reset write pointer recommended zones
165
168 Damien Le Moal <damien.lemoal@wdc.com>
169
172 blkzone(8)
173
176 The zbd command is part of the libzbd library available from ⟨https://
177 github.com/westerndigitalcorporation/libzbd⟩.
178 ZBD(8)