forked from iocage/iocage_legacy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathiocage.8.txt
1224 lines (824 loc) · 34.1 KB
/
iocage.8.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
NAME
iocage - jail manager amalgamating ZFS, VNET and resource limits
SYNOPSIS
iocage fetch [release=RELEASE | ftphost=ftp.hostname.org]
iocage create [-c|-e] [release=RELEASE] [pkglist=file] [property=value]
iocage clone UUID | UUID@snapshot [property=value]
iocage destroy UUID
iocage list [-t]
iocage start UUID
iocage stop UUID
iocage restart UUID
iocage rcboot
iocage rcshutdown
iocage console UUID
iocage chroot UUID [command]
iocage df
iocage show property
iocage get [property | all ] UUID
iocage set property=value UUID
iocage cap UUID
iocage limits [UUID]
iocage uncap UUID
iocage inuse UUID
iocage snapshot UUID | UUID@snapshotname
iocage snaplist UUID
iocage snapremove UUID@snapshotname
iocage rollback UUID@snapshotname
iocage promote UUID
iocage runtime UUID
iocage update UUID
iocage record start|stop UUID
iocage package UUID
iocage export UUID
iocage import UUID [property=value]
iocage defaults
iocage version | --version
iocage help
DESCRIPTION
iocage is a system administration tool for jails designed to simplify
jail management tasks. It abstracts away the management of ZFS backed jails running VNET
and shared IP networking with optional support for resource limits.
The older shared IP based jails are supported, VNET enabled jails
provide better isolation though.
Each jail has a unique ID (UUID) automatically generated at creation time.
Using UUID's as jail names means that a jail can be replicated in a
distributed environment with greater flexibility. This also eliminates
potential naming clashes on large scale deployments.
You can use shortened UUIDs, e.g. for adae47cb-01a8-11e4-aa78-3c970ea3222f
use adae47cb or just adae.
To ease jail identification a TAG field is included in list mode which can
be set to any string (hostname, label, note, etc.). By default the TAG field
contains the creation date and time stamp.
Properties are stored inside ZFS custom fields. This eliminates the need for
any configuration files and jails can be easily moved with ZFS send and
receive preserving all of their properties automatically.
iocage relies on ZFS, VIMAGE/VNET (this is optional).
To leverage all the whistles and bells iocage has to offer
consider the following optional kernel options and system reqiurements:
o FreeBSD 10.0-RELEASE amd64
o bridge interfaces (bridge0,bridge1) add:
cloned_interfaces="bridge0 bridge1" to /etc/rc.conf
o Kernel compiled with:
options VIMAGE
options RACCT
options RCTL
SUBCOMMANDS
fetch [release=RELEASE | ftphost=ftp.hostname.org]
fetch has to be executed as the first command on a pristine system. By
default fetch will download the host node's RELEASE for deployment. If
other releases are required this can be changed with supplying the
required release property.
Example: iocage fetch release=9.2-RELEASE
create [-c|-e] [release=RELEASE] [property=value] [property=value] ...
By default create will deploy a new jail based on the host operating
system's release. This can be changed by specifying the release option.
If the -c switch is specified the jail will be cloned from the release.
Default is to create a fully independent jail set. The -e switch will
create an empty jail.
Example: iocage create tag=www01 pkglist=/home/petert/my-pkgs.txt
clone UUID | UUID@snapshot [property=value]
Clone jail identified by UUID (ZFS clone). All properties will be reset on
the clone, defaults can be overridden by specifying properties on the fly.
Custom point-in-time snapshots can be used as a source for cloning in the
form of UUID@snapshot.
Examples:
Clone the current state of the jail:
iocage clone UUID tag=www02
Clone a jail from a custom snapshot:
iocage clone UUID@snapshotname tag=www02
destroy UUID
Destroy jail. This is irreversible, use with caution. If the jail is
running destroy action will fail.
list [-t]
List all jails, if -t is specified list only templates.
df
List disk space related information. Available fields:
CRT - compression ratio
RES - reserved space
QTA - disk quota
USE - used space
AVA - available space
start UUID
Start jail identified by UUID.
stop UUID
Stop jail identified by UUID.
restart UUID
Soft restart jail. Soft method will restart the jail without destroying
the jail's networking and the jail itself. All processes are gracefully
restarted inside the jail. Useful for quick and graceful restarts.
rcboot
Start all jails with "boot" property set to "on". Intended for boot time
execution. Jails will be started in an ordered fashion based on their
"priority" property.
rcshutdown
Stop all jails with "boot" property set to "on". Intended for full host shutdown.
Jails will be stopped in an ordered fashion based on their "priority"
property.
console UUID
Console access, drop into jail.
chroot UUID [command]
Chroot into jail, without actually starting the jail itself. Useful for
initial setup (set root password, configure networking). You can specify a
command just like with the normal system chroot tool.
show property
Shows the given property for all jails and templates. Useful to compare
settings/properties for all jails.
To get the last successfull start time for all jails:
iocage show last_started
get [property | all ] UUID
Get named property or if all is specified dump all properties known to
iocage.
To display whether resource limits are enforced for jail:
iocage get rlimits UUID
set property=value UUID
Set a property to value.
cap UUID
Reapply resource limits on jail while it is running.
limits [UUID]
Display active resource limits for a jail or all jails. With no UUID supplied
display all limits active for all jail.
uncap UUID
Release all resource limits, disable limits on the fly.
inuse UUID
Display consumed resources for jail.
snapshot UUID | UUID@snapshotname
Create a ZFS snapshot for jail. If no snapshot name is specified defaults
to auto snapshot name based on current date and time.
snaplist UUID
List all snapshots belonging to jail.
NAME - snapshot name
CREATED - creation time
RSIZE - referenced size
USED - used space
snapremove UUID@snapshotname
Destroy snapshot named snapshotname.
rollback UUID@snapshotname
Rollback to an existing snapshot named snapshotname. Any intermediate
snapshots will be deleted as well. For more info on this please read
zfs(8).
promote UUID
Promote a cloned jail to a fully independent copy. For more details please
read zfs(8).
runtime UUID
Show runtime configuration of a jail. Useful for debugging.
update UUID
Update jail to latest patch level. A back-out snapshot is created to allow
safe update/restore.
record start|stop UUID
The record function will record every changed file in a directory called
/iocage/jails/UUID/recorded. This is achieved by using a unionfs overlay
mount. Useful for differential package creation.
package UUID
Package recorded jail session into /iocage/packages. Creates SHA256
checksum and prunes empty directories, files and some residual files like
utx.* and .history. Before packaging any jails make sure no unwanted files
contaminated or leaked into the recorded session.
export UUID
Completely export jail. Archive is created in /iocage/images with SHA256
checksum. Jail must be in stopped state.
import UUID [property=value]
Import full jail images or differential packages. Images need to be
present in /iocage/images and packages in /iocage/packages along with
along with checksum files. You can use short UUIDs - do not specify the
the full filename only the UUID.
defaults
Display all defaults set in iocage itself.
version | --version
List version number.
help
List quick help.
PROPERTIES
For more information on properties please check the relevant man page which
is noted next to each property.
pkglist=none | path-to-file
A text file containing one package per line. These will be auto installed when
a jail is created. Works only in combination with the create subcommand.
Default: none
Source: local
vnet=on | off
This controls whether to start the jail with VNET or shared IP
configuration. Default is on - start VNET jail. If you don't need a fully
virtualized per jail network stack set it to off.
Default: on
Source: local
ip4_addr="interface|ip-address/netmask"
The IPv4 address for VNET and shared IP jails.
Format is: interface|ip-address/netmask
Multiple interfaces:
"interface|ip-address/netmask,interface|ip-address/netmask"
For shared IP jails if an interface is given before
the IP address, an alias for the address will be added to that
interface, as it is with the interface parameter. If a netmask
in either dotted-quad or CIDR form is given after IP address, it
will be used when adding the IP alias.
For VNET jails the interface will be configured with the IP addresses
listed.
Example: "vnet0|192.168.0.10/24,vnet1|10.1.1.10/24"
This would configure interfaces vnet0 and vnet1 in a VNET jail. In this
case no network configuration is necessary in the jail's rc.conf file.
Default: none
Source: jail(8)
ip4_saddrsel=1 | 0
Only takes effect when vnet=off.
A boolean option to change the formerly mentioned behaviour and
disable IPv4 source address selection for the prison in favour of
the primary IPv4 address of the jail. Source address selection
is enabled by default for all jails and the ip4_nosaddrsel
settting of a parent jail is not inherited for any child jails.
Default: 1
Source: jail(8)
ip4=new | disable | inherit
Only takes effect when vnet=off.
Control the availability of IPv4 addresses. Possible values are
"inherit" to allow unrestricted access to all system addresses,
"new" to restrict addresses via ip4.addr above, and "disable" to
stop the jail from using IPv4 entirely. Setting the ip4.addr
parameter implies a value of "new".
Default: new
Source: jail(8)
defaultrouter=none | ipaddress
Setting this property to anything other than none will try to configure a
default route inside a VNET jail.
ip6.addr, ip6.saddrsel, ip6
A set of IPv6 options for the prison, the counterparts to
ip4.addr, ip4.saddrsel and ip4 above.
interfaces=vnet0:bridge0,vnet1:bridge1 | vnet0:bridge0
By default there are two interfaces specified with their bridge
association. Up to four interfaces are supported. Interface configurations
are separated by commas. Format is interface:bridge, where left value is
the virtual VNET interface name, right value is the bridge name where the
virtual interface should be attached.
Default: vnet0:bridge0,vnet1:bridge1
Source: local
host_hostname=UUID
The hostname of the jail.
Default: UUID
Source: jail(8)
exec_fib=0 | 1 ..
The FIB (routing table) to set when running commands inside the jail.
Default: 0
Source: jail(8)
devfs_ruleset=4 | 0 ..
The number of the devfs ruleset that is enforced for mounting
devfs in this jail. A value of zero (default) means no ruleset
is enforced. Descendant jails inherit the parent jail's devfs
ruleset enforcement. Mounting devfs inside a jail is possible
only if the allow_mount and allow_mount_devfs permissions are
effective and enforce_statfs is set to a value lower than 2.
Devfs rules and rulesets cannot be viewed or modified from inside
a jail.
NOTE: It is important that only appropriate device nodes in devfs
be exposed to a jail; access to disk devices in the jail may permit
processes in the jail to bypass the jail sandboxing by modifying
files outside of the jail. See devfs(8) for information on
how to use devfs rules to limit access to entries in the per-jail
devfs. A simple devfs ruleset for jails is available as ruleset
#4 in /etc/defaults/devfs.rules
Default: 4
Source: jail(8)
mount_devfs=1 | 0
Mount a devfs(5) filesystem on the chrooted /dev directory, and
apply the ruleset in the devfs_ruleset parameter (or a default of
ruleset 4: devfsrules_jail) to restrict the devices visible
inside the jail.
Default: 1
Source: jail(8)
exec_start="/bin/sh /etc/rc"
Command(s) to run in the prison environment when a jail is created.
A typical command to run is "sh /etc/rc".
Default: /bin/sh /etc/rc
Source: jail(8)
exec_stop="/bin/sh /etc/rc.shutdown"
Command(s) to run in the prison environment before a jail is
removed, and after any exec_prestop commands have completed.
A typical command to run is "sh /etc/rc.shutdown".
Default: /bin/sh /etc/rc.shutdown
Source: jail(8)
exec_prestart="/usr/bin/true"
Command(s) to run in the system environment before a jail is started.
Default: /usr/bin/true
Source: jail(8)
exec_prestop="/usr/bin/true"
Command(s) to run in the system environment before a jail is stopped.
Default: /usr/bin/true
Source: jail(8)
exec_poststop="/usr/bin/true"
Command(s) to run in the system environment after a jail is stopped.
Default: /usr/bin/true
Source: jail(8)
exec_poststart="/usr/bin/true"
Command(s) to run in the system environment after a jail is started,
and after any exec_start commands have completed.
Default: /usr/bin/true
Source: jail(8)
exec_clean=1 | 0
Run commands in a clean environment. The environment is discarded
except for HOME, SHELL, TERM and USER. HOME and SHELL are
set to the target login's default values. USER is set to the
target login. TERM is imported from the current environment.
The environment variables from the login class capability database
for the target login are also set.
Default: 1
Source: jail(8)
exec_timeout=60 | 30 ..
The maximum amount of time to wait for a command to complete. If
a command is still running after this many seconds have passed,
the jail will be terminated.
Default: 60
Source: jail(8)
stop_timeout=30 | 60 ..
The maximum amount of time to wait for a jail's processes to
exit after sending them a SIGTERM signal (which happens after the
exec_stop commands have completed). After this many seconds have
passed, the jail will be removed, which will kill any remaining
processes. If this is set to zero, no SIGTERM is sent and the
prison is immediately removed.
Default: 30
Source: jail(8)
exec_jail_user=root
The user to run commands as, when running in the jail environment.
Default: root
Source: jail(8)
exec_system_jail_user=0 | 1
This boolean option looks for the exec_jail_user in the system
passwd(5) file, instead of in the jail's file.
Default: 0
Source: jail(8)
exec_system_user=root
The user to run commands as, when running in the system environment.
The default is to run the commands as the current user.
Default: root
Source: jail(8)
mount_fdescfs=1 | 0
Mount a fdescfs(5) filesystem in the jail's /dev/fd directory.
Default: 1
Source: jail(8)
mount_procfs=0 | 1
Mount a procfs(5) filesystem in the jail's /dev/proc directory.
Default: 0
Source: local
enforce_statfs=2 | 1 | 0
This determines which information processes in a jail are able to
get about mount points. It affects the behaviour of the following
syscalls: statfs(2), fstatfs(2), getfsstat(2) and fhstatfs(2)
(as well as similar compatibility syscalls). When set to 0, all
mount points are available without any restrictions. When set to 1,
only mount points below the jail's chroot directory are visible
In addition to that, the path to the jail's chroot directory
is removed from the front of their pathnames. When set to 2
(default), above syscalls can operate only on a mount-point where
the jail's chroot directory is located.
Default: 2. jail(8)
children_max=0 | ..
The number of child jails allowed to be created by this jail (or
by other jails under this jail). This limit is zero by default,
indicating the jail is not allowed to create child jails. See
the Hierarchical Jails section for more information in jail(8).
Default: 0
Source: jail(8)
login_flags="-f root"
Supply these flags to login when logging in to jails with the console function.
Default: -f root
Source: login(1)
jail_zfs=on | off
Enables automatic ZFS jailing inside the jail. Assigned ZFS dataset will
be fully controlled by the jail.
NOTE: Setting this to "on" automatically enables allow_mount=1
enforce_statfs=1 and allow_mount_zfs=1! These are dependent options
required for ZFS management inside a jail.
Default: off
Source: local
jail_zfs_dataset=iocage/jails/UUID/root/data | zfs_filesystem
This is the dataset to be jailed and fully handed over to a jail. Takes
the ZFS filesystem name without pool name.
NOTE: only valid if jail_zfs=on. By default the mountpoint is set to none,
to mount this dataset set its mountpoint inside the jail i.e. "zfs set
mountpoint=/data full-dataset-name" and issue "mount -a".
Default: iocage/jails/UUID/root/data
Source: local
securelevel=3 | 2 | 1 | 0 | -1
The value of the jail's kern.securelevel sysctl. A jail never
has a lower securelevel than the default system, but by setting
this parameter it may have a higher one. If the system
securelevel is changed, any jail securelevels will be at least as
secure.
Default: 2
Source: jail(8)
allow_set_hostname=1 | 0
The jail's hostname may be changed via hostname(1) or sethostname(3).
Default: 1
Source: jail(8)
allow_sysvipc=0 | 1
A process within the jail has access to System V IPC
primitives. In the current jail implementation, System V
primitives share a single namespace across the host and
jail environments, meaning that processes within a jail
would be able to communicate with (and potentially interfere
with) processes outside of the jail, and in other jails.
Default: 0
Source: jail(8)
allow_raw_sockets=0 | 1
The prison root is allowed to create raw sockets. Setting
this parameter allows utilities like ping(8) and
traceroute(8) to operate inside the prison. If this is
set, the source IP addresses are enforced to comply with
the IP address bound to the jail, regardless of whether
or not the IP_HDRINCL flag has been set on the socket.
Since raw sockets can be used to configure and interact
with various network subsystems, extra caution should be
used where privileged access to jails is given out to
untrusted parties.
Default: 0
Source: jail(8)
allow_chflags=0 | 1
Normally, privileged users inside a jail are treated as
unprivileged by chflags(2). When this parameter is set,
such users are treated as privileged, and may manipulate
system file flags subject to the usual constraints on
kern.securelevel.
Default: 0
Source: jail(8)
allow_mount=0 | 1
privileged users inside the jail will be able to mount
and unmount file system types marked as jail-friendly.
The lsvfs(1) command can be used to find file system
types available for mount from within a jail. This permission
is effective only if enforce_statfs is set to a
value lower than 2.
Default: 0
Source: jail(8)
allow_mount_devfs=0 | 1
privileged users inside the jail will be able to mount
and unmount the devfs file system. This permission is
effective only together with allow.mount and if
enforce_statfs is set to a value lower than 2. Please
consider restricting the devfs ruleset with the
devfs_ruleset option.
Default: 0
Source: jail(8)
allow_mount_nullfs=0 | 1
privileged users inside the jail will be able to mount
and unmount the nullfs file system. This permission is
effective only together with allow_mount and if
enforce_statfs is set to a value lower than 2.
Default: 0
Source: jail(8)
allow_mount_procfs=0 | 1
privileged users inside the jail will be able to mount
and unmount the procfs file system. This permission is
effective only together with allow.mount and if
enforce_statfs is set to a value lower than 2.
Default: 0
Source: jail(8)
allow_mount_tmpfs=0 | 1
privileged users inside the jail will be able to mount
and unmount the tmpfs file system. This permission is
effective only together with allow.mount and if
enforce_statfs is set to a value lower than 2.
Default: 0
Source: jail(8)
allow_mount_zfs=0 | 1
privileged users inside the jail will be able to mount
and unmount the ZFS file system. This permission is
effective only together with allow.mount and if
enforce_statfs is set to a value lower than 2. See
zfs(8) for information on how to configure the ZFS
filesystem to operate from within a jail.
Default: 0
Source: jail(8)
allow_quotas=0 | 1
The jail root may administer quotas on the jail's
filesystem(s). This includes filesystems that the jail
may share with other jails or with non-jailed parts of
the system.
Default: 0
Source: jail(8)
allow_socket_af=0 | 1
Sockets within a jail are normally restricted to IPv4,
IPv6, local (UNIX), and route. This allows access to
other protocol stacks that have not had jail functionality
added to them.
Default: 0
Source: jail(8)
host_hostuuid=UUID
Default: UUID
Source: jail(8)
tag="any string"
Custom string for aliasing jails.
Default: date@time
Source: local
template=yes | no
This property controls whether the jail is a template. Templates are not
started by iocage. Set to yes if you intend to convert jail into template.
(See EXAMPLES section)
Default: no
Source: local
boot=on | off
If set to "on" jail will be auto-started at boot time (rcboot subcommand)
and stopped at shutdown time (rcshutdown subcommand). Jails will be started
and stopped based on their priority value.
Default: off
Source: local
notes="any string"
Custom notes for miscelanious tagging.
Default: none
Source: local
owner=root
The owner of the jail, can be any string.
Default: root
Source: local
priority=99 | 50 ..
Start priority at boot time, smaller value means higher priority.
Also, for shutdown the order will be reversed.
Default: 99.
last_started
Last successful start time. Auto set every time jail starts.
Default: timestamp
Source: local
type=jail
Currently only jail is supported - this is for future use.
Default: jail
Source: local
hostid=UUID
The UUID of the host node. Jails won't start if this property differs from the actual UUID
of the host node. This is to safeguard jails from being started on
different nodes in case they are periodically replicated across.
Default: UUID of the host (taken from /etc/hostid)
Source: local
release=10.0-RELEASE | 9.2-RELEASE
The RELEASE used at creation time. Can be set to any string if needed.
Default: the host's RELEASE
Source: local
compression=on | off | lzjb | gzip | gzip-N | zle | lz4
Controls the compression algorithm used for this dataset. The lzjb
compression algorithm is optimized for performance while providing
decent data compression. Setting compression to on uses the lzjb compression
algorithm. The gzip compression algorithm uses the same compression
as the gzip(1) command. You can specify the gzip level by
using the value gzip-N where N is an integer from 1 (fastest) to 9
(best compression ratio). Currently, gzip is equivalent to gzip-6
(which is also the default for gzip(1)). The zle compression algorithm
compresses runs of zeros.
The lz4 compression algorithm is a high-performance replacement for
the lzjb algorithm. It features significantly faster compression and
decompression, as well as a moderately higher compression ratio than
lzjb, but can only be used on pools with the lz4_compress feature set
to enabled. See zpool-features(7) for details on ZFS feature flags
and the lz4_compress feature.
This property can also be referred to by its shortened column name
compress. Changing this property affects only newly-written data.
Default: lz4
Source: zfs(8)
origin
This is only set for clones. Read-only.
For cloned file systems or volumes, the snapshot from which the clone
was created. See also the clones property.
Default: -
Source: zfs(8)
quota=15G | 50G | ..
Quota for jail.
Limits the amount of space a dataset and its descendents can consume.
This property enforces a hard limit on the amount of space used. This
includes all space consumed by descendents, including file systems
and snapshots. Setting a quota on a descendent of a dataset that
already has a quota does not override the ancestor's quota, but
rather imposes an additional limit.
Default: 15G
Source: zfs(8)
mountpoint
Path for the jail's root filesystem. Don't tweak this or jail won't start!
Default: set to jail's root
Source: zfs(8)
compressratio
Compression ratio. Read-only.
For non-snapshots, the compression ratio achieved for the used space
of this dataset, expressed as a multiplier. The used property
includes descendant datasets, and, for clones, does not include the
space shared with the origin snapshot.
Source: zfs(8)
available
Available space in jail's dataset.
The amount of space available to the dataset and all its children,
assuming that there is no other activity in the pool. Because space
is shared within a pool, availability can be limited by any number of
factors, including physical pool size, quotas, reservations, or other
datasets within the pool.
Source: zfs(8)
used
Used space by jail. Read-only.
The amount of space consumed by this dataset and all its descendents.
This is the value that is checked against this dataset's quota and
reservation. The space used does not include this dataset's reservation,
but does take into account the reservations of any descendent
datasets. The amount of space that a dataset consumes from its parent,
as well as the amount of space that are freed if this dataset is
recursively destroyed, is the greater of its space used and its
reservation.
When snapshots (see the "Snapshots" section) are created, their space
is initially shared between the snapshot and the file system, and
possibly with previous snapshots. As the file system changes, space
that was previously shared becomes unique to the snapshot, and
counted in the snapshot's space used. Additionally, deleting snapshots
can increase the amount of space unique to (and used by) other
snapshots.
The amount of space used, available, or referenced does not take into
account pending changes. Pending changes are generally accounted for
within a few seconds. Committing a change to a disk using fsync(2) or
O_SYNC does not necessarily guarantee that the space usage information
is updated immediately.
Source: zfs(8)
dedup=on | off | verify | sha256[,verify]
Deduplication for jail.
Configures deduplication for a dataset. The default value is off.
The default deduplication checksum is sha256 (this may change in the
future). When dedup is enabled, the checksum defined here overrides
the checksum property. Setting the value to verify has the same
effect as the setting sha256,verify.
If set to verify, ZFS will do a byte-to-byte comparsion in case of
two blocks having the same signature to make sure the block contents
are identical.
Default: off.
Source: zfs(8)
reservation=size | none
Reserved space for jail.
The minimum amount of space guaranteed to a dataset and its descendents.
When the amount of space used is below this value, the dataset
is treated as if it were taking up the amount of space specified by
its reservation. Reservations are accounted for in the parent
datasets' space used, and count against the parent datasets' quotas
and reservations.
Default: none
Source: zfs(8)
sync_target
This is for future use, currently not supported.
sync_tgt_zpool
This is for future use, currently not supported.
rlimits=on | off
If set to "on" resource limits will be enforced.
Default: off
Source: local
cpuset=1 | 1,2,3,4 | 1-2 | off
Controls the jail's CPU affinity. For more details please refer to cpuset(1).
Default: off
Source: cpuset(1)
RESOURCE LIMITS
Resource limits (except cpuset and rlimits) use the following value
field formatting in the property: limit:action.
Limit defines how much of the resource a process can use before the
defined action triggers.
Action defines what will happen when a process exceeds the allowed
amount.
Valid actions are:
deny deny the allocation; not supported for cpu and
wallclock
log log a warning to the console
devctl send notification to devd(8)
sig* e.g. sigterm; send a signal to the offending
process
To better understand what this means please read rctl(8)
before enabling any limits.
The following resource limits are supported:
memoryuse=limit:action | off
Limits the resident set size (DRAM).
Default: 8G:log
Source: rctl(8)
memorylocked=limit:action | off
Limits locked memory.
Default: off
Source: rctl(8)
vmemoryuse=limit:action | off
Virtual memory limit (swap + DRAM combined)