...
Note: from command line interface, each command provide provides '--help' option that will print the usage of respective command.
shinken-discovery
Usage:
shinken-discovery [options] -c discovery_config -o config_output -m list of macrosOptions:
| 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
Usage:
shinken-receiver [options]Options:
| name | 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
Usage:
shinken-arbiter [options] -c configfile [-c additional_config_file]
Options:
| Description | |
|---|---|
| --version | Show program's version number and exit. |
| -h, --help | Show this help message and exit. |
| -c CONFIG-FILE, --config=CONFIG-FILE | Config file (your nagios.cfg). Multiple -c can be used, it will be like if all files was just one. |
| -d, --daemon | Run in daemon mode. |
| -r, --replace | Replace previous running arbiter |
| --debugfile=DEBUG_FILE | Debug file. Default: not used (why debug a bug free program? :) ). |
| -v, --verify-config | Verify config file and exit. |
| -p PROFILE, --profile=PROFILE | Dump a profile file. Need the python cProfile library |
| -a ANALYSE, --analyse=ANALYSE | Dump an analyse statistics file, for support. |
| -m MIGRATE, --migrate=MIGRATE | Migrate the raw configuration read from the arbiter to another module. VERY EXPERIMENTAL! |
| -n ARB_NAME, --name=ARB_NAME | Give the arbiter name to use. Optional, will use the host address if not provide to find it. |
shinken-healthcheck
This tool is used to check the state of your Shinken Enterprise installation
and configuration
Usage:
shinken-healthcheckOptions:
| Description | |
|---|---|
| --version | Show program's version number and exit. |
| -h, --help | Show this help message and exit. |
| -w, --write-output | Write output that can be send to the Shinken Solutions. |
shinken-restore
shinken-backup
shinken-poller
shinken-scheduler
shinken-broker
shinken-reactionner
shinken-synchronizer
- Health check command: check your Shinken Enterprise installation
- Backup and restore commands: backup and restore your Shinken Enterprise
- Daemon manual commands: to use if you need to manually launch a daemon (debugging)
- Daemons listing/enable/disable: to use to list, enable or disable a daemon on your local server
...