usr.sbin/jexec/jexec.8

   1 .\"
   2 .\" Copyright (c) 2003 Mike Barcroft <mike@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd November 29, 2008
  29 .Dt JEXEC 8
  30 .Os
  31 .Sh NAME
  32 .Nm jexec
  33 .Nd "execute a command inside an existing jail"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl u Ar username | Fl U Ar username
  37 .Op Fl n Ar jailname
  38 .Ar jid command ...
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 utility executes
  43 .Ar command
  44 inside the jail identified by either
  45 .Ar jailname
  46 or
  47 .Ar jid
  48 or both.
  49 .Pp
  50 If the jail cannot be identified uniquely by the given parameters,
  51 an error message is printed.
  52 .Nm
  53 will also check the state of the jail (once supported) to be
  54 .Dv ALIVE
  55 and ignore jails in other states.
  56 The mandatory argument
  57 .Ar jid
  58 is the unique jail identifier as given by
  59 .Xr jls 8 .
  60 In case you only want to match on other criteria, give an empty string.
  61 .Pp
  62 The following options are available:
  63 .Bl -tag -width indent
  64 .It Fl n Ar jailname
  65 The name of the jail, if given upon creation of the jail.
  66 This is not the hostname of the jail.
  67 .It Fl u Ar username
  68 The user name from host environment as whom the
  69 .Ar command
  70 should run.
  71 .It Fl U Ar username
  72 The user name from jailed environment as whom the
  73 .Ar command
  74 should run.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr jail_attach 2 ,
  78 .Xr jail 8 ,
  79 .Xr jls 8
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 utility was added in
  84 .Fx 5.1 .
  85 .Sh BUGS
  86 If the jail is not identified by
  87 .Ar jid
  88 there is a possible race in between the lookup of the jail
  89 and executing the command inside the jail.
  90 Giving a
  91 .Ar jid
  92 has a similar race as another process can stop the jail and
  93 start another one after the user looked up the
  94 .Ar jid .