[mirror_zfs.git] / man / man8 / zpool-get.8

.\"
.\" CDDL HEADER START
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\" CDDL HEADER END
.\"
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
.\" Copyright (c) 2017 Datto Inc.
.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
.\" Copyright 2017 Nexenta Systems, Inc.
.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
.\"
.Dd August 9, 2019
.Dt ZPOOL-GET 8
.Os
.
.Sh NAME
.Nm zpool-get
.Nd retrieve properties of ZFS storage pools
.Sh SYNOPSIS
.Nm zpool
.Cm get
.Op Fl Hp
.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns …
.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns …
.Oo Ar pool Oc Ns …
.Nm zpool
.Cm set
.Ar property Ns = Ns Ar value
.Ar pool
.
.Sh DESCRIPTION
.Bl -tag -width Ds
.It Xo
.Nm zpool
.Cm get
.Op Fl Hp
.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns …
.Sy all Ns | Ns Ar property Ns Oo , Ns Ar property Oc Ns …
.Oo Ar pool Oc Ns …
.Xc
Retrieves the given list of properties
.Po
or all properties if
.Sy all
is used
.Pc
for the specified storage pool(s).
These properties are displayed with the following fields:
.Bl -tag -compact -offset Ds -width "property"
.It Sy name
Name of storage pool.
.It Sy property
Property name.
.It Sy value
Property value.
.It Sy source
Property source, either
.Sy default No or Sy local .
.El
.Pp
See the
.Xr zpoolprops 7
manual page for more information on the available pool properties.
.Bl -tag -compact -offset Ds -width "-o field"
.It Fl H
Scripted mode.
Do not display headers, and separate fields by a single tab instead of arbitrary
space.
.It Fl o Ar field
A comma-separated list of columns to display, defaults to
.Sy name , Ns Sy property , Ns Sy value , Ns Sy source .
.It Fl p
Display numbers in parsable (exact) values.
.El
.It Xo
.Nm zpool
.Cm set
.Ar property Ns = Ns Ar value
.Ar pool
.Xc
Sets the given property on the specified pool.
See the
.Xr zpoolprops 7
manual page for more information on what properties can be set and acceptable
values.
.El
.
.Sh SEE ALSO
.Xr zpool-features 7 ,
.Xr zpoolprops 7 ,
.Xr zpool-list 8
Commit	Line	Data
c5ebfbbe RW	1	.\"
	2	.\" CDDL HEADER START
	3	.\"
	4	.\" The contents of this file are subject to the terms of the
	5	.\" Common Development and Distribution License (the "License").
	6	.\" You may not use this file except in compliance with the License.
	7	.\"
	8	.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	9	.\" or http://www.opensolaris.org/os/licensing.
	10	.\" See the License for the specific language governing permissions
	11	.\" and limitations under the License.
	12	.\"
	13	.\" When distributing Covered Code, include this CDDL HEADER in each
	14	.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	15	.\" If applicable, add the following below this CDDL HEADER, with the
	16	.\" fields enclosed by brackets "[]" replaced with your own identifying
	17	.\" information: Portions Copyright [yyyy] [name of copyright owner]
	18	.\"
	19	.\" CDDL HEADER END
	20	.\"
c5ebfbbe RW	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-GET 8
6706552e	31	.Os
f84fe3fc	32	.
c5ebfbbe	33	.Sh NAME
1e36af8c	34	.Nm zpool-get
f84fe3fc	35	.Nd retrieve properties of ZFS storage pools
c5ebfbbe	36	.Sh SYNOPSIS
1e36af8c	37	.Nm zpool
c5ebfbbe RW	38	.Cm get
c5ebfbbe RW	39	.Op Fl Hp
f84fe3fc AZ	40	.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns …
	41	.Sy all Ns \| Ns Ar property Ns Oo , Ns Ar property Oc Ns …
	42	.Oo Ar pool Oc Ns …
1e36af8c	43	.Nm zpool
c5ebfbbe RW	44	.Cm set
	45	.Ar property Ns = Ns Ar value
	46	.Ar pool
f84fe3fc	47	.
c5ebfbbe RW	48	.Sh DESCRIPTION
	49	.Bl -tag -width Ds
	50	.It Xo
1e36af8c	51	.Nm zpool
c5ebfbbe RW	52	.Cm get
c5ebfbbe RW	53	.Op Fl Hp
f84fe3fc AZ	54	.Op Fl o Ar field Ns Oo , Ns Ar field Oc Ns …
	55	.Sy all Ns \| Ns Ar property Ns Oo , Ns Ar property Oc Ns …
	56	.Oo Ar pool Oc Ns …
c5ebfbbe RW	57	.Xc
	58	Retrieves the given list of properties
	59	.Po
	60	or all properties if
	61	.Sy all
	62	is used
	63	.Pc
	64	for the specified storage pool(s).
	65	These properties are displayed with the following fields:
f84fe3fc AZ	66	.Bl -tag -compact -offset Ds -width "property"
	67	.It Sy name
	68	Name of storage pool.
	69	.It Sy property
	70	Property name.
	71	.It Sy value
	72	Property value.
	73	.It Sy source
	74	Property source, either
	75	.Sy default No or Sy local .
	76	.El
c5ebfbbe RW	77	.Pp
c5ebfbbe RW	78	See the
2badb345	79	.Xr zpoolprops 7
c5ebfbbe	80	manual page for more information on the available pool properties.
f84fe3fc	81	.Bl -tag -compact -offset Ds -width "-o field"
c5ebfbbe RW	82	.It Fl H
	83	Scripted mode.
	84	Do not display headers, and separate fields by a single tab instead of arbitrary
	85	space.
	86	.It Fl o Ar field
f84fe3fc AZ	87	A comma-separated list of columns to display, defaults to
f84fe3fc AZ	88	.Sy name , Ns Sy property , Ns Sy value , Ns Sy source .
c5ebfbbe RW	89	.It Fl p
	90	Display numbers in parsable (exact) values.
	91	.El
	92	.It Xo
1e36af8c	93	.Nm zpool
c5ebfbbe RW	94	.Cm set
	95	.Ar property Ns = Ns Ar value
	96	.Ar pool
	97	.Xc
	98	Sets the given property on the specified pool.
	99	See the
2badb345	100	.Xr zpoolprops 7
c5ebfbbe RW	101	manual page for more information on what properties can be set and acceptable
	102	values.
	103	.El
f84fe3fc	104	.
c5ebfbbe	105	.Sh SEE ALSO
2badb345 AZ	106	.Xr zpool-features 7 ,
	107	.Xr zpoolprops 7 ,
	108	.Xr zpool-list 8