1CDIST-TYPE__JAIL_FREEBSD9(7)         cdist        CDIST-TYPE__JAIL_FREEBSD9(7)
2
3
4

NAME

6       cdist-type__jail_freebsd9 - Manage FreeBSD jails
7

DESCRIPTION

9       This type is used on FreeBSD <= 9.x to manage jails.
10

REQUIRED PARAMETERS

12       state  Either "present" or "absent", defaults to "present".
13
14       jailbase
15              The location of the .tgz archive containing the base fs for your
16              jails.
17

OPTIONAL PARAMETERS

19       name   The name of the jail. Default is to use  the  object_id  as  the
20              jail name.
21
22       ip     The  ifconfig  style  IP/netmask combination to use for the jail
23              guest. If the state parameter is "present,"  this  parameter  is
24              required.
25
26       hostname
27              The FQDN to use for the jail guest. Defaults to the name parame‐
28              ter.
29
30       interface
31              The name of the physical interface on the jail  server  to  bind
32              the  jail to.  Defaults to the first interface found in the out‐
33              put of ifconfig -l.
34
35       devfs-ruleset
36              The name of the devfs ruleset to associate with  the  jail.  De‐
37              faults to "jailrules." This ruleset must be copied to the server
38              via another type.  To use  this  option,  devfs-enable  must  be
39              "true."
40
41       jaildir
42              The  location  on  the  remote  server  to  use for hosting jail
43              filesystems.  Defaults to /usr/jail.
44

BOOLEAN PARAMETERS

46       stopped
47              Do not start the jail
48
49       devfs-disable
50              Whether to disallow devfs mounting within the jail
51
52       onboot Whether to add the jail to rc.conf's jail_list variable.
53

CAVEATS

55       This type does not currently support modification of jail options.  If,
56       for example a jail needs to have its IP address or netmask changed, the
57       jail must be removed then re-added with the correct IP  address/netmask
58       or  the appropriate line (jail_<name>_ip="...") modified within rc.conf
59       through some alternate means.
60

MESSAGES

62       start  The jail was started
63
64       stop   The jail was stopped
65
66       create:
67              The jail was created
68
69       delete The jail was deleted
70
71       onboot The jail was configured to start on boot
72

EXAMPLES

74          # Create a jail called www
75          __jail_freebsd9 www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
76
77          # Remove the jail called www
78          __jail_freebsd9 www --state absent --jailbase /my/jail/base.tgz
79
80          # The jail www should not be started
81          __jail_freebsd9 www --state present --stopped \
82             --ip "192.168.1.2 netmask 255.255.255.0" \
83             --jailbase /my/jail/base.tgz
84
85          # Use the name variable explicitly
86          __jail_freebsd9 thisjail --state present --name www \
87             --ip "192.168.1.2" \
88             --jailbase /my/jail/base.tgz
89
90          # Go nuts
91          __jail_freebsd9 lotsofoptions --state present --name testjail \
92             --ip "192.168.1.100 netmask 255.255.255.0" \
93             --hostname "testjail.example.com" --interface "em0" \
94             --onboot --jailbase /my/jail/base.tgz --jaildir /jails
95

SEE ALSO

97       jail(8)
98

AUTHORS

100       Jake Guffey <jake.guffey--@--eprotex.com>
101

COPYING

103       Copyright (C) 2012-2016 Jake Guffey. You  can  redistribute  it  and/or
104       modify  it  under  the  terms of the GNU General Public License as pub‐
105       lished by the Free Software Foundation, either version  3  of  the  Li‐
106       cense, or (at your option) any later version.
107

109       ungleich GmbH 2021
110
111
112
113
1147.0.0                            Jul 31, 2022     CDIST-TYPE__JAIL_FREEBSD9(7)
Impressum