FRG: Plugins

Descriptions of each field in the Plugins section of the TrueNAS web interface.

  8 minute read

Add

General Options

Plugin NameRequired. Can contain letters, numbers, periods (.), dashes (-), and underscores (_).
Jail NameRequired. Can contain letters, numbers, periods (.), dashes (-), and underscores (_).
DHCPSet to autoconfigure jail networking with the Dynamic Host Configuration Protocol. VNET and Berkeley Packet Filter must also be enabled.
NATNetwork Address Translation (NAT). Transforms local network IP addresses into a single IP address. Set when the jail will share a single connection to the Internet with other systems on the network.
IPv4 InterfaceIPv4 interface for the jail.
IPv4 AddressEnter the IPv4 address for VNET(9) and shared IP jails.
IPv4 NetmaskIPv4 netmask for the jail.
IPv6 InterfaceIPv6 interface for the jail.
IPv6 AddressEnter the IPv6 address for VNET(9) and shared IP jails.
IPv6 NetmaskIPv6 prefix for the jail.

Advanced

Basic Properties

Plugin NameRequired. Can contain letters, numbers, periods (.), dashes (-), and underscores (_).
Jail NameRequired. Can contain letters, numbers, periods (.), dashes (-), and underscores (_).
DHCP Autoconfigure IPv4Set to autoconfigure jail networking with the Dynamic Host Configuration Protocol. VNET and Berkeley Packet Filter must also be enabled.
NATNetwork Address Translation (NAT). Transforms local network IP addresses into a single IP address. Set when the jail will share a single connection to the Internet with other systems on the network.
VNETSet to use VNET(9) to emulate network devices for the jail. A fully virtualized per-jail network stack will be installed.
Berkeley Packet FilterSet to use the Berkeley Packet Filter (BPF(4)) to data link layers in a protocol independent fashion.
vnet_default_interfaceSet the default VNET interface. Only takes effect when VNET is set. Choose a specific interface or set to auto to use the interface that has the default route. Choose none to not set a default VNET interface.
IPv4 InterfaceIPv4 interface for the jail.
IPv4 AddressEnter the IPv4 address for VNET(9) and shared IP jails.
IPv4 NetmaskIPv4 netmask for the jail.
IPv4 Default RouterA valid IPv4 address to use as the default route. Enter none to configure the jail with no IPv4 default route. A jail without a default route will not be able to access any networks.
AutoConfigure IPv6Set to use SLAAC (Stateless Address Auto Configuration) to autoconfigure IPv6 in the jail.
IPv6 InterfaceIPv6 interface for the jail.
IPv6 AddressEnter the IPv6 address for VNET(9) and shared IP jails.
IPv6 NetmaskIPv6 prefix for the jail.
IPv6 Default RouterA valid IPv6 address to use as the default route. Enter none to configure the jail without an IPv6 default route. A jail without a default route will not be able to access any networks.
Auto StartSet to auto-start the jail at system boot time. Jails are started and stopped based on iocage priority. Set in the priority field under Custom Properties.

Jail Properties

