.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "2012-06-25" "perl v5.14.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"
fusioninventory\-agent \- FusionInventory agent For Linux/UNIX, Windows and MacOSX
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBfusioninventory-agent\fR [options] [\-\-server server|\-\-local directory|\-\-sdout]
.PP
.Vb 4
\&  Target definition options
\&    \-s \-\-server=URI     send tasks result to a server
\&    \-l \-\-local=DIR      write tasks results in a directory
\&    \-\-stdout            write tasks result on STDOUT
\&
\&  Target scheduling options
\&    \-\-delaytime=DURATION        maximum initial delay before first target, in seconds (3600)
\&    \-w \-\-wait=DURATION          maximum delay between each target, in seconds
\&    \-\-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     allow to scan use home directories (false)
\&    \-\-html              save the inventory as HTML (false)
\&    \-f \-\-force          always send data to server (false)
\&    \-t \-\-tag=TAG        mark the machine with given tag
\&    \-\-backend\-collect\-timeout   timeout for inventory modules execution (30)
\&    \-\-additional\-content=FILE   additional inventory content
\&
\&  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=PWD   password for server authentication
\&    \-\-ca\-cert\-dir=D     path to the CA certificates directory
\&    \-\-ca\-cert\-file=F    path to the CA certificates file
\&    \-\-no\-ssl\-check      do not check server SSL certificates (false)
\&    \-\-timeout           connection timeout (180)
\&
\&  Web interface options
\&    \-\-no\-httpd                 disable embedded web server (false)
\&    \-\-httpd\-ip=IP              network interface to listen to
\&    \-\-httpd\-port=PORT          network port to listen to (62354)
\&    \-\-httpd\-trust=RANGE        trust requests from range without authentication token (false)
\&
\&  Logging options
\&    \-\-logger=BACKEND            logger backend [Stderr|File|Syslog] (Stderr)
\&    \-\-logfile=FILE              log file
\&    \-\-logfile\-maxsize=X         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 [file|registry|none]
\&    \-\-conf\-file=FILE            configuration file
\&
\&  Execution mode options
\&    \-d \-\-daemon                 run the agent as a daemon (false)
\&    \-\-no\-fork                   don\*(Aqt fork in background (false)
\&    \-\-debug                     debug mode (false)
\&    \-\-version                   print the version and exit
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 2
\&    % fusioninventory\-agent \-\-server localhost
\&    # execute all available tasks required by a local server
\&
\&    % fusioninventory\-agent \-\-server http://localhost/ocsinventory2
\&    # execute all available tasks required by a local server, using a specific
\&    # URI
\&
\&    % fusioninventory\-agent \-\-server https://localhost/ocsinventory
\&    # execute all available tasks required by a local server, using a secure
\&    # connection
\&
\&    % fusioninventory\-agent \-\-server localhost \-\-user test \-\-password s3cr3t
\&    # execute all available tasks required by a local server, using HTTP
\&    # authentication
\&
\&    % fusioninventory\-agent \-\-local /tmp
\&    # execute all available tasks and write the result in /tmp directory
\&
\&    % fusioninventory\-agent \-\-local /tmp \-\-html
\&    # execute all available tasks and write the result in /tmp directory in
\&    # HTML format
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIfusioninventory-agent\fR is an agent for \s-1OCS\s0 Inventory server and
FusionInventory for \s-1GLPI\s0 servers. It creates local inventory of the machines
(hardware and software) and send it to the server. It can also write it
in a local \s-1XML\s0 file.
This agent is the successor of the former linux_agent which was released with
\&\s-1OCS\s0 1.01 and prior. It also replaces the Solaris/AIX/BSD unofficial agents.
.PP
Supported systems:
.IP "\fIWindows\fR (since Windows 2000)" 4
.IX Item "Windows (since Windows 2000)"
.PD 0
.IP "\fIGNU/Linux\fR" 4
.IX Item "GNU/Linux"
.IP "\fIMacOSX\fR" 4
.IX Item "MacOSX"
.IP "\fISolaris\fR" 4
.IX Item "Solaris"
.IP "\fIFreeBSD\fR" 4
.IX Item "FreeBSD"
.IP "\fINetBSD\fR" 4
.IX Item "NetBSD"
.IP "\fIOpenBSD\fR" 4
.IX Item "OpenBSD"
.IP "\fI\s-1AIX\s0\fR" 4
.IX Item "AIX"
.IP "\fIHP-UX\fR" 4
.IX Item "HP-UX"
.IP "\fIGNU/kFreeBSD\fR" 4
.IX Item "GNU/kFreeBSD"
.PD
.SH "OCS INVENTORY PROTOCOL"
.IX Header "OCS INVENTORY PROTOCOL"
FusionInventory Agent uses \s-1OCS\s0 Inventory protocol and is compatible with \s-1OCS\s0
Inventory server. The agent uses the same protocol with the FusionInventory
For \s-1GLPI\s0 plugin.
.PP
The \s-1OCS\s0 protocol is basicly an exchange of \s-1XML\s0 file done over \s-1HTTP\s0(S).
.SS "First, The \s-1PROLOG\s0"
.IX Subsection "First, The PROLOG"
The agent send a first message to give it's \s-1ID\s0 (\s-1DEVICEID\s0). The
server send back to the agent an \s-1XML\s0 file with a list of parameter. It's the
\&\s-1PROLOG\s0 \s-1RESP\s0. You can see it if you're in Debug mode.
In this \s-1PROLOG\s0, the server send the \s-1PROLOG_FREQ\s0. The agent will use it to
know when it need to contact the server for the next time.
.PP
The agent compute the next query date this way:
.PP
.Vb 1
\&     PROLOG_FREQ/2+RANDOM(PROLOG_FREQ/2)
.Ve
.SS "Module execution"
.IX Subsection "Module execution"
The agent will launch each modules and pass the list of options found in the
\&\s-1PROLOG\s0 \s-1RESP\s0 as parameter. The module can send information directly to the
server (inventory, \s-1SNMP\s0 scan result, etc)
.SS "Server mode (Windows service or Unix daemon)"
.IX Subsection "Server mode (Windows service or Unix daemon)"
In server mode, the agent wait during a period between the last \s-1PROLOG\s0 and
\&\s-1PROLOG_FREQ\s0. If \s-1PROLOG_FREQ\s0 is not set, it will use \-\-delaytime value.
The default value is 3600.
.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 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-1DIR\s0\fR" 4
.IX Item "-l, --local=DIR"
Write the results of tasks execution to given directory.
.IP "\fB\-\-stdout\fR" 4
.IX Item "--stdout"
Write the results of tasks execution on stdout.
.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\s0 / 2 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\-w\fR \fI\s-1LIMIT\s0\fR, \fB\-\-wait\fR=\fI\s-1LIMIT\s0\fR" 4
.IX Item "-w LIMIT, --wait=LIMIT"
Set a delay between each targets, whose value is computed randomly between 0
and \s-1LIMIT\s0 seconds.
.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\-\-no\-task\fR=\fI\s-1TASK\s0\fR" 4
.IX Item "--no-task=TASK"
Disable the given task
.IP "\fB\-\-list\-tasks\fR" 4
.IX Item "--list-tasks"
List available tasks and exit
.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.
.IP "\fB\-\-scan\-homedirs\fR" 4
.IX Item "--scan-homedirs"
Allow the agent to scan home directories for virtual machines.
.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\-\-tag\fR=\fI\s-1TAG\s0\fR" 4
.IX Item "--tag=TAG"
Mark the machine with given tag.
.IP "\fB\-\-backend\-collect\-timeout\fR=\fI\s-1TIME\s0\fR" 4
.IX Item "--backend-collect-timeout=TIME"
Timeout for inventory modules execution.
.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-1PATH\s0\fR" 4
.IX Item "--ca-cert-dir=PATH"
Path to the \s-1CA\s0 certificates directory.
.IP "\fB\-\-ca\-cert\-file\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "--ca-cert-file=FILE"
Path to the \s-1CA\s0 certificates file.
.IP "\fB\-\-no\-ssl\-check\fR" 4
.IX Item "--no-ssl-check"
Do not check server \s-1SSL\s0 certificates.
.Sp
Hint: you can set \s-1HTTPS_DEBUG\s0 environment variable to get \s-1SSL\s0 error messages in
the console.
.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 
available interfaces).
.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-1RANGE\s0\fR" 4
.IX Item "--httpd-trust=RANGE"
Trust requests from given range without authentication token (false).
.Sp
For example: \*(L"192.168.0.0/24\*(R", \*(L"192.68.168.0.5\*(R" or an \s-1IP\s0 range like
\&\*(L"20.34.101.207 \- 201.3.9.99\*(R". See Net::IP documentation to get more example.
.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. It can be:
.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-1FILE\s0\fR" 4
.IX Item "--logfile-maxsize=FILE"
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\-\-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)
.IP "\fB\-\-config\fR=\fI\s-1BACKEND\s0\fR" 4
.IX Item "--config=BACKEND"
Configuration backend to use. It can be:
.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
.SS "Execution mode options"
.IX Subsection "Execution mode options"
.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\-\-debug\fR" 4
.IX Item "--debug"
Turn the debug mode on.
.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.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
The agent is able to use multiple configuration backends. The registry backend
is the default on Windows platform, and the file backend is the default
everywhere else. Another backend can be specified using the \fB\-\-config\fR option.
.PP
The \fIfile\fR backend reads configuration directives from a configuration file,
whose default location is determined at installation time as
PREFIX/etc/agent.cfg. An alternative location can also be given with
\&\fB\-\-conf\-file\fR option.
.PP
The \fIregistry\fR backend reads configuration directives from the Windows
registry, with an arch-dependant location:
.IP "\(bu" 4
\&\fIHKEY_LOCAL_MACHINE\eSOFTWARE\eFusionInventory\-Agent\fR for 32 bits machines
.IP "\(bu" 4
\&\fIHKEY_LOCAL_MACHINE\eSOFTWARE\eWow6432Node\eFusionInventory\-Agent\fR for 64 bits machines
.PP
The \fInone\fR backend doesn't read any configuration directive at all, allowing
to isolate the agent execution from any installed configuration.