Here are listed the command line interface executable, with their syntax usage and available options.
Note: from command line interface, each command provides '--help' option that will print the usage of respective command.
--version show program's version number and exit
--proxy=PROXY Proxy URI. Like http://user:password@proxy-server:3128
-A API_KEY, --api-key=API_KEY Your API key for uploading the package to the Shinken.io website. If you don't have one, please go
to your account page
-l, --list List available commands
--init Initialize/refill your shinken.ini file (default to /root/.shinken.ini)
-D Enable the debug mode
-c INICONFIG, --config=INICONFIG Path to your shinken.ini file. (Default: /root/.shinken.ini)
-v Be more verbose
-h, --help Print help
shinken-discovery [options] -c discovery_config -o config_output -m lis
of macros
--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 (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
shinken-arbiter
shinken-healthcheck
shinken-restore
shinken-backup
shinken-poller
shinken-scheduler
shinken-broker
shinken-reactionner
shinken-synchronizer