1FUSIONINVENTORY-AGENT(1U)ser Contributed Perl DocumentatiFoUnSIONINVENTORY-AGENT(1)
2
6 fusioninventory-agent - FusionInventory agent For Linux/UNIX, Windows
7 and MacOSX
8
10 fusioninventory-agent [options] [--server server|--local path]
11 Target definition options:
13 -s --server=URI send tasks result to a server
14 -l --local=PATH write tasks results locally
15 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 --set-forcerun set persistent state 'forcerun' option so a run
25 will be started immediately during a start or init
26 Task selection options:
28 --list-tasks list available tasks and exit
29 --no-task=TASK[,TASK]... do not run given task
30 --tasks=TASK1[,TASK]...[,...] run given tasks in given order
31 Inventory task specific options:
33 --no-category=CATEGORY do not list given category items
34 --scan-homedirs scan user home directories (false)
35 --scan-profiles scan user profiles (false)
36 --html save the inventory as HTML (false)
37 -f --force always send data to server (false)
38 --backend-collect-timeout=TIME timeout for inventory modules
39 execution (30)
40 --additional-content=FILE additional inventory content file
41 Package deployment task specific options:
43 --no-p2p do not use peer to peer to download
44 files (false)
45 Network options:
47 -P --proxy=PROXY proxy address
48 -u --user=USER user name for server authentication
49 -p --password=PASSWORD password for server authentication
50 --ca-cert-dir=DIRECTORY CA certificates directory
51 --ca-cert-file=FILE CA certificates file
52 --no-ssl-check do not check server SSL certificate
53 (false)
54 -C --no-compression do not compress communication with server
55 (false)
56 --timeout=TIME connection timeout, in seconds (180)
57 Web interface options:
59 --no-httpd disable embedded web server (false)
60 --httpd-ip=IP network interface to listen to (all)
61 --httpd-port=PORT network port to listen to (62354)
62 --httpd-trust=IP trust requests without authentication
63 token (false)
64 --listen enable listener target if no local or
65 server target is defined
66 Logging options:
68 --logger=BACKEND logger backend (stderr)
69 --logfile=FILE log file
70 --logfile-maxsize=SIZE maximum size of the log file in MB (0)
71 --logfacility=FACILITY syslog facility (LOG_USER)
72 --color use color in the console (false)
73 Configuration options:
75 --config=BACKEND configuration backend
76 --conf-file=FILE configuration file
77 --conf-reload-interval=<SECONDS> number of seconds between two
78 configuration reloadings
79 Execution mode options:
81 -w --wait=LIMIT maximum delay before execution,
82 in seconds
83 -d --daemon run the agent as a daemon (false)
84 --no-fork don't fork in background (false)
85 -t --tag=TAG add given tag to inventory results
86 --debug debug mode (false)
87 --setup print the agent setup directories
88 and exit
89 --version print the version and exit
90 --no-win32-ole-workaround [win32 only] disable win32 work-around
91 used to better handle Win32::OLE apis.
92 !!! Use it at your own risk as you may
93 experiment perl crash under win32 !!!
94
96 The fusioninventory-agent agent is a generic multi-platform agent. It
97 can perform a large array of management tasks, such as local inventory,
98 software deployment or network discovery. It can be used either
99 standalone, or in combination with a compatible server (OCS, GLPI,
100 OTRS) acting as a centralized control point.
101
103 Most of the options are available in a short form and a long form. For
104 example, the two lines below are all equivalent:
105 % fusioninventory-agent -s localhost
107 % fusioninventory-agent --server localhost
108 Target definition options
110 -s, --server=URI
111 Send the results of tasks execution to given server.
112 If URI doesn't start with http:// or https://, the agent assume the
114 parameter is a hostname and rewrite it as:
115 % --server=http://example/plugins/fusioninventory
117 In general, OCS Inventory server URL have this format:
119 http://example/ocsinventory
121 and FusionInventory for GLPI this one:
123 http://example/glpi/plugins/fusioninventory/front/plugin_fusioninventory.communication.php
125 Multiple values can be specified, using comma as a separator.
127 -l, --local=PATH
129 Write the results of tasks execution locally.
130 Exact behaviour according to given path:
132 • if PATH is a directory, a file will be created therein
134 • if PATH is a file, it will be used directly
136 • if PATH is '-', STDOUT will be used
138 Multiple values can be specified, using comma as a separator.
140 Target scheduling options
142 --delaytime=LIMIT
143 Set an initial delay before the first target, whose value is
144 computed randomly between LIMIT / 2 and LIMIT seconds. This setting
145 is ignored for server targets after the initial contact, in favor
146 of server-specified parameter (PROLOG_FREQ).
147 --lazy
149 Do not contact the target before next scheduled time.
150 This option is only available when the agent is not run as a
152 server.
153 Task selection options
155 --list-tasks
156 List all available tasks, tasks planned for execution and exit
157 --no-task=TASK
159 Do not run given task.
160 Multiple values can be specified, using comma as a separator. See
162 option --list-tasks for the list of available tasks.
163 --tasks=TASK
165 Run given tasks in given order.
166 Multiple tasks can be specified, using comma as a separator. A
168 task can be specified several times. if '...' is given as last
169 element, all other available tasks are executed.
170 See option --list-tasks for the list of available tasks.
172 Examples :
174 * --tasks=inventory,deploy,inventory
176 First task executed is 'inventory', second task is 'deploy',
177 third and last
178 task is 'inventory'.
179 * --tasks=inventory,deploy,...
181 First executed task is 'inventory', second task is 'deploy' and
182 then all
183 other available tasks are executed.
184 Inventory task specific options
186 --no-category=CATEGORY
187 Do not list given category items in inventory.
188 Multiple values can be specified, using comma as a separator. The
190 available categories are:
191 • battery
193 • controller
195 • cpu
197 • drive
199 • environment
201 • input
203 • license
205 • local_group
207 • local_user
209 • lvm
211 • memory
213 • modem
215 • monitor
217 • network
219 • printer
221 • process
223 • slot
225 • software
227 • sound
229 • storage
231 • usb
233 • user
235 • video
237 • virtualmachine
239 --scan-homedirs
241 Allow the agent to scan home directories for virtual machines.
242 --scan-profiles
244 Allow the agent to scan user profiles for software.
245 --html
247 Save the inventory as HTML.
248 This is only used for local inventories.
250 -f, --force
252 Send an inventory to the server, even if this last one doesn't ask
253 for it.
254 --backend-collect-timeout=TIME
256 Timeout for inventory modules execution.
257 --additional-content=FILE
259 Additional inventory content file.
260 This file should be an XML file, using same syntax as the one
262 produced by the agent.
263 Package deployment task specific options
265 --no-p2p
266 Do not use peer to peer to download files.
267 Server target specific options
269 -P, --proxy=PROXY
270 Use PROXY as HTTP proxy.
271 By default, the agent uses HTTP_PROXY environment variable.
273 -u USER, --user=USER
275 Use USER for server authentication.
276 -p, --password=PASSWORD
278 Use PASSWORD for server authentication.
279 --ca-cert-dir=DIRECTORY
281 CA certificates directory.
282 --ca-cert-file=FILE
284 CA certificates file.
285 --no-ssl-check
287 Do not check server SSL certificate.
288 --timeout=TIME
290 Timeout for server connections.
291 Web interface options
293 --no-httpd
294 Disable the embedded web server.
295 --httpd-ip=IP
297 The network interface to use for the embedded web server (all).
298 --httpd-port=PORT
300 The network port to use for the embedded web server (62354).
301 --httpd-trust=IP
303 Trust requests from given addresses without authentication token
304 (false).
305 For example: "192.168.0.0/24", "192.168.168.0.5" or an IP range
307 like "20.34.101.207 - 201.3.9.99". Hostnames are also accepted. See
308 Net::IP documentation to get more example.
309 Multiple values can be specified, using comma as a separator.
311 --listen
313 This option should be used if no local or server target is defined
314 and the agent still needs to answer http requests. --no-httpd
315 should not be set and --httpd-trust should be set to enable trusted
316 remote clients.
317 Logging options
319 --logger=BACKEND
320 Logger backend to use.
321 Multiple values can be specified, using comma as a separator. The
323 available backends are:
324 • stderr: log messages directly in the console.
326 • file: log messages in a file.
328 • syslog: log messages through the local syslog server.
330 Multiple values can be specified, using comma as a separator.
332 --logfile=FILE
334 Log message in FILE (implies File logger backend).
335 --logfile-maxsize=SIZE
337 Max logfile size in MB, default is unlimited. When the max size is
338 reached, the file is truncated. This is only useful if there is no
339 log rotation mechanism on the system.
340 --logfacility=FACILITY
342 Syslog facility to use (default LOG_USER).
343 --color
345 Display color on the terminal, when the Stderr backend is used.
346 This options is ignored on Windows.
348 Configuration options
350 --config=BACKEND
351 Configuration backend to use.
352 The available backends are:
354 • file: read configuration from a file (default anywhere else as
356 Windows).
357 • registry: read configuration from the registry (default on
359 Windows).
360 • none: don't read any configuration.
362 --conf-file=FILE
364 Use FILE as configuration file (implies file configuration
365 backend).
366 --conf-reload-interval=SECONDS
368 SECONDS is the number of seconds between two configuration
369 reloadings. Default value is 0, which means that configuration is
370 never reloaded. Minimum value is 60. If given value is less than
371 this minimum, it is set to this minimum. If given value is less
372 than 0, it is set to 0.
373 Execution mode options
375 -w LIMIT, --wait=LIMIT
376 Wait a random delay whose value is computed randomly between 0 and
377 LIMIT seconds, before execution. This is useful when execution is
378 triggered from some kind of system scheduling on multiple clients,
379 to spread the server load.
380 -d, --daemon
382 Run the agent as a daemon.
383 --no-fork
385 Don't fork in background.
386 This is only useful when running as a daemon.
388 --pidfile[=FILE]
390 Store pid in FILE or in default PID file.
391 This is only useful when running as a daemon and still not managed
393 with a system service manager like systemd.
394 --tag=TAG
396 Add the given tag to every inventory results.
397 --debug
399 Turn the debug mode on. You can use the parameter up to 3 times in
400 a row to increase the verbosity (e.g: --debug --debug).
401 Level 3 turns on the debug mode of some external libraries like
403 Net::SSLeay. These messages will only be be printed on STDERR.
404 --setup
406 Print the agent setup directories and exit.
407 --version
409 Print the version and exit.
410perl v5.36.0 2022-07-21 FUSIONINVENTORY-AGENT(1)