xref: /freebsd/sys/contrib/openzfs/man/man8/zpool-add.8 (revision 7877fdebeeb35fad1cbbafce22598b1bdf97c786)
1.\" CDDL HEADER START
2.\"
3.\" The contents of this file are subject to the terms of the
4.\" Common Development and Distribution License (the "License").
5.\" You may not use this file except in compliance with the License.
6.\"
7.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
8.\" or http://www.opensolaris.org/os/licensing.
9.\" See the License for the specific language governing permissions
10.\" and limitations under the License.
11.\"
12.\" When distributing Covered Code, include this CDDL HEADER in each
13.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
14.\" If applicable, add the following below this CDDL HEADER, with the
15.\" fields enclosed by brackets "[]" replaced with your own identifying
16.\" information: Portions Copyright [yyyy] [name of copyright owner]
17.\"
18.\" CDDL HEADER END
19.\"
20.\"
21.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
22.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
23.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
24.\" Copyright (c) 2017 Datto Inc.
25.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
26.\" Copyright 2017 Nexenta Systems, Inc.
27.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
28.\"
29.Dd August 9, 2019
30.Dt ZPOOL-ADD 8
31.Os
32.Sh NAME
33.Nm zpool-add
34.Nd Adds specified virtual devices to a ZFS storage pool
35.Sh SYNOPSIS
36.Nm zpool
37.Cm add
38.Op Fl fgLnP
39.Oo Fl o Ar property Ns = Ns Ar value Oc
40.Ar pool vdev Ns ...
41.Sh DESCRIPTION
42.Bl -tag -width Ds
43.It Xo
44.Nm zpool
45.Cm add
46.Op Fl fgLnP
47.Oo Fl o Ar property Ns = Ns Ar value Oc
48.Ar pool vdev Ns ...
49.Xc
50Adds the specified virtual devices to the given pool.
51The
52.Ar vdev
53specification is described in the
54.Em Virtual Devices
55section of
56.Xr zpoolconcepts 8.
57The behavior of the
58.Fl f
59option, and the device checks performed are described in the
60.Nm zpool Cm create
61subcommand.
62.Bl -tag -width Ds
63.It Fl f
64Forces use of
65.Ar vdev Ns s ,
66even if they appear in use or specify a conflicting replication level.
67Not all devices can be overridden in this manner.
68.It Fl g
69Display
70.Ar vdev ,
71GUIDs instead of the normal device names. These GUIDs can be used in place of
72device names for the zpool detach/offline/remove/replace commands.
73.It Fl L
74Display real paths for
75.Ar vdev Ns s
76resolving all symbolic links. This can be used to look up the current block
77device name regardless of the /dev/disk/ path used to open it.
78.It Fl n
79Displays the configuration that would be used without actually adding the
80.Ar vdev Ns s .
81The actual pool creation can still fail due to insufficient privileges or
82device sharing.
83.It Fl P
84Display real paths for
85.Ar vdev Ns s
86instead of only the last component of the path. This can be used in
87conjunction with the
88.Fl L
89flag.
90.It Fl o Ar property Ns = Ns Ar value
91Sets the given pool properties. See the
92.Xr zpoolprops 8
93manual page for a list of valid properties that can be set. The only property
94supported at the moment is ashift.
95.El
96.El
97.Sh SEE ALSO
98.Xr zpool-remove 8 ,
99.Xr zpool-attach 8 ,
100.Xr zpool-import 8 ,
101.Xr zpool-initialize 8 ,
102.Xr zpool-online 8
103