.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "LEMONLDAP-NG-CLI 1p"
.TH LEMONLDAP-NG-CLI 1p 2024-04-30 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
lemonldap\-ng\-cli \- Command\-line manager for Lemonldap::NG web\-SSO system.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
lemonldap-ng-cli is a command line interface to interact with Lemonldap::NG
configuration. It can be used to read or update configuration variables
programmatically, or perform global operations on the configuration.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Usage: lemonldap-ng-cli [options] ACTION [parameters ...]
.PP
Available actions:
.PP
.Vb 10
\& help : print the full documentation
\& info : get currentconfiguration info
\& update\-cache : force configuration cache to be updated
\& test\-email DESTINATION : send a test email
\& get KEY : get values of parameters
\& set KEY VALUE : set parameter(s) value(s)
\& del KEY : delete parameters
\& addKey KEY SUBKEY VALUE : add or set a subkey in a parameter
\& delKey KEY SUBKEY : delete subkey of a parameter
\& addPostVars HOST URI KEY VALUE : add post vars for form replay
\& delPostVars HOST URI KEY : delete post vars for form replay
\& merge FILE [FILE ...] : merge JSON/YAML files with existing configuration
\& save : export configuration to STDOUT
\& restore \- : import configuration from STDIN
\& restore FILE : import configuration from file
\& rollback : restore previous configuration
.Ve
.PP
Options:
.PP
.Vb 7
\& \-yes 0|1 : accept confirmation prompt automatically
\& \-log msg : set configuration log message
\& \-safe 0|1 : fail in case the requested configuration is invalid
\& \-force 0|1 : allow overwrite of existing config number
\& \-cfgNum NUM : set new configuration number (requires \-force 1)
\& \-sep CHAR : separator of hierarchical values (by default: /)
\& \-iniFile FILE : path to an alternate lemonldap\-ng.ini file
.Ve
.PP
Additional options:
.PP
.Vb 2
\& \-\-user=USER : change user running the script
\& \-\-group=GROUP : change group running the script
.Ve
.SH EXAMPLES
.IX Header "EXAMPLES"
Get information about current configuration
.PP
.Vb 1
\& $ lemonldap\-ng\-cli info
.Ve
.PP
Update local configuration cache
.PP
.Vb 1
\& $ lemonldap\-ng\-cli update\-cache
.Ve
.PP
Send a test email
.PP
.Vb 1
\& $ lemonldap\-ng\-cli test\-email dwho@badwolf.org
.Ve
.PP
Save configuration
.PP
.Vb 2
\& $ lemonldap\-ng\-cli save >conf.json
\& $ lemonldap\-ng\-cli \-cfgNum 19 save >conf\-19.json
.Ve
.PP
Restore configuration
.PP
.Vb 3
\& $ lemonldap\-ng\-cli restore conf.json
\& # OR
\& $ lemonldap\-ng\-cli restore \-
.SH AUTHORS
.IX Header "AUTHORS"
.IP "Clement Oudot, " 4
.IX Item "Clement Oudot, "
.PD 0
.IP "Xavier Guimard, " 4
.IX Item "Xavier Guimard, "
.IP "Maxime Besson, " 4
.IX Item "Maxime Besson, "
.IP "Christophe Maudoux, " 4
.IX Item "Christophe Maudoux, "
.PD
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use OW2 system to report bug or ask for features:
.SH DOWNLOAD
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "Copyright (C) 2016 by Xavier Guimard, " 4
.IX Item "Copyright (C) 2016 by Xavier Guimard, "
.PD 0
.IP "Copyright (C) 2016 by Clément Oudot, " 4
.IX Item "Copyright (C) 2016 by Clément Oudot, "
.PD
.PP
This library is free software; 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 2, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program. If not, see .