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

NAME

6       cdist-type__jail - Manage FreeBSD jails
7

DESCRIPTION

9       This type is used on FreeBSD to manage jails by calling the appropriate
10       per-version subtype.
11

REQUIRED PARAMETERS

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

OPTIONAL PARAMETERS

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

BOOLEAN PARAMETERS

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

CAVEATS

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

MESSAGES

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

EXAMPLES

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

SEE ALSO

98       jail(8)
99

AUTHORS

101       Jake Guffey <jake.guffey--@--jointheirstm.org>
102

COPYING

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

110       ungleich GmbH 2021
111
112
113
114
1156.9.8                            Aug 24, 2021              CDIST-TYPE__JAIL(7)
Impressum