1FUSIONINVENTORY-AGENT(1U)ser Contributed Perl DocumentatiFoUnSIONINVENTORY-AGENT(1)
2
3
4

NAME

6       fusioninventory-agent - FusionInventory agent For Linux/UNIX, Windows
7       and MacOSX
8

SYNOPSIS

10       fusioninventory-agent [options] [--server server|--local path]
11
12         Target definition options:
13           -s --server=URI                send tasks result to a server
14           -l --local=PATH                write tasks results locally
15
16         Target scheduling options:
17           --delaytime=LIMIT              maximum delay before first target,
18                                            in seconds (3600). It also defines the
19                                            maximum delay on network error. Delay on
20                                            network error starts from 60, is doubled at
21                                            each new failed attempt until reaching max
22           --lazy                         do not contact the target before
23                                          next scheduled time
24
25         Task selection options:
26           --list-tasks                   list available tasks and exit
27           --no-task=TASK[,TASK]...       do not run given task
28           --tasks=TASK1[,TASK]...[,...]  run given tasks in given order
29
30         Inventory task specific options:
31           --no-category=CATEGORY         do not list given category items
32           --scan-homedirs                scan user home directories (false)
33           --scan-profiles                scan user profiles (false)
34           --html                         save the inventory as HTML (false)
35           -f --force                     always send data to server (false)
36           --backend-collect-timeout=TIME timeout for inventory modules
37                                            execution (30)
38           --additional-content=FILE      additional inventory content file
39
40         Package deployment task specific options:
41           --no-p2p                       do not use peer to peer to download
42                                            files (false)
43
44         Network options:
45           -P --proxy=PROXY               proxy address
46           -u --user=USER                 user name for server authentication
47           -p --password=PASSWORD         password for server authentication
48           --ca-cert-dir=DIRECTORY        CA certificates directory
49           --ca-cert-file=FILE            CA certificates file
50           --no-ssl-check                 do not check server SSL certificate
51                                            (false)
52           -C --no-compression            do not compress communication with server
53                                            (false)
54           --timeout=TIME                 connection timeout, in seconds (180)
55
56         Web interface options:
57           --no-httpd                     disable embedded web server (false)
58           --httpd-ip=IP                  network interface to listen to (all)
59           --httpd-port=PORT              network port to listen to (62354)
60           --httpd-trust=IP               trust requests without authentication
61                                            token (false)
62           --listen                       enable listener target if no local or
63                                          server target is defined
64
65         Logging options:
66           --logger=BACKEND               logger backend (stderr)
67           --logfile=FILE                 log file
68           --logfile-maxsize=SIZE         maximum size of the log file in MB (0)
69           --logfacility=FACILITY         syslog facility (LOG_USER)
70           --color                        use color in the console (false)
71
72         Configuration options:
73           --config=BACKEND                   configuration backend
74           --conf-file=FILE                   configuration file
75           --conf-reload-interval=<SECONDS>   number of seconds between two
76                                                configuration reloadings
77
78         Execution mode options:
79           -w --wait=LIMIT                maximum delay before execution,
80                                            in seconds
81           -d --daemon                    run the agent as a daemon (false)
82           --no-fork                      don't fork in background (false)
83           -t --tag=TAG                   add given tag to inventory results
84           --debug                        debug mode (false)
85           --setup                        print the agent setup directories
86                                            and exit
87           --version                      print the version and exit
88           --no-win32-ole-workaround      [win32 only] disable win32 work-around
89                                            used to better handle Win32::OLE apis.
90                                            !!! Use it at your own risk as you may
91                                            experiment perl crash under win32 !!!
92

DESCRIPTION

94       The fusioninventory-agent agent is a generic multi-platform agent. It
95       can perform a large array of management tasks, such as local inventory,
96       software deployment or network discovery. It can be used either
97       standalone, or in combination with a compatible server (OCS, GLPI,
98       OTRS) acting as a centralized control point.
99

OPTIONS

