table of contents
ZBD(8) | System Manager's Manual | ZBD(8) |
NAME¶
zbd - manage zoned block devices
SYNOPSIS¶
zbd command [options] device
DESCRIPTION¶
zbd is used to manipulate zones of a zoned block device. Zoned block devies are block devices that support the SCSI Zoned Block Commands (ZBC), ATA Zoned-device ATA Commands (ZAC) or NVMe Zoned NameSpace commands (ZNS). The zones to operate on can be specified using the offset and length options.
The device argument must be the pathname of the target zoned block device.
COMMANDS¶
report¶
The command zbd report is used to obtain and display the device zone information.
By default, the command will report all zones from the start of the device up to the last zone of the device. Options may be used to modify this behavior, changing the starting zone or the size of the report.
Report output
Zone | Zone number |
type | Type of the zone |
ofst | Zone start offset in Bytes |
len | Zone length in Bytes |
cap | Zone usable capacity in Bytes |
wp | Zone write pointer position in Bytes |
cond | Zone condition |
non_seq | Non-sequential write resources active |
reset | Reset write pointer recommended |
Zone types
cnv | Conventional |
swr | Sequential write required |
swp | Sequential write preferred |
??? | Unknown (should not be reported) |
Zone conditions
nw | Not write pointer |
em | Empty |
fu | Full |
oe | Explicitly opened |
oi | Implicitly opened |
cl | Closed |
ol | Offline |
ro | Read only |
?? | Reserved conditions (should not be reported) |
reset¶
The command zbd reset is used to reset the write pointer of one or more zones.
open¶
The command zbd open is used to explicitly open one or more zones.
close¶
The command zbd close is used to close one or more zones.
finish¶
The command zbd finish is used to finish (transition to full) one or more zones.
By default, all commands will operate from the zone at device offset 0 and operate on all zones. Options may be used to modify this behavior as explained below.
OPTIONS¶
Options applicable to all commands are as follows.
- -v
- Verbose mode (for debug).
- -i
- Display device information before executing the command.
- -ofst offset
- Start offset in Bytes of the first zone to operate on.
- -len length
- Length in Bytes of the range of zones to operate on.
- -h, --help
- Display help text and exit.
- Options applicable only to the zbd report command are as follows.
- -csv
- Output zone information using the comma-separated (csv) format.
- -n
- Display the number of zones that are to be reported and exit.
- -ro filter
- Sepcify reporting option to filter the zone report. filter can be
one of the following.
em Empty zones oi Implicitly opened zones oe Explicitly opened zones cl Closed zones fu Full zones ro Read only zones ol Offline zones nw Conventional zones ns Non_seq write resource zones rw Reset write pointer recommended zones
AUTHOR¶
Damien Le Moal <damien.lemoal@wdc.com>
SEE ALSO¶
AVAILABILITY¶
The zbd command is part of the libzbd library available from https://github.com/westerndigitalcorporation/libzbd.