-
Notifications
You must be signed in to change notification settings - Fork 57
/
Copy pathiocage.8.txt
1491 lines (1016 loc) · 45.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 [-v] activate ZPOOL
iocage [-v] cap UUID|TAG
iocage [-v] clean [-f] [-a|-r|-j|-t]
iocage [-v] clone UUID|TAG [UUID|TAG@snapshot] [property=value]
iocage [-v] console [-f] UUID|TAG
iocage [-v] create [-e] [release=[RELEASE|NAME]] [pkglist=file] [property=value] [count=value]
iocage [-v] deactivate ZPOOL
iocage [-v] defaults
iocage [-v] destroy [-f] UUID|TAG
iocage [-v] df
iocage [-v] exec [-u username | -U username] UUID|TAG|ALL command [arg ...]
iocage [-v] export UUID|TAG
iocage [-v] fetch [-p|-P] [release=RELEASE | ftphost=ftp.hostname.org |
ftpdir=/dir/ | ftpfiles="base.txz doc.txz lib32.txz src.txz"]
[ ftplocaldir=/dir/ ] [ compression=ALGO ]
iocage [-v] get [-r] property|all UUID|TAG
iocage [-v] help
iocage [-v] import UUID [property=value]
iocage [-v] init-host IP ZPOOL
iocage [-v] inuse UUID|TAG
iocage [-v] pkg TAG pkg_cmd
iocage [-v] limits [UUID|TAG]
iocage [-v] list [-t|-r|-s jid|uuid|boot|state|tag|type|ip4]
iocage [-v] promote UUID|TAG
iocage [-v] rcboot
iocage [-v] reboot|restart [-s] UUID|TAG
iocage [-v] rcshutdown
iocage [-v] reset UUID|TAG|ALL
iocage [-v] rollback UUID|TAG@snapshotname
iocage [-v] runtime UUID|TAG
iocage [-v] send [-c|-i|-I|-h|-u|-m] POOL
iocage [-v] set property=value [property=value] UUID|TAG
iocage [-v] snaplist UUID|TAG
iocage [-v] snapmount UUID|TAG@snapshotname DESTINATION
iocage [-v] snapremove UUID|TAG@snapshotname|ALL
iocage [-v] snapshot|snap [-f|-r] UUID|TAG [UUID|TAG@snapshotname]
iocage [-v] snapumount UUID|TAG@snapshotname
iocage [-v] start [-f] UUID|TAG
iocage [-v] stop UUID|TAG|ALL
iocage [-v] uncap UUID|TAG
iocage [-v] update [-p|-P] UUID|TAG|RELEASE
iocage [-v] upgrade UUID|TAG [release=RELEASE]
iocage [-v] version | --version
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 or shared IP networking with optional support for resource
limits.
Both, shared IP based jails and VNET enabled jails are supported.
Each jail has a unique ID (UUID) automatically generated at creation time.
Using the UUID as a jail identifier means that a jail can be replicated in a
distributed environment with greater flexibility. This also eliminates
potential naming clashes on large scale deployments and helps reduce
operator error.
You can use either the full UUID or a jail's TAG with every operation.
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 if unset 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 and at least one ZFS pool must be present on the host
system. To enable all the features iocage supports, consider the following
optional kernel options and system requirements:
o FreeBSD 9.3-RELEASE amd64 or higher
o Kernel compiled with:
options VIMAGE
options RACCT
options RCTL
Calling iocage with the -v switch before a command will allow you to see the
how the shell is running each of the commands. It's very verbose.
SUBCOMMANDS
activate ZPOOL
Intended for automation tools. The pool can be activated for iocage jails
without requiring user input.
cap UUID|TAG
Reapply resource limits on jail while it is running.
clean [-f] [-a|-r|-j|-t]
This removes the ZFS datasets associated with the flag called. The -a flag
will destroy everything associated with iocage. The -r flag will destroy
all RELEASEs that have been fetched. Basejails rely on these to exist,
so be sure you don't use this flag if you have any. The -j flag will
destroy the jails dataset. The -t flag will destroy the templates dataset.
Same warning applies here as with cleaning the RELEASE dataset.
clone UUID|TAG [UUID|TAG@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 or TAG@snapshot.
Examples:
Clone the current state of the jail:
iocage clone UUID tag=www02
Clone a jail from a custom snapshot (snapshot taken previously):
iocage clone UUID@snapshotname tag=www02
console [-f] UUID|TAG
Execute login to have a shell inside the jail. If the -f flag is specified,
and the jail is not running it will be started for the console command.
create [-e] [base=[RELEASE|NAME]] [property=value] [property=value] [count=value]
By default create will deploy a new jail based on the host operating
system's release. This can be changed by specifying the base option.
By default a basejail is created that has a common shared base.
The -e switch will create an empty jail which can be used for unsupported
or custom jails.
Example: iocage create tag=www01 pkglist=$HOME/my-pkgs.txt
iocage create tag=mybasejail
iocage create tag=mybasejail base=10.2-RELEASE
iocage create tag=mycustombasejail base=nginx_postgres
By default only one jail will be created, but if you specify count=NUMBER,
then that many jails will be created.
Example: iocage create tag="mybasejail" host_hostname="mybasejail" count=10
This will create 10 jails with the tag mybasejail_{1-10}. The tag and
hostname will be incremented up with the number of jails you wish to create.
deactivate ZPOOL
Remove the comment that iocage uses to locate a usable pool.
defaults
Display all defaults set in the default dataset.
destroy [-f] UUID|TAG
Destroy given jail. This is irreversible, use with caution. If the jail is
running destroy action will fail.
With -f the jail will be destroyed without confirmation.
df
List disk space related information. Available fields:
CRT - compression ratio
RES - reserved space
QTA - disk quota
USE - used space
AVA - available space
TAG - jail name
exec [-u username | -U username] UUID|TAG|ALL command [arg ...]
Execute command inside the jail. This is simply an iocage UUID/tag wrapper
for jexec(8).
export UUID|TAG
Export a complete jail. An archive file is created in /iocage/images with
SHA256 checksum. Jail must be in stopped state before exporting.
fetch [-p|-P] [release=RELEASE | ftphost=ftp.hostname.org |
ftpdir=/dir/ | ftpfiles="base.txz doc.txz lib32.txz src.txz"]
[ ftplocaldir=/dir/ ] [ compression=ALGO ]
Used for downloading and updating/patching releases.
fetch must 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 by supplying the
required release property or just selecting the appropriate RELEASE from
the menu list.
Example: iocage fetch release=10.1-RELEASE
fetch can also used to update already downloaded releases. To update a local
release already present in iocage (iocage list -r) run:
iocage fetch release=10.1-RELEASE
This example will apply latest patches to 10.1-RELEASE base.
Newly created jails or basejails will automatically have the latest
updates applied.
Specifying -p or -P to fetch will have it also fetch a ports tree
that all basejails will share with that base.
compression: Compression is lz4 by default; see zfs(8) for the list of
compression algorithms available.
ftplocaldir: Specifying ftplocaldir=/dev/ will fetch release tar files from a
local system directory. This is useful when a user wants to use a custom build
release or use iocage offline.
Example: fetch release=10.2-RELEASE ftplocaldir=/fakeftp/release/10.2-RELEASE
get [-r] property|all UUID|TAG
Get named property or if "all" keyword is specified dump all properties
known to iocage.
To display whether resource limits are enforced for a jail:
iocage get rlimits UUID|TAG
iocage get -r rlimits
iocage get all UUID|TAG
help
This help file you are reading.
import UUID [property=value]
Import full jail images or differential packages. Images need to be
present in /iocage/images along with checksum files. You can use short
UUIDs - do not specify the full filename only the UUID. These jails
become what we call "thickjails" and are not supported for all operations.
init-host IP ZPOOL
Initialize a remote host for iocage. iocage will send all required ZFS
filesystems over the network to the host. This requires SSH working keys
installed for root.
inuse [UUID|TAG]
Display consumed resources for a jail. Without UUID or TAG dump all
resources for all running jails in a comma delimited form.
pkg TAG pkg_cmd
A convinience wrapper for pkg to manage your jails. Converts the given tag
to the JID of a running jail and executes `pkg -j JID pkg_cmd`.
limits [UUID|TAG]
Display active resource limits for a jail or all jails. With no UUID
supplied display all limits active for all jails.
list [-t|-r]
List all jails, if -t is specified list only templates,
with -r list downloaded releases.
Non iocage jails will be listed only if the jail is running.
promote UUID|TAG
Promote a cloned jail to a fully independent copy. For more details please
read zfs(8).
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.
reboot UUID|TAG
Fully stops the jail with `iocage stop` and, upon success, restarts it with
`iocage start`. If `-s` is specified it will instead do a soft restart
on the jail. The soft method will restart the jail without destroying
the jail's networking or the jail process itself. All processes are
gracefully restarted inside the jail. This is useful for quick and graceful
restarts.
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.
reset UUID|TAG|ALL
This will reset a jail's properties back to the defaults.
It reads from the properties set on the "default" dataset. TAG, UUID and
generated vnet mac addresses are carried forward.
Those will retain their values, even if you reset the jail.
You can also reset every jail to the default properties by using the
keyword "ALL".
restart UUID|TAG
Soft restart jail. Soft method will restart the jail without destroying
the jail's networking and the jail process itself. All processes are
gracefully restarted inside the jail. Useful for quick and graceful
restarts.
rollback UUID|TAG@snapshotname
Rollback to an existing snapshot. Any intermediate snapshots will be
destroyed. For more information on this functionality please read zfs(8).
runtime UUID|TAG
Show runtime configuration of a jail. Useful for debugging.
send [-c|-i|-I|-h|-u|-m] POOL
Will take a recursive snapshot of the POOL/iocage dataset and send it to
the specified pool. Supports remote, incremental and movement operations.
Moving (-m) is only available for local operations. Remote (-r) requires a
user (-u) and a host (-h) to be specified. It also requires publickey
authentication. If using incremental (-i) or Incremental (-I) be sure to
supply the flag for each snapshot.
If clean (-c) is provided, it will remove all snapshots from both the
source and destination pools. This cannot be used in combination with
incremental (-i) or Incremental (-i).
Local Example: iocage send newpool
Incremental Example: iocage send -i oldpool/iocage@snap1 -i oldpool/iocage@snap2 newpool
Remote Example: iocage send -r -u root -h some.host newpool
The received pool is not mounted if received locally, but is mounted if
received remotely.
set property=value [property=value] UUID|TAG
Set one or more properties to the supplied value.
snaplist UUID|TAG
List all snapshots belonging to jail.
NAME - snapshot name
CREATED - creation time
RSIZE - referenced size
USED - used space
snapmount UUID|TAG@snapshotname DESTINATION
This will mount the specified jail's snapshot on the location given.
snapremove UUID|TAG@snapshotname|ALL
Destroy specified jail snapshot. If the keyword ALL is specified all
snapshots will be destroyed for the jail.
snapshot|snap [-f|-r] UUID|TAG [UUID|TAG@snapshotname]
Create a ZFS snapshot for jail. If the -r flag is specified it will by
recursively snapshot POOL/iocage/jails/UUID. Otherwise it will only snapshot
POOL/iocage/jails/UUID/root. If no snapshot name is specified defaults
to auto snapshot name based on current date and time.
The -f flag is to bypass the interactive question if you have a running
database in the jail. Make sure to pass -f on it's own and first before any
other flag like -r.
Example: iocage snapshot -f -r JAIL
snapumount UUID|TAG@snapshotname
Will unmount the specified jail's snapshot.
start [-f] UUID|TAG
Start jail identified by UUID or TAG. If the -f switch is supplied, it will
force start a template for editing. This flag does not apply to normal
jails.
stop UUID|TAG|ALL
Stop jail identified by UUID or TAG. If ALL is specified, it will stop all
jails.
uncap UUID|TAG
Release all resource limits, disable limits on the fly.
update [-p|-P] UUID|TAG|RELEASE
Will reclone the jail if it is a basejail, otherwise it updates the jail
to the latest patch level. A back-out snapshot is created to allow
safe update/rollback.
If -p or -P along with a RELEASE are specified instead of a jail, it will
update that RELEASEs shared ports tree.
upgrade UUID|TAG [release=RELEASE]
By default this will upgrade jail RELEASE to match the host's RELEASE
unless another RELEASE is specified with the "release" property.
Please note: The upgrade process for basejails is done by setting the jail's
"release" property to the required new RELEASE and then merging /etc.
If you wish to do this yourself without having /etc merged do:
iocage set release=10.1-RELEASE UUID|TAG
For this the RELEASE must be locally available. The basejail
will re-clone its filesystems from the new release at next jail start.
WARNING: Cloned jails (deprecated) [-c] are not supported for upgrades.
Please use thick (deprecated) [-t] or our standard basejails for
this feature.
version | --version
List version number.
PROPERTIES
For more information on properties please check the relevant man page which
is noted under each property in the form of "Source: manpage". Source "local"
marks iocage specific properties.
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 a shared IP
configuration. Default is to auto-guess from a sysctl. If you don't
need a fully virtualized per jail network stack set it to off.
Default: auto-guess
Source: local
bpf=on | off
This controls whether to start the jail with BPF devices enabled.
Default is off.
Default: off
Source: local
dhcp=on | off
This controls whether to start the jail with DHCP.
Default is off, but if you want it on, vnet and bpf are required.
Default: off
Source: local
ip4_addr="interface|ip-address/netmask"
The IPv4 address for VNET and shared IP jails.
Form 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 the DEFAULT
tag is used instead of an interface, the interface will be
automatically assigned based upon the system's default interface.
If a netmask in either dotted-quad or CIDR form is given after IP
address, it will be used when adding the IP alias.
If the AUTOIP4 tag is used in place of an ip-address, the IP address
will be automatically assigned at first start of the jail. This
requires that the ip4_autostart and ip4_autoend variables are set on
the 'default' property source. If used, the IP4 address will be set
to the first available based upon the given range and already created
jails.
Example:
# iocage set ip4_autostart="100" default
# iocage set ip4_autoend="150" default
# iocage set ip4_autosubnet="24" default
This will result in the automatic IPv4 address being assigned in the
base range of the default network interface. I.E. if the local default
NIC is set to 192.168.0.XXX, then the new address will be
192.168.0.[100-150]/24
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.
defaultrouter6=none | ip6address
Setting this property to anything other than none will try to configure a
default IPv6 route inside a VNET jail.
resolver=none | nameserver IP;nameserver IP;search domain.local
Sets the jail's resolver (resolv.conf). Fields must be ; delimited
which are translated to newlines in resolv.conf.
If the resolver is set to none (default) the jail will inherit
the hosts resolv.conf file.
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_domainname="NIS domainname"
The NIS domainname of the jail.
Default: none
Source: jail(8)
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.
Note: This is not supported on FreeBSD 9.3.
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
mount_linprocfs=0 | 1
Mount a linprocfs(5) filesystem in the jail's /compat/linux/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="zfs_filesystem ..."
This is a space-separated list of datasets to be jailed and fully handed
over to a jail.
Takes a ZFS filesystem name; if it begins with "iocage/jails", it will be
created on the ZFS pool that iocage uses.
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
jail_zfs_mountpoint=/path/in/jail
If only a single ZFS filesystem is assigned to a jail via the
jail_zfs_dataset setting, this property may be used to manipulate its
mountpoint within the jail.
The default value of "none" allows the mountpoint to be managed
from within the jail by setting the ZFS "mountpoint" property on the
dataset directly.
When multiple ZFS filesystesm are assigned to a jail, this property
must be "none", and the filesystem mountpoints are manipulated directly
using the ZFS "mountpoint" properties for the assigned datasets.
Default: none
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. Prior to FreeBSD 11.0, 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. In
FreeBSD 11.0 and later, this setting is deprecated in favor
of sysvmsg, sysvsem, and sysvshm.
Default: 0
Source: jail(8)
sysvmsg=disable | inherit | new
Allow access to SYSV IPC message primitives. If set to
inherit, all IPC objects on the system are visible to this
jail, whether they were created by the jail itself, the base
system, or other jails. If set to new, the jail will have
its own key namespace, and can only see the objects that it
has created; the system (or parent jail) has access to the
jail's objects, but not to its keys. If set to disable, the
jail cannot perform any sysvmsg-related system calls.
Ignored in FreeBSD 10.3 and earlier.
Default: new
Source: jail(8)
sysvsem=disable | inherit | new
Allow access to SYSV IPC semaphore primitives in the same
manner as sysvmsg. Ignored in FreeBSD 10.3 and earlier.
Default: new
Source: jail(8)
sysvshm=disable | inherit | new
Allow access to SYSV IPC shared memory primitives in the
same manner as sysvmsg. Ignored in FreeBSD 10.3 and
earlier.
Default: new
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.
Note: This is not supported on FreeBSD 9.3.
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"