.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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 "OCSINVENTORY-AGENT 1p"
.TH OCSINVENTORY-AGENT 1p "2024-01-07" "perl v5.36.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"
ocsinventory\-agent \- Unified client for OCS\-Inventory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBocsinventory-agent\fR [ \fB\-fhilpruw\fR ] [ \fI\-\-server server\fR | \fI\-\-local /tmp\fR ]...
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 2
\&    % ocsinventory\-agent \-\-server localhost
\&    # send an inventory to the OCS server
\&
\&    % ocsinventory\-agent \-\-server http://localhost/ocsinventory2
\&    # send an inventory over http to a server with a non standard
\&    # virtual directory
\&
\&    % ocsinventory\-agent \-\-server https://localhost/ocsinventory
\&    # send an inventory over https to the OCS server
\&
\&    % ocsinventory\-agent \-\-local /tmp
\&    # write an inventory in the /tmp directory
\&
\&    % ocsinventory\-agent \-\-server localhost \-\-user=toto \-\-password=pw \-\-realm="Restricted Area"
\&    # send a report to a server protected by a basic authentication
\&    % ocsinventory\-agent \-\-lazy
\&    # send an inventory only if the a random delay between 0 and PROLOG_FREQ had been run over.
\&
\&    % ocsinventory\-agent \-\-delaytime 60 \-d
\&    # If NO PROLOG_FREQ has been preset, pick a time between execution and \-\-delaytime for the agent to contact the server [default is 3600 seconds]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIocsinventory-agent\fR creates inventory and send or write them. This agent is the
successor of the former linux_agent which was released with \s-1OCS 1.01\s0 and prior. It also
replaces the Solaris/AIX/BSD unofficial agents. The detailed list of supported
Operating System is available in the Wiki.
.IP "\fIGNU/Linux\fR" 4
.IX Item "GNU/Linux"
.PD 0
.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 "\fIMacOSX\fR" 4
.IX Item "MacOSX"
.IP "\fIGNU/kFreeBSD\fR" 4
.IX Item "GNU/kFreeBSD"
.PD
.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
\&    % ocsinventory\-agent \-s localhost
\&    % ocsinventory\-agent \-\-server localhost
.Ve
.IP "\fB\-\-backend\-collect\-timeout=SECONDS_BEFORE_KILL\fR" 4
.IX Item "--backend-collect-timeout=SECONDS_BEFORE_KILL"
Time before \s-1OCS\s0 kills modules processing which don't end before the timeout.
.IP "\fB\-\-basevardir\fR=\fI\s-1DIR\s0\fR" 4
.IX Item "--basevardir=DIR"
Indicate the place where the agent should store its files.
.IP "\fB\-d\fR, \fB\-\-daemon\fR" 4
.IX Item "-d, --daemon"
Launch ocsinventory-agent in background. Proc::Daemon is needed.
.IP "\fB\-\-debug\fR" 4
.IX Item "--debug"
Turn the debug mode on.
.IP "\fB\-\-devlib\fR" 4
.IX Item "--devlib"
This option is designed for backend module developer. With it enabled, ocsinventry-agent won't try to load the Backend module installed on the system. Instead it will scan the ./lib directory.
.IP "\fB\-\-delaytime=SECONDS_TO_WAIT\fR" 4
.IX Item "--delaytime=SECONDS_TO_WAIT"
This option defaults to waiting a \fBrandom()\fR time between 0 and 3600 before initially contacting the server assuming \s-1NO PROLOG_FREQ\s0 has been set. Once \s-1PROLOG_FREQ\s0 has been set, it uses that number at the top end of it's random setting. Useful for pre-setting a deployed agent's initial start time (so you don't jam the server all at once, but don't have to wait an hour to make sure the deployment worked).
.IP "\fB\-f\fR, \fB\-\-force\fR" 4
.IX Item "-f, --force"
The agent will first contact the server during the \s-1PROLOG\s0 period. If the server doesn't know the machine or has outdated information, it will ask for an inventory.
With this option, the agent doesn't run the \s-1PROLOG\s0 with the server first but directly sends an inventory.
.IP "\fB\-i\fR, \fB\-\-info\fR" 4
.IX Item "-i, --info"
Turn the verbose mode on. The flag is ignored if \fB\-\-debug\fR is enable.
.IP "\fB\-\-lazy\fR" 4
.IX Item "--lazy"
Do not contact the server more than one time during the \s-1PROLOG_FREQ\s0 and do
an exit if there is nothing to do. Useful if you want to start the agent
script regulary from the crontab but don't want to overload the server.
.IP "\fB\-l\fR, \fB\-\-local\fR=\fI\s-1DIR\s0\fR" 4
.IX Item "-l, --local=DIR"
Write an inventory in the \fI\s-1DIR\s0\fR directory. A new file will be created if needed.
.IP "\fB\-\-logfile\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "--logfile=FILE"
Log message in \fI\s-1FILE\s0\fR and turn off \s-1STDERR\s0
.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 an \s-1HTTP\s0 identification with the server.
.IP "\fB\-P\fR, \fB\-\-proxy\fR=\fI\s-1PROXY\s0\fR" 4
.IX Item "-P, --proxy=PROXY"
Use \fI\s-1PROXY\s0\fR to specify a proxy \s-1HTTP\s0 server. By default, the agent uses \s-1HTTP_PROXY\s0 environment variable.
.IP "\fB\-r\fR, \fB\-\-realm\fR=\fI\s-1REALM\s0\fR" 4
.IX Item "-r, --realm=REALM"
Use \fI\s-1REALM\s0\fR for an \s-1HTTP\s0 identification with the server. For example, the value can be 'Restricted Area'. You can find it in the login popup of your Internet browser.
.IP "\fB\-s\fR, \fB\-\-server\fR=\fI\s-1URI\s0\fR" 4
.IX Item "-s, --server=URI"
The uri of the server. If \fI\s-1URI\s0\fR doesn't start with http:// or https://, the assume the parameter is a hostname and rewrite it like that:
.Sp
.Vb 1
\&    % http://servername/ocsinventory
.Ve
.Sp
If you want to use https or another virtual directory you need to enter the full path.
.Sp
\&\fB\-\-server\fR is ignored if \fB\-\-local\fR is in use.
.IP "\fB\-\-stdout\fR" 4
.IX Item "--stdout"
Print the inventory on stdout.
.Sp
.Vb 3
\&    % ocsinventory\-agent \-\-stdout > /tmp/report.xml
\&    # prepare an inventory and write it in the /tmp/report.xml file.
\&    # A file will be created.
.Ve
.IP "\fB\-\-scan\-homedirs\fR" 4
.IX Item "--scan-homedirs"
Authorized \s-1OCS\s0 to scan home directories to increase the Virtual Machine inventory.
\&\s-1WARNING:\s0 beware with user privacy by using this option because it may encounter private data scans (even if it's not designed for !).
.IP "\fB\-\-ssl\fR=\fI0|1\fR" 4
.IX Item "--ssl=0|1"
Check \s-1SSL\s0 communications using a certificate.
Set to 0 if you want to disable certificate check or 1 to enable (needs \s-1CA\s0 certificates file path in this case) . Default is set to 1.
.IP "\fB\-\-ca\fR=\fI\s-1FILE\s0\fR" 4
.IX Item "--ca=FILE"
Path to \s-1CA\s0 certificates file in \s-1PEM\s0 format, for server \s-1SSL\s0 certificate validation.
Set to <your server configuration directory>/cacert.pem by default.
.IP "\fB\-\-tag\fR=\fI\s-1TAG\s0\fR" 4
.IX Item "--tag=TAG"
Mark the machine with the \fI\s-1TAG\s0\fR tag. Once the initial inventory is accepted by the server this value is ignored and you've to change the information directly on the server. The server do so in order to centralize the administration of the machine.
.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 the server authentication.
.IP "\fB\-\-version\fR=\fI\s-1USER\s0\fR" 4
.IX Item "--version=USER"
Print the version and exit.
.IP "\fB\-w\fR \fI\s-1DURATION\s0\fR, \fB\-\-wait\fR=\fI\s-1DURATION\s0\fR" 4
.IX Item "-w DURATION, --wait=DURATION"
Wait before initializing the connexion with the server. If \fI\s-1DURATION\s0\fR equal \fIserver\fR the agent will use the \s-1PROLOG_FREQ\s0 of the server to determine the duration of this periode. Exactly like it would had done if it was in \-\-daemon mode.
Else if duration is a numerical value, it will be used directly.
.Sp
.Vb 1
\&    % ocsinventory\-agent \-\-wait 5 \-\-server localhost
.Ve
.IP "\fB\-\-nosoftware\fR" 4
.IX Item "--nosoftware"
Do not inventory the software installed on the machine. \fB\-\-nosoft\fR also
works but is deperecated.
.IP "\fB\-\-nolocal\fR" 4
.IX Item "--nolocal"
Deactivate local mode even if it is set in config file or command line
.SH "CONFIG FILE"
.IX Header "CONFIG FILE"
The agent try to initialize the settings from the \fBocsinventory\-agent.cfg\fR
config file.
.PP
It looks for the file in these directories:
.IP "/etc/ocsinventory" 4
.IX Item "/etc/ocsinventory"
.PD 0
.IP "/usr/local/etc/ocsinventory" 4
.IX Item "/usr/local/etc/ocsinventory"
.IP "/etc/ocsinventory\-agent" 4
.IX Item "/etc/ocsinventory-agent"
.PD
.SH "AUTHORS"
.IX Header "AUTHORS"
The maintainer is Guillaume \s-1PROTET\s0 <guillaume.protet@mortheres.info>
.PP
Please read the \s-1AUTHORS,\s0 Changes and \s-1THANKS\s0 files to see who is behind \s-1OCS\s0
Inventory Agent.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "OCS-Inventory website," 4
.IX Item "OCS-Inventory website,"
.Vb 1
\& http://www.ocsinventory\-ng.org/
.Ve
.IP "LaunchPad project page," 4
.IX Item "LaunchPad project page,"
.Vb 1
\& http://launchpad.net/ocsinventory\-unix\-agent
.Ve
.IP "forum," 4
.IX Item "forum,"
.Vb 1
\& http://forums.ocsinventory\-ng.org/
.Ve
.IP "and wiki" 4
.IX Item "and wiki"
.Vb 1
\& http://wiki.ocsinventory\-ng.org/
.Ve
.SH "BUGS"
.IX Header "BUGS"
Please, use the forum as much as possible. You can open your own bug tickets.
Patches are welcome. You can also use LaunchPad bugtracker or
push your Bazaar branch on LaunchPad and do a merge request.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006\-2016 \s-1OCS\s0 Inventory contributors
.PP
.Vb 4
\& This program 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 of the License, or
\& (at your option) any later version.
\&
\& 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.
\&
\& You should have received a copy of the GNU General Public License
\& along with this program; if not, write to the Free Software
\& Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111\-1307 USA
.Ve