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

FreeBSD Manual Pages

  
 
  

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

NAME
     appjail-label -- Add metadata to jails

SYNOPSIS
     appjail label add jail label [value]
     appjail label get [-eHIpt] -l label jail [keyword ...]
     appjail label list [-eHIpt] [-l label] jail [keyword ...]
     appjail label remove jail label

DESCRIPTION
     The appjail label utility adds metadata known as labels to jails, which are
     technically  a  key-value	pair object. This helps it integrate better with
     third-party tools that use jails created by AppJail.

     A label key is valid when the first and last letters  is  alphabetic,  then
     the  rest	of the letters are alphanumeric and lowercase and can have a pe-
     riod or a hyphen but not consecutive.

     The options are as follows:

     add jail label [value]
	  Add a new label to jail .

     get [-eHIpt] -l label jail [keyword ...]
	  Get information about jail's label , that is, the keyword that  repre-
	  sent	the  information to be obtained. Multiple keywords can be speci-
	  fied, which are displayed as a table-like interface in  the  order  in
	  which  they  are  specified.	If no keyword is specified, the defaults
	  are name and value.

	  See "KEYWORDS" for a list of available keywords.

	  -e  Not required when using -p .  The \t character is used to  delimit
	      columns, so as not to show strange values, this option shows <TAB>
	      instead of \t in the case that a value contains the latter.

	  -H  Shows the name of the columns.

	  -I  Include empty values. By default, a minus sign is displayed when a
	      value is empty.

	  -p  Columnate the list.

	  -t  Tabulate columns and values.

     list [-eHIpt] [-l label] jail [keyword ...]
	  Similar to get but shows each keyword for each label in a nice table.

	  -e, -H, -I, -p, -t
	      All  of  these  options  perform	the opposite task of the options
	      described in get.

	  -l label
	      Only show information for label.

     remove jail label
	  Remove a label.

KEYWORDS
     name
	 Label name.

     value
	 Label value.

EXIT STATUS
     The appjail label utility exits 0 on success, and >0 if an error occurs.

SEE ALSO
     sysexits(3)

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

FreeBSD ports 15.quarterly	 April 27, 2024 		APPJAIL-LABEL(1)

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

home | help