101       Most of the options are available in a short form and a long form.  For
102       example, the two lines below are all equivalent:
103
104           % fusioninventory-agent -s localhost
105           % fusioninventory-agent --server localhost
106
107   Target definition options
108       -s, --server=URI
109           Send the results of tasks execution to given server.
110
111           If URI doesn't start with http:// or https://, the agent assume the
112           parameter is a hostname and rewrite it as:
113
114               % --server=http://example/plugins/fusioninventory
115
116           In general, OCS Inventory server URL have this format:
117
118               http://example/ocsinventory
119
120           and FusionInventory for GLPI this one:
121
122               http://example/glpi/plugins/fusioninventory/front/plugin_fusioninventory.communication.php
123
124           Multiple values can be specified, using comma as a separator.
125
126       -l, --local=PATH
127           Write the results of tasks execution locally.
128
129           Exact behaviour according to given path:
130
131           ·   if PATH is a directory, a file will be created therein
132
133           ·   if PATH is a file, it will be used directly
134
135           ·   if PATH is '-', STDOUT will be used
136
137           Multiple values can be specified, using comma as a separator.
138
139   Target scheduling options
140       --delaytime=LIMIT
141           Set an initial delay before the first target, whose value is
142           computed randomly between LIMIT / 2 and LIMIT seconds. This setting
143           is ignored for server targets after the initial contact, in favor
144           of server-specified parameter (PROLOG_FREQ).
145
146       --lazy
147           Do not contact the target before next scheduled time.
148
149           This option is only available when the agent is not run as a
150           server.
151
152   Task selection options
153       --list-tasks
154           List all available tasks, tasks planned for execution and exit
155
156       --no-task=TASK
157           Do not run given task.
158
159           Multiple values can be specified, using comma as a separator. See
160           option --list-tasks for the list of available tasks.
161
162       --tasks=TASK
163           Run given tasks in given order.
164
165           Multiple tasks can be specified, using comma as a separator.  A
166           task can be specified several times. if '...' is given as last
167           element, all other available tasks are executed.
168
169           See option --list-tasks for the list of available tasks.
170
171           Examples :
172
173           * --tasks=inventory,deploy,inventory
174             First task executed is 'inventory', second task is 'deploy',
175           third and last
176             task is 'inventory'.
177
178           * --tasks=inventory,deploy,...
179             First executed task is 'inventory', second task is 'deploy' and
180           then all
181             other available tasks are executed.
182
183   Inventory task specific options
184       --no-category=CATEGORY
185           Do not list given category items in inventory.
186
187           Multiple values can be specified, using comma as a separator. The
188           available categories are:
189
190           ·   battery
191
192           ·   controller
193
194           ·   cpu
195
196           ·   drive
197
198           ·   environment
199
200           ·   input
201
202           ·   license
203
204           ·   local_group
205
206           ·   local_user
207
208           ·   lvm
209
210           ·   memory
211
212           ·   modem
213
214           ·   monitor
215
216           ·   network
217
218           ·   printer
219
220           ·   process
221
222           ·   slot
223
224           ·   software
225
226           ·   sound
227
228           ·   storage
229
230           ·   usb
231
232           ·   user
233
234           ·   video
235
236           ·   virtualmachine
237
238       --scan-homedirs
239           Allow the agent to scan home directories for virtual machines.
240
241       --scan-profiles
242           Allow the agent to scan user profiles for software.
243
244       --html
245           Save the inventory as HTML.
246
247           This is only used for local inventories.
248
249       -f, --force
250           Send an inventory to the server, even if this last one doesn't ask
251           for it.
252
253       --backend-collect-timeout=TIME
254           Timeout for inventory modules execution.
255
256       --additional-content=FILE
257           Additional inventory content file.
258
259           This file should be an XML file, using same syntax as the one
260           produced by the agent.
261
262   Package deployment task specific options
263       --no-p2p
264           Do not use peer to peer to download files.
265
266   Server target specific options
267       -P, --proxy=PROXY
268           Use PROXY as HTTP proxy.
269
270           By default, the agent uses HTTP_PROXY environment variable.
271
272       -u USER, --user=USER
273           Use USER for server authentication.
274
275       -p, --password=PASSWORD
276           Use PASSWORD for server authentication.
277
278       --ca-cert-dir=DIRECTORY
279           CA certificates directory.
280
281       --ca-cert-file=FILE
282           CA certificates file.
283
284       --no-ssl-check
285           Do not check server SSL certificate.
286
287       --timeout=TIME
288           Timeout for server connections.
289
290   Web interface options
291       --no-httpd
292           Disable the embedded web server.
293
294       --httpd-ip=IP
295           The network interface to use for the embedded web server (all).
296
297       --httpd-port=PORT
298           The network port to use for the embedded web server (62354).
299
300       --httpd-trust=IP
301           Trust requests from given addresses without authentication token
302           (false).
303
304           For example: "192.168.0.0/24", "192.168.168.0.5" or an IP range
305           like "20.34.101.207 - 201.3.9.99". Hostnames are also accepted. See
306           Net::IP documentation to get more example.
307
308           Multiple values can be specified, using comma as a separator.
309
310       --listen
311           This option should be used if no local or server target is defined
312           and the agent still needs to answer http requests. --no-httpd
313           should not be set and --httpd-trust should be set to enable trusted
314           remote clients.
315
316   Logging options
317       --logger=BACKEND
318           Logger backend to use.
319
320           Multiple values can be specified, using comma as a separator. The
321           available backends are:
322
323           ·   stderr: log messages directly in the console.
324
325           ·   file: log messages in a file.
326
327           ·   syslog: log messages through the local syslog server.
328
329           Multiple values can be specified, using comma as a separator.
330
331       --logfile=FILE
332           Log message in FILE (implies File logger backend).
333
334       --logfile-maxsize=SIZE
335           Max logfile size in MB, default is unlimited. When the max size is
336           reached, the file is truncated. This is only useful if there is no
337           log rotation mechanism on the system.
338
339       --logfacility=FACILITY
340           Syslog facility to use (default LOG_USER).
341
342       --color
343           Display color on the terminal, when the Stderr backend is used.
344
345           This options is ignored on Windows.
346
347   Configuration options
348       --config=BACKEND
349           Configuration backend to use.
350
351           The available backends are:
352
353           ·   file: read configuration from a file (default anywhere else as
354               Windows).
355
356           ·   registry: read configuration from the registry (default on
357               Windows).
358
359           ·   none: don't read any configuration.
360
361       --conf-file=FILE
362           Use FILE as configuration file (implies file configuration
363           backend).
364
365       --conf-reload-interval=SECONDS
366           SECONDS is the number of seconds between two configuration
367           reloadings.  Default value is 0, which means that configuration is
368           never reloaded.  Minimum value is 60. If given value is less than
369           this minimum, it is set to this minimum. If given value is less
370           than 0, it is set to 0.
371
372   Execution mode options
373       -w LIMIT, --wait=LIMIT
374           Wait a random delay whose value is computed randomly between 0 and
375           LIMIT seconds, before execution. This is useful when execution is
376           triggered from some kind of system scheduling on multiple clients,
377           to spread the server load.
378
379       -d, --daemon
380           Run the agent as a daemon.
381
382       --no-fork
383           Don't fork in background.
384
385           This is only useful when running as a daemon.
386
387       --pidfile[=FILE]
388           Store pid in FILE or in default PID file.
389
390           This is only useful when running as a daemon and still not managed
391           with a system service manager like systemd.
392
393       --tag=TAG
394           Add the given tag to every inventory results.
395
396       --debug
397           Turn the debug mode on. You can use the parameter up to 3 times in
398           a row to increase the verbosity (e.g: --debug --debug).
399
400           Level 3 turns on the debug mode of some external libraries like
401           Net::SSLeay.  These messages will only be be printed on STDERR.
402
403       --setup
404           Print the agent setup directories and exit.
405
406       --version
407           Print the version and exit.
408
409
410
411perl v5.30.0                      2019-08-12          FUSIONINVENTORY-AGENT(1)
Impressum