2012-02-19 19:09:36 +00:00
|
|
|
cdist-type__jail(7)
|
2012-05-23 12:19:58 +00:00
|
|
|
===================
|
2016-06-23 14:08:59 +00:00
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
cdist-type__jail - Manage FreeBSD jails
|
2012-02-19 19:09:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2016-06-06 02:16:42 +00:00
|
|
|
This type is used on FreeBSD to manage jails by calling the appropriate per-version subtype.
|
2012-02-19 19:09:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
REQUIRED PARAMETERS
|
|
|
|
|
-------------------
|
2016-05-20 06:50:56 +00:00
|
|
|
state
|
2014-02-08 21:06:27 +00:00
|
|
|
Either "present" or "absent", defaults to "present".
|
2012-02-19 19:09:36 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
jailbase
|
2012-04-27 15:45:34 +00:00
|
|
|
The location of the .tgz archive containing the base fs for your jails.
|
|
|
|
|
|
2012-02-19 19:09:36 +00:00
|
|
|
|
|
|
|
|
OPTIONAL PARAMETERS
|
|
|
|
|
-------------------
|
2016-05-20 06:50:56 +00:00
|
|
|
name
|
2012-02-21 20:59:19 +00:00
|
|
|
The name of the jail. Default is to use the object_id as the jail name.
|
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
ip
|
2012-02-21 20:59:19 +00:00
|
|
|
The ifconfig style IP/netmask combination to use for the jail guest. If
|
|
|
|
|
the state parameter is "present," this parameter is required.
|
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
hostname
|
2012-02-21 20:59:19 +00:00
|
|
|
The FQDN to use for the jail guest. Defaults to the name parameter.
|
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
interface
|
2012-02-21 20:59:19 +00:00
|
|
|
The name of the physical interface on the jail server to bind the jail to.
|
2012-02-28 21:39:08 +00:00
|
|
|
Defaults to the first interface found in the output of ifconfig -l.
|
2012-02-21 20:59:19 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
devfs-ruleset
|
2012-02-21 20:59:19 +00:00
|
|
|
The name of the devfs ruleset to associate with the jail. Defaults to
|
|
|
|
|
"jailrules." This ruleset must be copied to the server via another type.
|
|
|
|
|
To use this option, devfs-enable must be "true."
|
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
jaildir
|
2012-04-27 15:45:34 +00:00
|
|
|
The location on the remote server to use for hosting jail filesystems.
|
|
|
|
|
Defaults to /usr/jail.
|
|
|
|
|
|
2012-11-19 09:36:52 +00:00
|
|
|
BOOLEAN PARAMETERS
|
|
|
|
|
------------------
|
2016-05-20 06:50:56 +00:00
|
|
|
stopped
|
2012-11-27 09:57:10 +00:00
|
|
|
Do not start the jail
|
2012-11-19 09:36:52 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
devfs-disable
|
2012-11-19 09:36:52 +00:00
|
|
|
Whether to disallow devfs mounting within the jail
|
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
onboot
|
2012-11-19 09:36:52 +00:00
|
|
|
Whether to add the jail to rc.conf's jail_list variable.
|
|
|
|
|
|
2012-02-21 20:59:19 +00:00
|
|
|
|
|
|
|
|
CAVEATS
|
|
|
|
|
-------
|
|
|
|
|
This type does not currently support modification of jail options. If, for
|
|
|
|
|
example a jail needs to have its IP address or netmask changed, the jail must
|
|
|
|
|
be removed then re-added with the correct IP address/netmask or the appropriate
|
|
|
|
|
line (jail_<name>_ip="...") modified within rc.conf through some alternate
|
|
|
|
|
means.
|
2012-02-19 19:09:36 +00:00
|
|
|
|
2014-04-07 13:44:28 +00:00
|
|
|
MESSAGES
|
|
|
|
|
--------
|
2016-05-20 06:50:56 +00:00
|
|
|
start
|
2014-04-07 13:44:28 +00:00
|
|
|
The jail was started
|
2016-05-20 06:50:56 +00:00
|
|
|
stop
|
2014-04-07 13:44:28 +00:00
|
|
|
The jail was stopped
|
|
|
|
|
create:
|
|
|
|
|
The jail was created
|
2016-05-20 06:50:56 +00:00
|
|
|
delete
|
2014-04-07 13:44:28 +00:00
|
|
|
The jail was deleted
|
2016-05-20 06:50:56 +00:00
|
|
|
onboot
|
2014-04-07 13:44:28 +00:00
|
|
|
The jail was configured to start on boot
|
|
|
|
|
|
2012-02-19 19:09:36 +00:00
|
|
|
EXAMPLES
|
|
|
|
|
--------
|
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
.. code-block:: sh
|
|
|
|
|
|
|
|
|
|
# Create a jail called www
|
|
|
|
|
__jail www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
2012-02-19 19:09:36 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# Remove the jail called www
|
|
|
|
|
__jail www --state absent --jailbase /my/jail/base.tgz
|
2012-02-19 19:09:36 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# The jail www should not be started
|
|
|
|
|
__jail www --state present --stopped \
|
|
|
|
|
--ip "192.168.1.2 netmask 255.255.255.0" \
|
|
|
|
|
--jailbase /my/jail/base.tgz
|
2012-02-19 19:09:36 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# Use the name variable explicitly
|
|
|
|
|
__jail thisjail --state present --name www \
|
|
|
|
|
--ip "192.168.1.2" \
|
|
|
|
|
--jailbase /my/jail/base.tgz
|
2012-02-21 20:59:19 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# Go nuts
|
|
|
|
|
__jail lotsofoptions --state present --name testjail \
|
|
|
|
|
--ip "192.168.1.100 netmask 255.255.255.0" \
|
|
|
|
|
--hostname "testjail.example.com" --interface "em0" \
|
|
|
|
|
--onboot --jailbase /my/jail/base.tgz --jaildir /jails
|
2012-02-19 19:09:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
2016-06-30 13:12:32 +00:00
|
|
|
:strong:`jail`\ (8)
|
2016-06-17 19:28:16 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
AUTHORS
|
|
|
|
|
-------
|
|
|
|
|
Jake Guffey <jake.guffey--@--jointheirstm.org>
|
2012-02-19 19:09:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
COPYING
|
|
|
|
|
-------
|
2016-08-12 19:58:44 +00:00
|
|
|
Copyright \(C) 2012,2016 Jake Guffey. You can redistribute it
|
|
|
|
|
and/or modify it under the terms of the GNU General Public License as
|
|
|
|
|
published by the Free Software Foundation, either version 3 of the
|
|
|
|
|
License, or (at your option) any later version.
|
