.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "FUSIONINVENTORY-AGENT 1p"
.TH FUSIONINVENTORY-AGENT 1p "2014-07-14" "perl v5.20.0" "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"
fusioninventory\-agent \- FusionInventory agent For Linux/UNIX, Windows and MacOSX
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBfusioninventory-agent\fR [options] [\-\-server server|\-\-local path]
.PP
.Vb 3
\&  Target definition options:
\&    \-s \-\-server=URI                send tasks result to a server
\&    \-l \-\-local=PATH                write tasks results locally
\&
\&  Target scheduling options:
\&    \-\-delaytime=LIMIT              maximum delay before first target,
\&                                     in seconds (3600)
\&    \-\-lazy                         do not contact the target before
\&                                   next scheduled time
\&
\&  Task selection options:
\&    \-\-list\-tasks                   list available tasks and exit
\&    \-\-no\-task=TASK                 do not run given task
\&
\&  Inventory task specific options:
\&    \-\-no\-category=CATEGORY         do not list given category items
\&    \-\-scan\-homedirs                scan user home directories (false)
\&    \-\-scan\-profiles                scan user profiles (false)
\&    \-\-html                         save the inventory as HTML (false)
\&    \-f \-\-force                     always send data to server (false)
\&    \-\-backend\-collect\-timeout=TIME timeout for inventory modules
\&                                     execution (30)
\&    \-\-additional\-content=FILE      additional inventory content file
\&
\&  Package deployment task specific options:
\&    \-\-no\-p2p                       do not use peer to peer to download
\&                                     files (false)
\&
\&  Network options:
\&    \-P \-\-proxy=PROXY               proxy address
\&    \-u \-\-user=USER                 user name for server authentication
\&    \-p \-\-password=PASSWORD         password for server authentication
\&    \-\-ca\-cert\-dir=DIRECTORY        CA certificates directory
\&    \-\-ca\-cert\-file=FILE            CA certificates file
\&    \-\-no\-ssl\-check                 do not check server SSL certificate
\&                                     (false)
\&    \-\-timeout=TIME                 connection timeout, in seconds (180)
\&
\&  Web interface options:
\&    \-\-no\-httpd                     disable embedded web server (false)
\&    \-\-httpd\-ip=IP                  network interface to listen to (all)
\&    \-\-httpd\-port=PORT              network port to listen to (62354)
\&    \-\-httpd\-trust=IP               trust requests without authentication
\&                                     token (false)
\&
\&  Logging options:
\&    \-\-logger=BACKEND               logger backend (stderr)
\&    \-\-logfile=FILE                 log file
\&    \-\-logfile\-maxsize=SIZE         maximum size of the log file in MB (0)
\&    \-\-logfacility=FACILITY         syslog facility (LOG_USER)
\&    \-\-color                        use color in the console (false)
\&
\&  Configuration options:
\&    \-\-config=BACKEND               configuration backend
\&    \-\-conf\-file=FILE               configuration file
\&
\&  Execution mode options:
\&    \-w \-\-wait=LIMIT                maximum delay before execution,
\&                                     in seconds
\&    \-d \-\-daemon                    run the agent as a daemon (false)
\&    \-\-no\-fork                      don\*(Aqt fork in background (false)
\&    \-t \-\-tag=TAG                   add given tag to inventory results
\&    \-\-debug                        debug mode (false)
\&    \-\-setup                        print the agent setup directories
\&                                     and exit
\&    \-\-version                      print the version and exit
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fIfusioninventory-agent\fR agent is a generic multi-platform agent. It can
perform a large array of management tasks, such as local inventory, software
deployment or network discovery. It can be used either standalone, or in
combination with a compatible server (\s-1OCS, GLPI, OTRS\s0) acting as a centralized
control point.
.SH "OPTIONS"
.IX Header "OPTIONS"
Most of the options are available in a \fIshort\fR form and a \fIlong\fR form.  For
example, the two lines below are all equivalent:
.PP
.Vb 2
\&    % fusioninventory\-agent \-s localhost
\&    % fusioninventory\-agent \-\-server localhost
.Ve
.SS "Target definition options"
.IX Subsection "Target definition options"
.IP "\fB\-s\fR, \fB\-\-server\fR=\fI\s-1URI\s0\fR" 4
.IX Item "-s, --server=URI"
Send the results of tasks execution to given server.
.Sp
If \fI\s-1URI\s0\fR doesn't start with http:// or https://, the agent assume the
parameter is a hostname and rewrite it as:
.Sp
.Vb 1
\&    % \-\-server=http://servername/ocsinventory
.Ve
.Sp
In general, \s-1OCS\s0 Inventory server \s-1URL\s0 have this format:
.Sp
.Vb 1
\&    http://servername/ocsinventory
.Ve
.Sp
and FusionInventory for \s-1GLPI\s0 this one:
.Sp
.Vb 1
\&    http://servername/glpi/plugins/fusioninventory/front/plugin_fusioninventory.communication.php
.Ve
.Sp
Multiple values can be specified, using comma as a separator.
.IP "\fB\-l\fR, \fB\-\-local\fR=\fI\s-1PATH\s0\fR" 4
.IX Item "-l, --local=PATH"
Write the results of tasks execution locally.
.Sp
Exact behaviour according to given path:
.RS 4
.IP "\(bu" 4
if \fI\s-1PATH\s0\fR is a directory, a file will be created therein
.IP "\(bu" 4
if \fI\s-1PATH\s0\fR is a file, it will be used directly
.IP "\(bu" 4
if \fI\s-1PATH\s0\fR is '\-', \s-1STDOUT\s0 will be used
.RE
.RS 4
.Sp
Multiple values can be specified, using comma as a separator.
.RE
.SS "Target scheduling options"
.IX Subsection "Target scheduling options"
.IP "\fB\-\-delaytime\fR=\fI\s-1LIMIT\s0\fR" 4
.IX Item "--delaytime=LIMIT"
Set an initial delay before the first target, whose value is computed randomly
between \s-1LIMIT / 2\s0 and \s-1LIMIT\s0 seconds. This setting is ignored for server targets
after the initial contact, in favor of server-specified parameter
(\s-1PROLOG_FREQ\s0).
.IP "\fB\-\-lazy\fR" 4
.IX Item "--lazy"
Do not contact the target before next scheduled time.
.Sp
This option is only available when the agent is not run as a server.
.SS "Task selection options"
.IX Subsection "Task selection options"
.IP "\fB\-\-list\-tasks\fR" 4
.IX Item "--list-tasks"
List available tasks and exit
.IP "\fB\-\-no\-task\fR=\fI\s-1TASK\s0\fR" 4
.IX Item "--no-task=TASK"
Do not run given task.
.Sp
Multiple values can be specified, using comma as a separator. See option
\&\fI\-\-list\-tasks\fR for the list of available tasks.
.SS "Inventory task specific options"
.IX Subsection "Inventory task specific options"
.IP "\fB\-\-no\-category\fR=\fI\s-1CATEGORY\s0\fR" 4
.IX Item "--no-category=CATEGORY"
Do not list given category items in inventory.
.Sp
Multiple values can be specified, using comma as a separator. The available
categories are:
.RS 4
.IP "\(bu" 4
printer
.IP "\(bu" 4
software
.IP "\(bu" 4
environment
.IP "\(bu" 4
process
.IP "\(bu" 4
user
.RE
.RS 4
.RE
.IP "\fB\-\-scan\-homedirs\fR" 4
.IX Item "--scan-homedirs"
Allow the agent to scan home directories for virtual machines.
.IP "\fB\-\-scan\-profiles\fR" 4
.IX Item "--scan-profiles"
Allow the agent to scan user profiles for softwares.
.IP "\fB\-\-html\fR" 4
.IX Item "--html"
Save the inventory as \s-1HTML.\s0
.Sp
This is only used for local inventories.
.IP "\fB\-f\fR, \fB\-\-force\fR" 4
.IX Item "-f, --force"
Send an inventory to the server, even if this last one doesn't ask for it.
.IP "\fB\-\-backend\-collect\-timeout\fR=\fI\s-1TIME\s0\fR" 4
.IX Item "--backend-collect-timeout=TIME"
Timeout for inventory modules execution.
.IP "\fB\-\-additional\-content\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "--additional-content=FILE"
Additional inventory content file.
.Sp
This file should be an \s-1XML\s0 file, using same syntax as the one produced by the
agent.
.SS "Package deployment task specific options"
.IX Subsection "Package deployment task specific options"
.IP "\fB\-\-no\-p2p\fR" 4
.IX Item "--no-p2p"
Do not use peer to peer to download files.
.SS "Server target specific options"
.IX Subsection "Server target specific options"
.IP "\fB\-P\fR, \fB\-\-proxy\fR=\fI\s-1PROXY\s0\fR" 4
.IX Item "-P, --proxy=PROXY"
Use \fI\s-1PROXY\s0\fR as \s-1HTTP\s0 proxy.
.Sp
By default, the agent uses \s-1HTTP_PROXY\s0 environment variable.
.IP "\fB\-u\fR \fI\s-1USER\s0\fR, \fB\-\-user\fR=\fI\s-1USER\s0\fR" 4
.IX Item "-u USER, --user=USER"
Use \fI\s-1USER\s0\fR for server authentication.
.IP "\fB\-p\fR, \fB\-\-password\fR=\fI\s-1PASSWORD\s0\fR" 4
.IX Item "-p, --password=PASSWORD"
Use \fI\s-1PASSWORD\s0\fR for server authentication.
.IP "\fB\-\-ca\-cert\-dir\fR=\fI\s-1DIRECTORY\s0\fR" 4
.IX Item "--ca-cert-dir=DIRECTORY"
\&\s-1CA\s0 certificates directory.
.IP "\fB\-\-ca\-cert\-file\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "--ca-cert-file=FILE"
\&\s-1CA\s0 certificates file.
.IP "\fB\-\-no\-ssl\-check\fR" 4
.IX Item "--no-ssl-check"
Do not check server \s-1SSL\s0 certificate.
.IP "\fB\-\-timeout\fR=\fI\s-1TIME\s0\fR" 4
.IX Item "--timeout=TIME"
Timeout for server connections.
.SS "Web interface options"
.IX Subsection "Web interface options"
.IP "\fB\-\-no\-httpd\fR" 4
.IX Item "--no-httpd"
Disable the embedded web server.
.IP "\fB\-\-httpd\-ip\fR=\fI\s-1IP\s0\fR" 4
.IX Item "--httpd-ip=IP"
The network interface to use for the embedded web server (all).
.IP "\fB\-\-httpd\-port\fR=\fI\s-1PORT\s0\fR" 4
.IX Item "--httpd-port=PORT"
The network port to use for the embedded web server (62354).
.IP "\fB\-\-httpd\-trust\fR=\fI\s-1IP\s0\fR" 4
.IX Item "--httpd-trust=IP"
Trust requests from given addresses without authentication token (false).
.Sp
For example: \*(L"192.168.0.0/24\*(R", \*(L"192.168.168.0.5\*(R" or an \s-1IP\s0 range like
\&\*(L"20.34.101.207 \- 201.3.9.99\*(R". Hostnames are also accepted. See Net::IP
documentation to get more example.
.Sp
Multiple values can be specified, using comma as a separator.
.SS "Logging options"
.IX Subsection "Logging options"
.IP "\fB\-\-logger\fR=\fI\s-1BACKEND\s0\fR" 4
.IX Item "--logger=BACKEND"
Logger backend to use.
.Sp
Multiple values can be specified, using comma as a separator. The available
backends are:
.RS 4
.IP "\(bu" 4
stderr: log messages directly in the console.
.IP "\(bu" 4
file: log messages in a file.
.IP "\(bu" 4
syslog: log messages through the local syslog server.
.RE
.RS 4
.Sp
Multiple values can be specified, using comma as a separator.
.RE
.IP "\fB\-\-logfile\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "--logfile=FILE"
Log message in \fI\s-1FILE\s0\fR (implies File logger backend).
.IP "\fB\-\-logfile\-maxsize\fR=\fI\s-1SIZE\s0\fR" 4
.IX Item "--logfile-maxsize=SIZE"
Max logfile size in \s-1MB,\s0 default is unlimited. When the max size is reached, the
file is truncated. This is only useful if there is no log rotation mechanism on
the system.
.IP "\fB\-\-logfacility\fR=\fI\s-1FACILITY\s0\fR" 4
.IX Item "--logfacility=FACILITY"
Syslog facility to use (default \s-1LOG_USER\s0).
.IP "\fB\-\-color\fR" 4
.IX Item "--color"
Display color on the terminal, when the Stderr backend is used.
.Sp
This options is ignored on Windows.
.SS "Configuration options"
.IX Subsection "Configuration options"
.IP "\fB\-\-config\fR=\fI\s-1BACKEND\s0\fR" 4
.IX Item "--config=BACKEND"
Configuration backend to use.
.Sp
The available backends are:
.RS 4
.IP "\(bu" 4
file: read configuration from a file (default anywhere else as Windows).
.IP "\(bu" 4
registry: read configuration from the registry (default on Windows).
.IP "\(bu" 4
none: don't read any configuration.
.RE
.RS 4
.RE
.IP "\fB\-\-conf\-file\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "--conf-file=FILE"
Use \fI\s-1FILE\s0\fR as configuration file (implies file configuration backend).
.SS "Execution mode options"
.IX Subsection "Execution mode options"
.IP "\fB\-w\fR \fI\s-1LIMIT\s0\fR, \fB\-\-wait\fR=\fI\s-1LIMIT\s0\fR" 4
.IX Item "-w LIMIT, --wait=LIMIT"
Wait a random delay whose value is computed randomly between 0 and \s-1LIMIT\s0
seconds, before execution. This is useful when execution is triggered from some
kind of system scheduling on multiple clients, to spread the server load.
.IP "\fB\-d\fR, \fB\-\-daemon\fR" 4
.IX Item "-d, --daemon"
Run the agent as a daemon.
.IP "\fB\-\-no\-fork\fR" 4
.IX Item "--no-fork"
Don't fork in background.
.Sp
This is only useful when running as a daemon.
.IP "\fB\-\-tag\fR=\fI\s-1TAG\s0\fR" 4
.IX Item "--tag=TAG"
Add the given tag to every inventory results.
.IP "\fB\-\-debug\fR" 4
.IX Item "--debug"
Turn the debug mode on. You can use the parameter up to 3 times in a row
to increase the verbosity (e.g: \fB\-\-debug \-\-debug\fR).
.Sp
Level 3 turns on the debug mode of some external libraries like Net::SSLeay.
These messages will only be be printed on \s-1STDERR.\s0
.IP "\fB\-\-setup\fR" 4
.IX Item "--setup"
Print the agent setup directories and exit.
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Print the version and exit.