1.\" Copyright (c) 2016 Andriy Gapon 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd July 22, 2020 28.Dt ZFSBOOTCFG 8 29.Os 30.Sh NAME 31.Nm zfsbootcfg 32.Nd "specify zfsboot options for the next boot" 33.Sh SYNOPSIS 34.Nm 35.Ao Ar options Ac 36.Nm 37.Op Fl n Ar name 38.Op Fl k Ar key 39.Op Fl p 40.Op Fl t Ar type 41.Op Fl v Ar value 42.Op Fl z Ar pool 43.Nm 44.Sh DESCRIPTION 45.Nm 46is used to set 47.Xr boot.config 5 Ns -style 48options to be used by 49.Xr zfsboot 8 , 50.Xr gptzfsboot 8 51or 52.Xr loader 8 53the next time the machine is booted. 54Once 55.Xr zfsboot 8 56or 57.Xr gptzfsboot 8 58or 59.Xr loader 8 60reads the information, it is deleted. 61If booting fails, the machine automatically reverts to the previous 62boot configuration. 63The information is stored in a special boot environment area of a ZFS pool. 64.Pp 65If used without arguments, 66.Nm 67will output the current boot configuration, if set. 68.Pp 69The following options are supported by 70.Nm : 71.Bl -tag -width indent 72.It Fl k Ar key 73Define key for 74.Ao key , value Ac 75pair. 76.It Fl n Ar name 77Update nvlist 78.Ar name . 79.It Fl p 80Print all information stored in ZFS pool bootenv area. 81.It Fl t Ar type 82Set type of 83.Ar value 84used in 85.Ao key , value Ac 86pair. 87Currently supported types are: 88.Bl -tag -width indent -compact 89.It Ar DATA_TYPE_BYTE 90.It Ar DATA_TYPE_INT8 91.It Ar DATA_TYPE_UINT8 92.It Ar DATA_TYPE_INT16 93.It Ar DATA_TYPE_UINT16 94.It Ar DATA_TYPE_INT32 95.It Ar DATA_TYPE_UINT32 96.It Ar DATA_TYPE_INT64 97.It Ar DATA_TYPE_UINT64 98.It Ar DATA_TYPE_BOOLEAN_VALUE 99.It Ar DATA_TYPE_STRING 100.El 101.Pp 102If not specified, the default is 103.Ar DATA_TYPE_STRING . 104.It Fl v Ar value 105Define value for 106.Ao key , value Ac 107pair. 108.It Fl z Ar pool 109Operate on 110.Ar pool . 111.El 112.Sh ENVIRONMENT 113.Bl -tag -width vfs.root.mountfrom -compact 114.It Ev vfs.root.mountfrom 115The 116.Xr kenv 1 117variable that identifies a pool for which the options are written. 118.El 119.Sh EXAMPLES 120Try to boot to a new 121.Em boot environment 122without changing the 123.Cm bootfs 124property of a pool: 125.Pp 126.Dl "zfsbootcfg ""zfs:tank/ROOT/newbe:"" 127.Pp 128To clear the boot options: 129.Pp 130.Dl "zfsbootcfg """" 131.Sh SEE ALSO 132.Xr boot.config 5 , 133.Xr bectl 8 , 134.Xr gptzfsboot 8 , 135.Xr loader 8 , 136.Xr zfsboot 8 137.Sh HISTORY 138.Nm 139appeared in 140.Fx 11.1 . 141.Sh AUTHORS 142This manual page was written by 143.An Andriy Gapon Aq Mt avg@FreeBSD.org . 144