Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ZPOOL-GET(8)		     System Manager's Manual		    ZPOOL-GET(8)

NAME
     zpool-get -- retrieve properties of ZFS storage pools

SYNOPSIS
     zpool get [-Hp] [-j [--json-int, --json-pool-key-guid]]
	   [-o field[,field]]a| all|property[,property]a| [pool]a|
     zpool get [-Hp] [-j [--json-int]] [-o field[,field]]a|
	   all|property[,property]a| pool [all-vdevs|vdev]a|
     zpool set property=value pool
     zpool set property=value pool vdev

DESCRIPTION
     zpool    get    [-Hp]    [-j    [--json-int,   --json-pool-key-guid]]   [-o
	     field[,field]]a| all|property[,property]a| [pool]a|
	     Retrieves the given list of properties (or all properties if all is
	     used) for the specified storage pool(s).  These properties are dis-
	     played with the following fields:
		   name      Name of storage pool.
		   property  Property name.
		   value     Property value.
		   source    Property source, either default or local.

	     See the zpoolprops(7) manual  page  for  more  information  on  the
	     available pool properties.
		   -j, --json [--json-int, --json-pool-key-guid]
			     Display  the  list  of  properties  in JSON format.
			     Specify --json-int to display the numbers in  inte-
			     ger  format  instead  of  strings	in  JSON output.
			     Specify --json-pool-key-guid to set  pool	GUID  as
			     key for pool objects instead of pool name.
		   -H	     Scripted  mode.   Do not display headers, and sepa-
			     rate fields by a single tab  instead  of  arbitrary
			     space.
		   -o field  A	comma-separated  list of columns to display, de-
			     faults to name,property,value,source.
		   -p	     Display numbers in parsable (exact) values.

     zpool    get    [-j    [--json-int]]     [-Hp]	[-o	field[,field]]a|
	     all|property[,property]a| pool [all-vdevs|vdev]a|
	     Retrieves the given list of properties (or all properties if all is
	     used)  for  the specified vdevs (or all vdevs if all-vdevs is used)
	     in the specified pool.  These properties  are  displayed  with  the
	     following fields:
		   name      Name of vdev.
		   property  Property name.
		   value     Property value.
		   source    Property source, either default or local.

	     See the vdevprops(7) manual page for more information on the avail-
	     able pool properties.
		   -j, --json [--json-int]
			     Display  the  list  of  properties  in JSON format.
			     Specify --json-int to display the numbers in  inte-
			     ger format instead of strings in JSON output.
		   -H	     Scripted  mode.   Do not display headers, and sepa-
			     rate fields by a single tab  instead  of  arbitrary
			     space.
		   -o field  A	comma-separated  list of columns to display, de-
			     faults to name,property,value,source.
		   -p	     Display numbers in parsable (exact) values.

     zpool set property=value pool
	     Sets the given property on the  specified	pool.	See  the  zpool-
	     props(7) manual page for more information on what properties can be
	     set and acceptable values.

     zpool set property=value pool vdev
	     Sets  the	given  property  on  the specified vdev in the specified
	     pool.  See the vdevprops(7) manual page  for  more  information  on
	     what properties can be set and acceptable values.

SEE ALSO
     vdevprops(7), zpool-features(7), zpoolprops(7), zpool-list(8)

FreeBSD ports 15.quarterly	October 12, 2024		    ZPOOL-GET(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=zpool-get&sektion=8&manpath=FreeBSD+15.1-RELEASE+and+Ports.quarterly>

home | help