geom(8)

NAME

geom - universal control utility for GEOM classes

SYNOPSIS

geom class help
geom class list [name ...]
geom class status [-s] [name ...]
geom class load [-v]
geom class unload [-v]

DESCRIPTION

The geom utility is used to control various GEOM classes. A

class has to
be aware of geom(8) comunication methods, but there are also

some standard commands which can be used for existing geom(8) unaware

classes.
Here is the list of standard commands:

help List all available commands for the given class.

list Print detailed information (within the given

class) about all

geoms (if no additional arguments were speci

fied) or the
given geoms. This command is only available if

the given
class exists in the kernel.

status Print general information (within the given

class) about all

geoms (if no additional arguments were speci

fied) or the
given geoms. This command is only available if

the given
class exists in the kernel.

Additional options include:

-s Produce script-friendly output.

load Load the kernel module that implements the given

class. This

command is only available if the class does not

yet exist in
the kernel and the file geom_<class>.ko can be

found in one
of the directories specifed in kern.module_path

sysctl.

unload Unload the kernel module which implements the

given class.

This command is only available if the given

class is loaded
as a kernel module.

Class-specific commands are implemented as shared libraries

which are
stored in /lib/geom/ directory and are loaded via dlopen(3)

function when
the class name is known. When a class-specific shared li

brary exists, a
direct utility should also be available under the name of

gclass.

Currently available classes which are aware of geom(8):

+o CONCAT
+o ELI
+o LABEL
+o MIRROR
+o NOP
+o RAID3
+o SHSEC
+o STRIPE

ENVIRONMENT

The following environment variables affect the execution of

geom:

GEOM_LIBRARY_PATH Specifies the path where shared li

braries are

stored instead of /lib/geom/.

EXIT STATUS

Exit status is 0 on success, and 1 if the command fails.

EXAMPLES

The following example shows how to set up a stripe on three

disks for
automatic configuration:

geom stripe label -v -s 65536 data /dev/da0 /dev/da1

/dev/da2
or:
gstripe label -v -s 65536 data /dev/da0 /dev/da1

/dev/da2

Print the list of all providers from the DISK class:

geom disk list

Unload a kernel module which implements the MD class:

geom md unload

SEE ALSO

geom(4), gconcat(8), geli(8), glabel(8), gmirror(8),

gnop(8), graid3(8),
gshsec(8), gstripe(8)

HISTORY

The geom utility appeared in FreeBSD 5.3.

AUTHORS

Pawel Jakub Dawidek <pjd@FreeBSD.org>

BSD May 21, 2004

BSD