ocsinventory-agent(1)

1OCSINVENTORY-AGENT(1) User Contributed Perl DocumentationOCSINVENTORY-AGENT(1)
2
3
4

NAME

6       ocsinventory-agent - Unified client for OCS-Inventory
7

SYNOPSIS

9       ocsinventory-agent [ -fhilpruw ] [ --server server | --local /tmp ]...
10

EXAMPLES

12           % ocsinventory-agent --server localhost
13           # send an inventory to the OCS server
14
15           % ocsinventory-agent --server http://localhost/ocsinventory2
16           # send an inventory over http to a server with a non standard
17           # virtual directory
18
19           % ocsinventory-agent --server https://localhost/ocsinventory
20           # send an inventory over https to the OCS server
21
22           % ocsinventory-agent --local /tmp
23           # write an inventory in the /tmp directory
24
25           % ocsinventory-agent --server localhost --user=toto --password=pw --realm="Restricted Area"
26           # send a report to a server protected by a basic authentication
27           % ocsinventory-agent --lazy
28           # send an inventory only if the a random delay between 0 and PROLOG_FREQ had been run over.
29
30           % ocsinventory-agent --delaytime 60 -d
31           # 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]
32

DESCRIPTION

34       ocsinventory-agent creates inventory and send or write them. This agent
35       is the successor of the former linux_agent which was released with OCS
36       1.01 and prior. It also replaces the Solaris/AIX/BSD unofficial agents.
37       The detailed list of supported Operating System is available in the
38       Wiki.
39
40       GNU/Linux
41       Solaris
42       FreeBSD
43       NetBSD
44       OpenBSD
45       AIX
46       MacOSX
47       GNU/kFreeBSD
48

OPTIONS

50       Most of the options are available in a short form and a long form.  For
51       example, the two lines below are all equivalent:
52
53           % ocsinventory-agent -s localhost
54           % ocsinventory-agent --server localhost
55
56       --backend-collect-timeout=SECONDS_BEFORE_KILL
57           Time before OCS kills modules processing which don't end before the
58           timeout.
59
60       --basevardir=DIR
61           Indicate the place where the agent should store its files.
62
63       -d, --daemon
64           Launch ocsinventory-agent in background. Proc::Daemon is needed.
65
66       --debug
67           Turn the debug mode on.
68
69       --devlib
70           This option is designed for backend module developer. With it
71           enabled, ocsinventry-agent won't try to load the Backend module
72           installed on the system. Instead it will scan the ./lib directory.
73
74       --delaytime=SECONDS_TO_WAIT
75           This option defaults to waiting a random() time between 0 and 3600
76           before initially contacting the server assuming NO PROLOG_FREQ has
77           been set. Once PROLOG_FREQ has been set, it uses that number at the
78           top end of it's random setting. Useful for pre-setting a deployed
79           agent's initial start time (so you don't jam the server all at
80           once, but don't have to wait an hour to make sure the deployment
81           worked).
82
83       -f, --force
84           The agent will first contact the server during the PROLOG period.
85           If the server doesn't know the machine or has outdated information,
86           it will ask for an inventory.  With this option, the agent doesn't
87           run the PROLOG with the server first but directly sends an
88           inventory.
89
90       -i, --info
91           Turn the verbose mode on. The flag is ignored if --debug is enable.
92
93       --lazy
94           Do not contact the server more than one time during the PROLOG_FREQ
95           and do an exit if there is nothing to do. Useful if you want to
96           start the agent script regulary from the crontab but don't want to
97           overload the server.
98
99       -l, --local=DIR
100           Write an inventory in the DIR directory. A new file will be created
101           if needed.
102
103       --logfile=FILE
104           Log message in FILE and turn off STDERR
105
106       -p, --password=PASSWORD
107           Use PASSWORD for an HTTP identification with the server.
108
109       -P, --proxy=PROXY
110           Use PROXY to specify a proxy HTTP server. By default, the agent
111           uses HTTP_PROXY environment variable.
112
113       -r, --realm=REALM
114           Use REALM for an HTTP identification with the server. For example,
115           the value can be 'Restricted Area'. You can find it in the login
116           popup of your Internet browser.
117
118       -s, --server=URI
119           The uri of the server. If URI doesn't start with http:// or
120           https://, the assume the parameter is a hostname and rewrite it
121           like that:
122
123               % http://servername/ocsinventory
124
125           If you want to use https or another virtual directory you need to
126           enter the full path.
127
128           --server is ignored if --local is in use.
129
130       --stdout
131           Print the inventory on stdout.
132
133               % ocsinventory-agent --stdout > /tmp/report.xml
134               # prepare an inventory and write it in the /tmp/report.xml file.
135               # A file will be created.
136
137       --scan-homedirs
138           Authorized OCS to scan home directories to increase the Virtual
139           Machine inventory.  WARNING: beware with user privacy by using this
140           option because it may encounter private data scans (even if it's
141           not designed for !).
142
143       --ssl=0|1
144           Check SSL communications using a certificate.  Set to 0 if you want
145           to disable certificate check or 1 to enable (needs CA certificates
146           file path in this case) . Default is set to 1.
147
148       --ca=FILE
149           Path to CA certificates file in PEM format, for server SSL
150           certificate validation.  Set to <your server configuration
151           directory>/cacert.pem by default.
152
153       --tag=TAG
154           Mark the machine with the TAG tag. Once the initial inventory is
155           accepted by the server this value is ignored and you've to change
156           the information directly on the server. The server do so in order
157           to centralize the administration of the machine.
158
159       -u USER, --user=USER
160           Use USER for the server authentication.
161
162       --version=USER
163           Print the version and exit.
164
165       -w DURATION, --wait=DURATION
166           Wait before initializing the connexion with the server. If DURATION
167           equal server the agent will use the PROLOG_FREQ of the server to
168           determine the duration of this periode. Exactly like it would had
169           done if it was in --daemon mode.  Else if duration is a numerical
170           value, it will be used directly.
171
172               % ocsinventory-agent --wait 5 --server localhost
173
174       --nosoftware
175           Do not inventory the software installed on the machine. --nosoft
176           also works but is deperecated.
177
178       --nolocal
179           Deactivate local mode even if it is set in config file or command
180           line
181

CONFIG FILE

183       The agent try to initialize the settings from the
184       ocsinventory-agent.cfg config file.
185
186       It looks for the file in these directories:
187
188       /etc/ocsinventory
189       /usr/local/etc/ocsinventory
190       /etc/ocsinventory-agent
191

AUTHORS

193       The maintainer is Guillaume PROTET <guillaume.protet@mortheres.info>
194
195       Please read the AUTHORS, Changes and THANKS files to see who is behind
196       OCS Inventory Agent.
197

BUGS

212       Please, use the forum as much as possible. You can open your own bug
213       tickets.  Patches are welcome. You can also use LaunchPad bugtracker or
214       push your Bazaar branch on LaunchPad and do a merge request.
215

COPYRIGHT

217       Copyright (C) 2006-2016 OCS Inventory contributors
218
219        This program is free software; you can redistribute it and/or modify
220        it under the terms of the GNU General Public License as published by
221        the Free Software Foundation; either version 2 of the License, or
222        (at your option) any later version.
223
224        This program is distributed in the hope that it will be useful,
225        but WITHOUT ANY WARRANTY; without even the implied warranty of
226        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
227        GNU General Public License for more details.
228
229        You should have received a copy of the GNU General Public License
230        along with this program; if not, write to the Free Software
231        Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
232
233
234
235perl v5.34.0                      2022-01-26             OCSINVENTORY-AGENT(1)