...
Note: from command line interface, each command provide '--help' option that will print the usage of respective command.
Tools
shinken-
...
healthcheck
This tool is used to check the state of your Shinken Enterprise installation
and configuration
Usage:
shinken-discovery [options] -c discovery_config -o config_output -m list of macroshealthcheck
Options:
| Name | Description |
|---|---|
--version | Show program's version number and exit. |
-h, --help | Show this help message and exit. |
-c CFG_INPUTw, --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. |
...
write-output | Write output that can be send to the Shinken Solutions. |
shinken-restore
Usage:
shinken-restore DIRECTORY-TO-RESTORE
shinken-backup
Usage:
shinken-backup [--name BACKUP-NAME]
Daemons
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:
| Name | 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 | |
| Name | 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 SolutionsGive 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:
| . |
shinken-restore
Usage:
shinken-restore DIRECTORY-TO-RESTORE
shinken-backup
Usage:
...
shinken-poller
Usage:
shinken-poller [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 poller. |
--debugfile=DEBUG_FILE | Debug file. Default: not used (why debug a bug free program? :) ). |
-p PROFILE, --profile=PROFILE | Dump a profile file. Need the python cProfile library. |
shinken-scheduler
Usage:
shinken-scheduler [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 scheduler. |
--debugfile=DEBUG_FILE | Debug file. Default: not used (why debug a bug free program? :) ). |
-p PROFILE, --profile=PROFILE | Dump a profile file. Need the python cProfile library. |
shinken-broker
Usage:
shinken-broker [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 broker. |
--debugfile=DEBUG_FILE | Debug file. Default: not used (why debug a bug free program? :) ). |
-p PROFILE, --profile=PROFILE | Dump a profile file. Need the python cProfile library. |
shinken-reactionner
Usage:
shinken-reactionner [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 reactionner. |
--debugfile=DEBUG_FILE | Debug file. Default: not used (why debug a bug free program? :) ). |
-p PROFILE, --profile=PROFILE | Dump a profile file. Need the python cProfile library. |
shinken-synchronizer
Usage:
shinken-synchronizer [options] -c configfile [-c additional_config_file]
Options:
| Name | 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. |