Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
APPJAIL-STOP(1) 	     General Commands Manual		 APPJAIL-STOP(1)

NAME
     appjail-stop -- Stop a running jail

SYNOPSIS
     appjail stop [-fI] jail
     appjail stop [-f] [-i initscript] [[-p parameter=value] ...]
	     [[-V name=value] ...] jail

DESCRIPTION
     The  appjail  stop  utility  stops a jail and is responsible for performing
     some operations:

     -	 Stop a given jail.
     -	 Execute the stop stage.

     The options are as follows:

     -f   Forcibly stops the jail, meaning that the jail is simply  removed  re-
	  gardless of the parameters defined in the template.

     -i initscript
	  Pathname  to	the  InitScript.   If no InitScript is provided from the
	  command-line, it will be obtained via appjail-enabled(1).  If not  de-
	  fined  there, the InitScript located in the root directory of the jail
	  is used if it exists and has the execute bit permission.

     -I   Avoid running  the  InitScript.   appjail-enable(1)  and  appjail-dis-
	  able(1)  affects  this  parameter  when it is not specified explicitly
	  from the command-line.

     -p parameter=value ...
	  Parameters for pre-, post- and stop functions passed with syntax  such
	  as  parameter1=value1  ,  parameter2=value2 , ..., parameterN=valueN .
	  If no parameters are provided from the command-line, they will be  ob-
	  tained via appjail-enabled(1).

     -V name=value
	  Environment  variables.  Environment	variables are defined internally
	  with a syntax  such  as  __APPJAIL_RUN_ENVIRONMENT_VAR__<name>=<value>
	  and	  validated	with	a    regular	expression    such    as
	  ^__APPJAIL_RUN_ENVIRONMENT_VAR__[a-zA-Z_][a-zA-Z0-9_]*(=.*)?$ .

EXIT STATUS
     The appjail stop utility exits 0 on success, and >0 if an error occurs.  It
     may fail for one of the following reasons:

     -	 EX_USAGE: The command was used incorrectly.
     -	 EX_DATAERR:
	 *   An invalid environment variable was specified.
	 *   jail is invalid.
     -	 EX_NOINPUT: jail cannot be found.
     -	 EX_SOFTWARE:
	 *   The jail configuration file cannot be found.
	 *   The jail.conf(5) file  generated  dynamically  by	appjail-start(1)
	     cannot be found.
	 *   The jail is still running when it should not.
	 *   The base directory of a thinjail does not exist when it should.
	 *   An error ocurred while unmounting the base directory of a thinjail.
     -	 EX_NOPERM:  The  InitScript specified with -i does not have the execute
	 bit permission or does not exist.

SEE ALSO
     appjail-disable(1)  appjail-enable(1)  appjail-enabled(1)	appjail-rstop(1)
     sysexits(3) appjail-initscript(5) appjail-template(5)

AUTHORS
     JesAos Daniel Colmenares Oviedo <DtxdF@disroot.org>

FreeBSD ports 15.quarterly	 March 27, 2024 		 APPJAIL-STOP(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=appjail-stop&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help