Here are listed the command line interface executables, with their syntax usage and available options.
Note: from command line interface, each command provide '--help' option that will print the usage of respective command.
shinken-discovery [options] -c discovery_config -o config_output -m list of macros
| name | Description |
|---|---|
--version | Show program's version number and exit. |
-h, --help | Show this help message and exit. |
-c CFG_INPUT, --cfg-input=CFG_INPUT | Discovery configuration file (default: discovery.cfg). |
-o OUTPUT_DIR, --dir-output=OUTPUT_DIR | Directory output for results. |
-w, --overwrite | Allow overwriting an existing file (disabled by default). |
-r RUNNERS, --runners=RUNNERS | List of runners you allow to run (like nmap, vsphere). |
-m MACROS, --macros=MACROS | List of macros (like NMAPTARGETS=192.168.0.0/24). Should be the last argument. |
--db=DBMOD | Optional: Name of the database module to use. |
--backend=BACKEND | Optional: Name of a module that will totally manage the object writing/update thing. If you don't know what it means, maybe you should not use this option :). |
--modules_path=MODULES_PATH | Optional: Path for the module loading. If you don't know what it means, maybe you should not use this option :). |
--merge | Optional: In multiple discovery level, it is the final host name which wins. Make possible merge of multiple IP but same final device. |
shinken-receiver [options]
| Description | |
|---|---|
--version | Show program's version number and exit. |
-h, --help | Show this help message and exit. |
-c INI-CONFIG-FILE, --config=INI-CONFIG-FILE | Config file. |
-d, --daemon | Run in daemon mode. |
-r, --replace | Replace previous running receiver. |
--debugfile=DEBUG_FILE | Debug file. Default: not used (why debug a bug free program? :) ). |
shinken-arbiter
shinken-healthcheck
shinken-restore
shinken-backup
shinken-poller
shinken-scheduler
shinken-broker
shinken-reactionner
shinken-synchronizer