.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "2023-05-13" "perl v5.32.1" "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] \s-1ACTION\s0 [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 \- <conf.json
.Ve
.PP
Cancel the last configuration change
.PP
.Vb 1
\&  $ lemonldap\-ng\-cli rollback
.Ve
.PP
Get a configuration parameter value
.PP
.Vb 1
\&  $ lemonldap\-ng\-cli get portal domain cookieName
.Ve
.PP
Set some values
.PP
.Vb 3
\&  $ lemonldap\-ng\-cli set portal http://auth.e.com/ domain e.com
\&  # add or set a key
\&  $ lemonldap\-ng\-cli addKey macro fullname \*(Aq$givenName." ".$lastName\*(Aq
\&
\&  # without changing the version number
\&  $ lemonldap\-ng\-cli \-force 1 \-cfgNum 1 set portal http://auth.e.com/ domain e.com
\&
\&  # without asking for confirmation
\&  $ lemonldap\-ng\-cli \-yes 1 set portal http://auth.e.com/ domain e.com
.Ve
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
.IP "\fBinfo\fR" 4
.IX Item "info"
Print configuration metadata, such as number, author, date and log
.IP "\fBupdate-cache\fR" 4
.IX Item "update-cache"
Update the local configuration cache, this command only affects the server on which it is run
.IP "\fBtest-email \f(BI\s-1DESTINATION\s0\fB\fR" 4
.IX Item "test-email DESTINATION"
Sends a test email to the specified \fI\s-1DESTINATION\s0\fR, this lets you check your \s-1SMTP\s0 settings
.IP "\fBget \f(BI\s-1KEY\s0\fB [ \f(BI\s-1KEY\s0\fB ... ]\fR" 4
.IX Item "get KEY [ KEY ... ]"
Print the specified \fI\s-1KEY\s0\fR from configuration. Multiple keys may be given
.IP "\fBset \f(BI\s-1KEY\s0\fB \f(BI\s-1VALUE\s0\fB [\f(BI\s-1KEY\s0\fB \f(BI\s-1VALUE\s0\fB ...]\fR" 4
.IX Item "set KEY VALUE [KEY VALUE ...]"
Set the specified \fI\s-1KEY\s0\fR to the specified \fI\s-1VALUE\s0\fR. Multiple key-value pairs may be given.
.Sp
The configuration number is increased once all given key-value pairs have been processesed.
.IP "\fBdelete \f(BI\s-1KEY\s0\fB [ \f(BI\s-1KEY\s0\fB ... ]\fR" 4
.IX Item "delete KEY [ KEY ... ]"
Delete the specified \fI\s-1KEY\s0\fR from configuration. Multiple keys can be given.
.Sp
The configuration number is increased once all keys have been deleted.
.IP "\fBaddKey \f(BI\s-1KEY\s0\fB \f(BI\s-1SUBKEY\s0\fB \f(BI\s-1VALUE\s0\fB [\f(BI\s-1KEY\s0\fB \f(BI\s-1SUBKEY\s0\fB \f(BI\s-1VALUE\s0\fB ...]\fR" 4
.IX Item "addKey KEY SUBKEY VALUE [KEY SUBKEY VALUE ...]"
This action can be used to set a sub-key inside a composite configuration key
(such as globalStorageOptions, locationRules, etc.)
.Sp
Multiple key-subkey-value triplets may be given.
.Sp
The configuration number is increased once all given triplets have been processesed.
.IP "\fBdelKey \f(BI\s-1KEY\s0\fB \f(BI\s-1SUBKEY\s0\fB [\f(BI\s-1KEY\s0\fB \f(BI\s-1SUBKEY\s0\fB ...]\fR" 4
.IX Item "delKey KEY SUBKEY [KEY SUBKEY ...]"
This action can be used to delete a sub-key from a composite configuration key
(such as globalStorageOptions, locationRules, etc.)
.Sp
Multiple key-subkey pairs may be given.
.Sp
The configuration number is increased once all given pairs have been processesed.
.IP "\fBaddPostVars \f(BI\s-1HOST\s0\fB \f(BI\s-1URI\s0\fB \f(BI\s-1KEY\s0\fB \f(BI\s-1VALUE\s0\fB\fR" 4
.IX Item "addPostVars HOST URI KEY VALUE"
This action lets you add a new \s-1POST\s0 var in a form replay configuration.
.IP "\fBdelPostVars \f(BI\s-1HOST\s0\fB \f(BI\s-1URI\s0\fB \f(BI\s-1KEY\s0\fB\fR" 4
.IX Item "delPostVars HOST URI KEY"
This action lets you delete a new \s-1POST\s0 var in a form replay configuration.
.IP "\fBmerge \f(BI\s-1FILE\s0\fB [\f(BI\s-1FILE\s0\fB ...]\fR" 4
.IX Item "merge FILE [FILE ...]"
This action iterates through the given \s-1JSON\s0 or \s-1YAML\s0 files and merges the
existing configuration with the keys contained in those files
.IP "\fBsave\fR" 4
.IX Item "save"
Dump the entire LemonLDAP::NG configuration to standard output, in \s-1JSON\s0 format.
.Sp
The resulting dump can be imported into the manager's interface, or restored
with the \fBrestore\fR command.
.IP "\fBrestore \f(BI\s-1FILE\s0\fB\fR" 4
.IX Item "restore FILE"
Replace the existing configuration with the content of the provided
JSON-formatted \fI\s-1FILE\s0\fR. If \fI\s-1FILE\s0\fR is the \fI\-\fR string, configuration will be
read from standard input.
.IP "\fBrollback\fR" 4
.IX Item "rollback"
This command can be used to cancel the latest configuration change. The
previous configuration is fetched from configuration history and saved under a
new configuration number.
.Sp
This action is meant to be a convenient wrapper around \fBsave\fR and \fBrestore\fR,
and does not handle rolling back to an arbitrary version. Rolling back to an
arbitrary version can be done manually with \fBsave\fR and \fBrestore\fR
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-yes \f(BI0|1\fB\fR" 4
.IX Item "-yes 0|1"
Skip confirmation prompt (default: 0)
.IP "\fB\-log \f(BI\s-1MESSAGE\s0\fB\fR" 4
.IX Item "-log MESSAGE"
Allows you to set the log message that will be displayed in the manager
.IP "\fB\-safe \f(BI0|1\fB\fR" 4
.IX Item "-safe 0|1"
The configuration change will be aborted if it contains errors (default: 0)
.IP "\fB\-force \f(BI0|1\fB\fR" 4
.IX Item "-force 0|1"
Allows you to force overwriting an existing configuration number (default: 0)
.IP "\fB\-cfgNum \f(BI\s-1NUMBER\s0\fB\fR" 4
.IX Item "-cfgNum NUMBER"
Choose a particular configuration number (default: latest)
.IP "\fB\-sep \f(BI\s-1CHARACTER\s0\fB\fR" 4
.IX Item "-sep CHARACTER"
Allows you to define hierarchical separator
.IP "\fB\-iniFile \f(BI\s-1FILE\s0\fB\fR" 4
.IX Item "-iniFile FILE"
Allows you to set an alternative ini file
.IP "\fB\-u \f(BI\s-1USER\s0\fB, \-\-user=\f(BI\s-1USER\s0\fB\fR" 4
.IX Item "-u USER, --user=USER"
Run the script under the \fI\s-1USER\s0\fR system user identity
.IP "\fB\-g \f(BI\s-1GROUP\s0\fB, \-\-group=\f(BI\s-1GROUP\s0\fB\fR" 4
.IX Item "-g GROUP, --group=GROUP"
Run the script under the \fI\s-1GROUP\s0\fR system group identity
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Lemonldap::NG::Manager::Cli, Lemonldap::NG::Common::Cli
<http://lemonldap\-ng.org/>
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "Clement Oudot, <clement@oodo.net>" 4
.IX Item "Clement Oudot, <clement@oodo.net>"
.PD 0
.IP "Xavier Guimard, <yadd@debian.org>" 4
.IX Item "Xavier Guimard, <yadd@debian.org>"
.IP "Maxime Besson, <maxime.besson@worteks.com>" 4
.IX Item "Maxime Besson, <maxime.besson@worteks.com>"
.IP "Christophe Maudoux, <chrmdx@gmail.com>" 4
.IX Item "Christophe Maudoux, <chrmdx@gmail.com>"
.PD
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use \s-1OW2\s0 system to report bug or ask for features:
<https://gitlab.ow2.org/lemonldap\-ng/lemonldap\-ng/issues>
.SH "DOWNLOAD"
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
<https://release.ow2.org/lemonldap/>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "Copyright (C) 2016 by Xavier Guimard, <x.guimard@free.fr>" 4
.IX Item "Copyright (C) 2016 by Xavier Guimard, <x.guimard@free.fr>"
.PD 0
.IP "Copyright (C) 2016 by Clément Oudot, <clem.oudot@gmail.com>" 4
.IX Item "Copyright (C) 2016 by Clément Oudot, <clem.oudot@gmail.com>"
.PD
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 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 \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.