78 lines
6.2 KiB
HTML
78 lines
6.2 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
|||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__jail(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idm140179399325824"></a>cdist-type__jail(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jake</span> <span class="surname">Guffey</span></h3><code class="email"><<a class="email" href="mailto:jake.guffey--@--eprotex.com">jake.guffey--@--eprotex.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_caveats">6. CAVEATS</a></span></dt><dt><span class="section"><a href="#_examples">7. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. COPYING</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__jail - Manage FreeBSD jails</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is used on FreeBSD to manage jails.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
state
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Either "present" or "absent."
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
jailbase
|
|||
|
|
</span></dt><dd>
|
|||
|
|
The location of the .tgz archive containing the base fs for your jails.
|
|||
|
|
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
name
|
|||
|
|
</span></dt><dd>
|
|||
|
|
The name of the jail. Default is to use the object_id as the jail name.
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
ip
|
|||
|
|
</span></dt><dd>
|
|||
|
|
The ifconfig style IP/netmask combination to use for the jail guest. If
|
|||
|
|
the state parameter is "present," this parameter is required.
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
hostname
|
|||
|
|
</span></dt><dd>
|
|||
|
|
The FQDN to use for the jail guest. Defaults to the name parameter.
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
interface
|
|||
|
|
</span></dt><dd>
|
|||
|
|
The name of the physical interface on the jail server to bind the jail to.
|
|||
|
|
Defaults to the first interface found in the output of ifconfig -l.
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
devfs-ruleset
|
|||
|
|
</span></dt><dd>
|
|||
|
|
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."
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
jaildir
|
|||
|
|
</span></dt><dd>
|
|||
|
|
The location on the remote server to use for hosting jail filesystems.
|
|||
|
|
Defaults to /usr/jail.
|
|||
|
|
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
|||
|
|
stopped
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Do not start the jail
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
devfs-disable
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Whether to disallow devfs mounting within the jail
|
|||
|
|
</dd><dt><span class="term">
|
|||
|
|
onboot
|
|||
|
|
</span></dt><dd>
|
|||
|
|
Whether to add the jail to rc.conf’s jail_list variable.
|
|||
|
|
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_caveats"></a>6. CAVEATS</h2></div></div></div><p>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.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>7. EXAMPLES</h2></div></div></div><pre class="screen"># Create a jail called www
|
|||
|
|
__jail www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
|||
|
|
|
|||
|
|
# Remove the jail called www
|
|||
|
|
__jail www --state absent --jailbase /my/jail/base.tgz
|
|||
|
|
|
|||
|
|
# 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
|
|||
|
|
|
|||
|
|
# Use the name variable explicitly
|
|||
|
|
__jail thisjail --state present --name www \
|
|||
|
|
--ip "192.168.1.2" \
|
|||
|
|
--jailbase /my/jail/base.tgz
|
|||
|
|
|
|||
|
|
# 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</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
|
|||
|
|
cdist-type(7)
|
|||
|
|
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2012 Jake Guffey. Free use of this software is
|
|||
|
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|