devfs_rulesetThe devfs(8) ruleset number to enforce when mounting devfs in the jail. The default 0 means no ruleset is enforced. Mounting devfs inside a jail is only possible when the allow_mount and allow_mount_devfs permissions are enabled and enforce_statfs is set to a value lower than 2.
--
exec_startCommands to run in the jail environment when the jail is created. Example: sh /etc/rc. The pseudo-parameters section of JAIL(8) describes exec.start usage.
exec_stopCommands to run in the jail environment before the jail is removed and after exec.prestop commands are complete. Example: sh /etc/rc.shutdown.
exec_prestartCommands to run in the system environment before a jail is started.
exec_poststartCommands to run in the system environment after a jail is started and after any exec_start commands are finished.
exec_prestopCommands to run in the system environment before a jail is stopped.
exec_poststopCommands to run in the system environment after a jail is stopped.
exec_jail_userEnter either root or another valid username. Inside the jail, commands run as this user.
exec_system_userRun commands in the jail as this user. By default, commands are run as the current user.
securelevelThe value of the jail securelevel sysctl. A jail never has a lower securelevel than the host system. Setting this parameter allows a higher securelevel. If the host system securelevel is changed, the jail securelevel will be at least as secure.
sysvmsgAllow or deny access to SYSV IPC message primitives. Inherit: All IPC objects on the system are visible to the jail. New: Only objects the jail creates using the private key namespace are visible. The system and parent jails have access to the jail objects but not private keys. Disable: The jail cannot perform any sysvmsg related system calls.
sysvsemAllow or deny access to SYSV IPC semaphore primitives. Inherit: All IPC objects on the system are visible to the jail. New: Only objects the jail creates using the private key namespace are visible. The system and parent jails have access to the jail objects but not private keys. Disable: The jail cannot perform any sysvmem related system calls.
sysvshmAllow or deny access to SYSV IPC shared memory primitives. Inherit: All IPC objects on the system are visible to the jail. New: Only objects the jail creates using the private key namespace are visible. The system and parent jails have access to the jail objects but not private keys.
vnet_interfacesA space-delimited list of network interfaces attached to a VNET enabled jail after it is created. Interfaces are automatically released when the jail is removed.
allow_set_hostnameAllow the jail hostname to be changed with hostname(1) or sethostname(3).
allow_sysvipcChoose whether a process in the jail has access to System V IPC primitives. Equivalent to setting sysvmsg, sysvsem, and sysvshm to Inherit. Deprecated in FreeBSD 11.0 and newer! Use sysvmsg, sysvsem, and sysvshm instead.
allow_raw_socketsSet to allow raw sockets. Utilities like ping(8) and traceroute(8) require raw sockets. When set, source IP addresses are enforced to comply with the IP addresses bound to the jail, ignoring the IP_HDRINCL flag on the socket.
allow_chflagsSet to treat jail users as privileged and allow the manipulation of system file flags. securelevel constraints are still enforced.
allow_mlockEnable running services that require mlock(2) in a jail.
allow_vmmAllow the jail to access the bhyve virtual machine monitor (VMM). The jail must have FreeBSD 12.0 or newer installed with the vmm(4) kernel module loaded.
allow_quotasSet to allow the jail root to administer quotas on jail filesystems. This includes filesystems the jail shares with other jails or with non-jailed parts of the system.
allow_socket_afSet to allow access to other protocol stacks beyond IPv4, IPv6, local (UNIX), and route. Warning: jail functionality does not exist for all protocol stacks.
allow_mountSet to allow privileged users inside the jail to mount and unmount filesystem types marked as jail-friendly.

Network Properties

InterfacesEnter up to four interface configurations in the format interface:bridge, separated by a comma (,). The left value is the virtual VNET interface name and the right value is the bridge name where the virtual interface should be attached.
host_domainnameEnter a NIS Domain name for the jail.
host_hostnameSet the jail hostname. Defaults to the jail UUID.
resolverAdd lines to the jail resolv.conf. Example: nameserver IP;search domain.local. Fields must be delimited with a semicolon (;), This is translated as new lines in resolv.conf. Enter none to inherit resolv.conf from the host.
ip4.saddrselDisable IPv4 source address selection for the jail in favor of the primary IPv4 address of the jail. Only available when the jail is not configured to use VNET.
ip6.saddrselDisable IPv6 source address selection for the jail in favor of the primary IPv6 address of the jail. Only available when the jail is not configured to use VNET.
ip4Control the availability of IPv4 addresses. Inherit: Allow unrestricted access to all system addresses. New: Restrict addresses with ip4_addr. Disable: Stop the jail from using IPv4 entirely.
ip6Control the availability of IPv6 addresses. Inherit: Allow unrestricted access to all system addresses. New: Restrict addresses with ip6_addr. Disable: Stop the jail from using IPv6 entirely.
mac_prefixEnter a valid MAC address vendor prefix. Example: E4F4C6
vnet0_macLeave this field empty to generate random MAC addresses for the host and jail. To assign fixed MAC addresses, enter the MAC address to be assigned to the host, a space, then the MAC address to be assigned to the jail.

Custom Properties

priorityNumeric start priority for the jail at boot time. Valid priorities are between 1 and 99. Smaller values are higher priority. At system shutdown the priority is reversed. Example: 99
hostidA new jail hostid, if desired. Example hostid: 1a2bc345-678d-90e1-23fa-4b56c78901de.
commentEnter comments about the jail.
templateSet to set this jail as a template.
host_timeSystem host time to synchronize the time between jail and host.
jail_zfsSet to enable automatic ZFS jailing inside the jail. The assigned ZFS dataset is fully controlled by the jail.
jail_zfs_datasetDefine the dataset to be jailed and fully handed over to a jail. Enter a ZFS filesystem name without a pool name. jail_zfs must be set for this option to work.
jail_zfs_mountpointEnter the mountpoint for the jail_zfs_dataset. Example: /data example-dataset-name
allow_tunReveal tun devices for the jail with an individual devfs ruleset. Allow the creation of tun devices in the jail
Autoconfigure IPv6 with rtsoldUse rtsold(8) as part of IPv6 autoconfiguration. Send ICMPv6 Router Solicitation messages to interfaces to discover new routers.
ip_hostnameSet to use DNS records during jail IP configuration to search the resolver and apply the first open IPv4 and IPv6 addresses. See jail(8).
assign_localhostSet to add network interface lo0 to the jail and assign it the first available localhost address, starting with 127.0.0.2. VNET must be unset. Jails using VNET configure a localhost as part of their virtualized network stack.