| gvinum.8 (152616) | gvinum.8 (152631) |
|---|---|
| 1.\" Copyright (c) 2005 Chris Jones 2.\" All rights reserved. | 1.\" Copyright (c) 2005 Chris Jones 2.\" All rights reserved. |
| 3.\" | 3.\" |
| 4.\" This software was developed for the FreeBSD Project by Chris Jones 5.\" thanks to the support of Google's Summer of Code program and 6.\" mentoring by Lukas Ertl. | 4.\" This software was developed for the FreeBSD Project by Chris Jones 5.\" thanks to the support of Google's Summer of Code program and 6.\" mentoring by Lukas Ertl. |
| 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: | 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: |
| 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20.\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. | 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20.\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. |
| 28.\" 29.\" $FreeBSD: head/sbin/gvinum/gvinum.8 152616 2005-11-19 20:26:52Z le $ | |
| 30.\" | 28.\" |
| 29.\" $FreeBSD: head/sbin/gvinum/gvinum.8 152631 2005-11-20 10:35:46Z le $ 30.\" |
|
| 31.Dd September 1, 2005 32.Dt GVINUM 8 33.Os 34.Sh NAME 35.Nm gvinum 36.Nd Logical Volume Manager control program 37.Sh SYNOPSIS 38.Nm 39.Op Ar command 40.Op Fl options 41.Sh COMMANDS 42.Bl -tag -width indent 43.It Xo 44.Ic checkparity 45.Op Fl f 46.Ar plex | 31.Dd September 1, 2005 32.Dt GVINUM 8 33.Os 34.Sh NAME 35.Nm gvinum 36.Nd Logical Volume Manager control program 37.Sh SYNOPSIS 38.Nm 39.Op Ar command 40.Op Fl options 41.Sh COMMANDS 42.Bl -tag -width indent 43.It Xo 44.Ic checkparity 45.Op Fl f 46.Ar plex |
| 47.Xc | 47.Xc |
| 48Check the parity blocks of a RAID-5 plex. The parity check will start at the | 48Check the parity blocks of a RAID-5 plex. The parity check will start at the |
| 49beginning of the plex if the | 49beginning of the plex if the |
| 50.Fl f 51flag is specified, or otherwise at the location of the parity check pointer, 52the first location at which plex's parity is incorrect. All subdisks in the 53plex must be up for a parity check. 54.It Xo 55.Ic create 56.Op Ar description-file 57.Xc 58Create a volume as described in 59.Ar description-file . 60If no | 50.Fl f 51flag is specified, or otherwise at the location of the parity check pointer, 52the first location at which plex's parity is incorrect. All subdisks in the 53plex must be up for a parity check. 54.It Xo 55.Ic create 56.Op Ar description-file 57.Xc 58Create a volume as described in 59.Ar description-file . 60If no |
| 61.Ar description-file 62provided, opens an editor and provides the current | 61.Ar description-file 62provided, opens an editor and provides the current |
| 63.Nm 64configuration for editing. 65.It Xo 66.Ic help 67.Xc | 63.Nm 64configuration for editing. 65.It Xo 66.Ic help 67.Xc |
| 68Provides a synopsis of 69.Nm | 68Provides a synopsis of 69.Nm |
| 70commands and arguments. 71.It Xo 72.Ic l | list 73.Op Fl r 74.Op Fl v 75.Op Fl V 76.Op Ar volume | plex | subdisk 77.Xc --- 23 unchanged lines hidden (view full) --- 101.Op Fl r 102.Op Fl v 103.Op Fl V 104.Op Ar volume ... 105.Xc 106List information about the relevant object(s). The 107.Fl r 108flag provides recursive display, showing each object's subordinate objects in | 70commands and arguments. 71.It Xo 72.Ic l | list 73.Op Fl r 74.Op Fl v 75.Op Fl V 76.Op Ar volume | plex | subdisk 77.Xc --- 23 unchanged lines hidden (view full) --- 101.Op Fl r 102.Op Fl v 103.Op Fl V 104.Op Ar volume ... 105.Xc 106List information about the relevant object(s). The 107.Fl r 108flag provides recursive display, showing each object's subordinate objects in |
| 109proper relation. The | 109proper relation. The |
| 110.Fl v | 110.Fl v |
| 111and | 111and |
| 112.Fl V 113flags provide progressively more detailed output. 114.It Xo 115.Ic move | mv 116.Fl f | 112.Fl V 113flags provide progressively more detailed output. 114.It Xo 115.Ic move | mv 116.Fl f |
| 117.Ar drive subdisk | 117.Ar drive subdisk |
| 118.Op Ar ... 119.Xc | 118.Op Ar ... 119.Xc |
| 120Move the subdisk(s) to the specified drive. The 121.Fl f | 120Move the subdisk(s) to the specified drive. The 121.Fl f |
| 122flag is required, as all data on the indicated subdisk(s) will be destroyed as 123part of the move. This can currently only be done when the subdisk is 124not being accessed. 125.Pp 126If the subdisk(s) form part of a RAID-5 plex, the disk(s) will need to be set | 122flag is required, as all data on the indicated subdisk(s) will be destroyed as 123part of the move. This can currently only be done when the subdisk is 124not being accessed. 125.Pp 126If the subdisk(s) form part of a RAID-5 plex, the disk(s) will need to be set |
| 127to the 'up' state and the plex will require a | 127to the 'up' state and the plex will require a |
| 128.Ic rebuildparity 129command; if the subdisk(s) form part of a plex that is mirrored with other 130plexes, the plex will require restarting and will sync once restarted. Moving 131more than one subdisk in a RAID-5 plex or subdisks from both sides of a 132mirrored plex volume will destroy data. Note that parity rebuilds and syncing 133must be started manually after a move. 134.It Xo 135.Ic printconfig 136.Xc 137Write a copy of the current configuration to standard output. 138.It Xo 139.Ic quit 140.Xc | 128.Ic rebuildparity 129command; if the subdisk(s) form part of a plex that is mirrored with other 130plexes, the plex will require restarting and will sync once restarted. Moving 131more than one subdisk in a RAID-5 plex or subdisks from both sides of a 132mirrored plex volume will destroy data. Note that parity rebuilds and syncing 133must be started manually after a move. 134.It Xo 135.Ic printconfig 136.Xc 137Write a copy of the current configuration to standard output. 138.It Xo 139.Ic quit 140.Xc |
| 141Exit | 141Exit |
| 142.Nm 143when running in interactive mode. Normally this would be done by entering the 144EOF character. 145.It Xo 146.Ic rename 147.Op Fl r 148.Ar drive | subdisk | plex | volume 149.Ar newname 150.Xc | 142.Nm 143when running in interactive mode. Normally this would be done by entering the 144EOF character. 145.It Xo 146.Ic rename 147.Op Fl r 148.Ar drive | subdisk | plex | volume 149.Ar newname 150.Xc |
| 151Change the name of the specified object. The | 151Change the name of the specified object. The |
| 152.Fl r 153flag will recursively rename subordinate objects. 154.Pp | 152.Fl r 153flag will recursively rename subordinate objects. 154.Pp |
| 155Note that device nodes will not be renamed until | 155Note that device nodes will not be renamed until |
| 156.Nm 157is restarted. 158.It Xo 159.Ic rebuildparity 160.Op Fl f 161.Ar plex 162.Xc 163Rebuild the parity blocks of a RAID-5 plex. The parity rebuild will start at | 156.Nm 157is restarted. 158.It Xo 159.Ic rebuildparity 160.Op Fl f 161.Ar plex 162.Xc 163Rebuild the parity blocks of a RAID-5 plex. The parity rebuild will start at |
| 164the beginning of the plex if the | 164the beginning of the plex if the |
| 165.Fl f 166flag is specified, or otherwise at the location of the parity check pointer. 167All subdisks in the plex must be up for a parity check. 168.It Xo 169.Ic rm 170.Op Fl r 171.Ar volume | plex | subdisk 172.Xc | 165.Fl f 166flag is specified, or otherwise at the location of the parity check pointer. 167All subdisks in the plex must be up for a parity check. 168.It Xo 169.Ic rm 170.Op Fl r 171.Ar volume | plex | subdisk 172.Xc |
| 173Remove an object and, if | 173Remove an object and, if |
| 174.Fl r 175is specified, its subordinate objects. 176.It Xo 177.Ic saveconfig 178.Xc | 174.Fl r 175is specified, its subordinate objects. 176.It Xo 177.Ic saveconfig 178.Xc |
| 179Save | 179Save |
| 180.Nm 181configuration to disk after configuration failures. 182.It Xo 183.Ic setstate 184.Op Fl f 185.Ar state 186.Ar volume | plex | subdisk | drive 187.Xc | 180.Nm 181configuration to disk after configuration failures. 182.It Xo 183.Ic setstate 184.Op Fl f 185.Ar state 186.Ar volume | plex | subdisk | drive 187.Xc |
| 188Set state without influencing other objects, for diagnostic purposes 189only. The | 188Set state without influencing other objects, for diagnostic purposes 189only. The |
| 190.Fl f 191flag forces state changes regardless of whether they are legal. 192.It Xo 193.Ic start | 190.Fl f 191flag forces state changes regardless of whether they are legal. 192.It Xo 193.Ic start |
| 194.Xc | 194.Xc |
| 195Read configuration from all vinum drives. 196.It Xo 197.Ic start 198.Op Fl S Ar size 199.Ar volume | plex | subdisk 200.Xc 201Allow the system to access the objects. The 202.Fl S 203flag is currently ignored. 204.El 205.Sh DESCRIPTION 206The 207.Nm 208utility communicates with the kernel component of the GVinum logical volume 209manager. It is designed either for interactive use, when started without 210command line arguments, or to execute a single command if the command is | 195Read configuration from all vinum drives. 196.It Xo 197.Ic start 198.Op Fl S Ar size 199.Ar volume | plex | subdisk 200.Xc 201Allow the system to access the objects. The 202.Fl S 203flag is currently ignored. 204.El 205.Sh DESCRIPTION 206The 207.Nm 208utility communicates with the kernel component of the GVinum logical volume 209manager. It is designed either for interactive use, when started without 210command line arguments, or to execute a single command if the command is |
| 211supplied on the command line. In interactive mode, | 211supplied on the command line. In interactive mode, |
| 212.Nm 213maintains a command line history. 214.Sh OPTIONS 215.Nm 216commands may be followed by an option. 217.Bl -tag -width indent 218.It Fl f 219The 220.Fl f 221.Pq Dq force 222option overrides safety checks. It should be used with extreme caution. This | 212.Nm 213maintains a command line history. 214.Sh OPTIONS 215.Nm 216commands may be followed by an option. 217.Bl -tag -width indent 218.It Fl f 219The 220.Fl f 221.Pq Dq force 222option overrides safety checks. It should be used with extreme caution. This |
| 223option is required in order to use the | 223option is required in order to use the |
| 224.Ic move 225command. 226.It Fl r | 224.Ic move 225command. 226.It Fl r |
| 227The | 227The |
| 228.Fl r 229.Pq Dq recursive 230option applies the command recursively to subordinate objects. For example, in 231conjunction with the 232.Ic lv | 228.Fl r 229.Pq Dq recursive 230option applies the command recursively to subordinate objects. For example, in 231conjunction with the 232.Ic lv |
| 233command, the | 233command, the |
| 234.Fl r 235option will also show information about the plexes and subdisks belonging to | 234.Fl r 235option will also show information about the plexes and subdisks belonging to |
| 236the volume. It is also used by the | 236the volume. It is also used by the |
| 237.Ic rename 238command to indicate that subordinate objects such as subdisks should be renamed | 237.Ic rename 238command to indicate that subordinate objects such as subdisks should be renamed |
| 239to match the object(s) specified and by the | 239to match the object(s) specified and by the |
| 240.Ic rm 241command to delete plexes belonging to a volume and so on. 242.It Fl v 243The 244.Fl v 245.Pq Dq verbose 246option provides more detailed output. 247.It Fl V --- 16 unchanged lines hidden (view full) --- 264.It Pa /dev/gvinum/sd 265directory containing device nodes for 266.Nm 267subdisks 268.El 269.Sh ENVIRONMENT 270.Bl -tag -width EDITOR 271.It Ev EDITOR | 240.Ic rm 241command to delete plexes belonging to a volume and so on. 242.It Fl v 243The 244.Fl v 245.Pq Dq verbose 246option provides more detailed output. 247.It Fl V --- 16 unchanged lines hidden (view full) --- 264.It Pa /dev/gvinum/sd 265directory containing device nodes for 266.Nm 267subdisks 268.El 269.Sh ENVIRONMENT 270.Bl -tag -width EDITOR 271.It Ev EDITOR |
| 272The name of the editor to use for editing configuration files, by | 272The name of the editor to use for editing configuration files, by |
| 273default 274.Nm vi . 275.El 276.Sh SEE ALSO 277.Xr geom 4 , 278.Xr geom 8 279.Pp 280.Sh AUTHORS 281.An Lukas Ertl Aq le@freebsd.org 282.An Chris Jones Aq soc-cjones@freebsd.org 283.Sh HISTORY 284The 285.Nm | 273default 274.Nm vi . 275.El 276.Sh SEE ALSO 277.Xr geom 4 , 278.Xr geom 8 279.Pp 280.Sh AUTHORS 281.An Lukas Ertl Aq le@freebsd.org 282.An Chris Jones Aq soc-cjones@freebsd.org 283.Sh HISTORY 284The 285.Nm |
| 286utility first appeared in 287.Fx 5.3 . The 288.Nm vinum | 286utility first appeared in 287.Fx 5.3 . The 288.Nm vinum |
| 289utility, on which | 289utility, on which |
| 290.Nm | 290.Nm |
| 291is based, was written by Greg Lehey. 292.Pp | 291is based, was written by Greg Lehey. 292.Pp |
| 293.Nm 294was written by Lukas Ertl. The move and rename commands and 295documentation were added by Chris Jones through the 2005 Google Summer | 293.Nm 294was written by Lukas Ertl. The move and rename commands and 295documentation were added by Chris Jones through the 2005 Google Summer |
| 296of Code program. 297.Sh BUGS 298.Xr gvinum 8 does not rename devices in | 296of Code program. 297.Sh BUGS 298.Xr gvinum 8 does not rename devices in |
| 299.Pa /dev/gvinum | 299.Pa /dev/gvinum |
| 300until reloaded. 301.Pp | 300until reloaded. 301.Pp |
| 302The | 302The |
| 303.Fl S | 303.Fl S |
| 304initsize flag to | 304initsize flag to |
| 305.Ic start 306is ignored. 307.Pp | 305.Ic start 306is ignored. 307.Pp |
| 308The | 308The |
| 309.Ic stop 310command does not work. 311.Pp | 309.Ic stop 310command does not work. 311.Pp |
| 312Moving subdisks that are not part of a mirrored or RAID-5 volume will 313destroy data. It is perhaps a bug to permit this. | 312Moving subdisks that are not part of a mirrored or RAID-5 volume will 313destroy data. It is perhaps a bug to permit this. |
| 314.Pp | 314.Pp |
| 315Plexes in which subdisks have been moved do not automatically sync or | 315Plexes in which subdisks have been moved do not automatically sync or |
| 316rebuild parity. This may leave data unprotected and is perhaps unwise. 317.Pp | 316rebuild parity. This may leave data unprotected and is perhaps unwise. 317.Pp |
| 318.Xr gvinum 8 does not yet fully implement all functions found in 319.Xr vinum 4 . Specifically, the following commands from | 318.Xr gvinum 8 does not yet fully implement all functions found in 319.Xr vinum 4 . Specifically, the following commands from |
| 320.Xr vinum 4 are not supported: 321.Bl -tag -width indent 322.It Ic attach Ar plex volume Op Cm rename 323.It Xo 324.Ic attach Ar subdisk plex 325.Op Ar offset 326.Op Cm rename 327.Xc --- 10 unchanged lines hidden (view full) --- 338Cause the volume manager to enter the kernel debugger. 339.It Ic debug Ar flags 340Set debugging flags. 341.It Xo 342.Ic detach 343.Op Fl f 344.Op Ar plex | subdisk 345.Xc | 320.Xr vinum 4 are not supported: 321.Bl -tag -width indent 322.It Ic attach Ar plex volume Op Cm rename 323.It Xo 324.Ic attach Ar subdisk plex 325.Op Ar offset 326.Op Cm rename 327.Xc --- 10 unchanged lines hidden (view full) --- 338Cause the volume manager to enter the kernel debugger. 339.It Ic debug Ar flags 340Set debugging flags. 341.It Xo 342.Ic detach 343.Op Fl f 344.Op Ar plex | subdisk 345.Xc |
| 346Detach a plex or subdisk from the volume or plex to which it is | 346Detach a plex or subdisk from the volume or plex to which it is |
| 347attached. 348.It Ic dumpconfig Op Ar drive ... 349List the configuration information stored on the specified drives, or all 350drives in the system if no drive names are specified. 351.It Xo 352.Ic info 353.Op Fl v 354.Op Fl V --- 43 unchanged lines hidden --- | 347attached. 348.It Ic dumpconfig Op Ar drive ... 349List the configuration information stored on the specified drives, or all 350drives in the system if no drive names are specified. 351.It Xo 352.Ic info 353.Op Fl v 354.Op Fl V --- 43 unchanged lines hidden --- |