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

NAME

6       dmzadm - manage zoned block device format for use with the dm-zoned de‐
7       vice mapper target
8
9

SYNOPSIS

11       dmzadm -h | --help
12
13       dmzadm --version
14
15       dmzadm  operation  [  regular-block-device  ]  zoned-block-device-0   [
16       zoned-block-device-1 [...]  ] [ options ]
17
18

DESCRIPTION

20       dmzadm  is used to format, check and repair block devices used with the
21       dm-zoned device mapper. zoned-block-device-0 specifies the device  node
22       of the zoned block device to use (e.g. /dev/sdX).
23
24       regular-block-device is an optional device node corresponding to a reg‐
25       ular block device to be used together with the zoned  block  device  to
26       store  metadata  and  to act as the conventional zone storage space for
27       the zoned device.
28
29       When regular-block-device is used, more than one zoned block device can
30       be  specified  (zoned-block-device-1  etc). If multiple zoned block de‐
31       vices are specified, all devices must have the same zone size.
32
33       operation specifies the action to be taken on the device.
34
35       dmzadm returns 0 on success and 1 on failure.
36
37

OPERATIONS

39       dmzadm defines the following operations.
40
41
42       -h, --help
43              Print a short usage description of dmzadm.
44
45
46       --version
47              Print the current version number and exit dmzadm.
48
49
50       --format
51              Write to the zoned block device(s) and  optional  regular  block
52              device dm-zoned metadata, whiping clean all data that was stored
53              on the device(s).
54
55
56       --check
57              Check the device(s) metadata consistency. No  repair  action  is
58              taken.   Metadata corruptions are not corrected with this opera‐
59              tion. For repairing incorrect metadata, the  --repair  operation
60              must be used.
61
62
63       --repair
64              Check  the  consistency of the device(s) metadata and try to re‐
65              pair any error detected.
66
67
68       --relabel
69              Change the label (DM device name) of a  formatted  dm-zoned  de‐
70              vice.
71
72
73       --start
74              Load the metadata information from the block device(s) and acti‐
75              vate the dm-zoned device.
76
77
78       --stop Deactivate the dm-zoned device associated  with  the  block  de‐
79              vice(s).
80
81

COMMON OPTIONS

83       The following options can be used with all operations.
84
85
86       --verbose
87              Verbose output detailing actions taken.
88
89
90       --vverbose
91              Very detailed output of actions taken.
92
93

FORMAT OPERATION OPTIONS

95       The following options can be used when the --format operation is speci‐
96       fied.
97
98
99       --seq=num
100              Specify the number of sequential zones to be  reserved  for  re‐
101              claim (default: 16 per zoned block device).
102
103
104       --label=str
105              Define  the label of the device-mapper device. If not specified,
106              the label defaults to dmz-serial, where  serial  is  the  serial
107              number of the block device storing the metadata (the first block
108              device specified). If the serial number for the  metadata  block
109              device  is  not  available,  the  label defaults to dmz-bdevname
110              where bdevname is the name of the metadata block device.
111
112

RELABEL OPERATION OPTIONS

114       The following options can be used when the --relabel operation is spec‐
115       ified.
116
117
118       --label=str
119              Define  the new label of the device-mapper device. If not speci‐
120              fied, the new label defaults to dmz-serial, where serial is  the
121              serial  number  of  the  block  device storing the metadata (the
122              first block device specified).  If the  serial  number  for  the
123              metadata  block  device  is not available, the label defaults to
124              dmz-bdevname where bdevname is the name of  the  metadata  block
125              device.
126
127

AUTHORS

129       This    version   of   dmzadm   was   written   by   Damien   Le   Moal
130       <damien.lemoal@wdc.com> and Albert H. Chen  <albert.chen@wdc.com>  with
131       contributions from Hannes Reinecke <hare@suse.de>.
132
133
135       GNU General Public Licence version 3 or later
136
137        (c) 2016-2020 Western Digital Corportation and its affiliates
138
139       Manual  written  by  Damien  Le  Moal  <damien.lemoal@wdc.com and by Tj
140       <ubuntu@iam.tj> for Debian and Ubuntu.
141
142

AVAILABILITY

144       dmzadm is available from the dm-zoned-tools project hosted on github at
145       https://github.com/westerndigitalcorporation/dm-zoned-tools
146
147

SEE ALSO

149       dmsetup(8)
150
151
152
153                                  May 20 2020                        dmzadm(8)
Impressum