Page History

define source {

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────────────    SOURCE IDENTITY    ──────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Source name [ Must be unique ]                                                      [ MANDATORY ]          ───
    module_type       ───
    # ───                             discovery-import

    # ─── Interval between each automatic import                                                                                ───
    source_name# ─── Interval in minutes between each automatic import of the source                                          discovery

    # ─── Source module type [ Do not edit ]───
    # ───       -> Setting it to 0 will deactivate the automatic import and can only be done manually                       [ MANDATORY ]  ───
    #           Default : 5  ───
    # ───                                                                                              ───
    #                     ───
    module_type                                         discovery-import

    # ─── Interval between each automatic import                                               ───
    import_interval                             ───
    # ─── Interval in minutes5

 between each automatic import# of─── theOrder sourceof priority when merging data                                                   ───
    # ───       -> Setting it to 0 will deactivate the automatic import and can only be done manually     ───
    # ─── The final element will take the value of the element from the source with the highest ───
priority    #           Default : 5       ───
    # ───       -> Priority at source with the order closest to 1                                                               ───
    #      ───
    # Default : 10                                                                                                    ───
    #                ───
    import_interval                                     5

    # ─── Order of priority when merging data                                                       ───
    order                        ───
    # ─── The final element will take the value of the element from the source with the highest priority 10

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────────    DATABASE OPTIONS    ──────────────────────────────────────────────── │ ───#
    # ───└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ────────────────────── -> PriorityGeneral at source────────────────────────────────────────────────────────────────────────────────────────── with#

 the order closest to# 1─── Database backend                                                             ───
    #           Default : 10                        ───
    #                                                                        ───
    #                                                 ───
    #           Default : mongodb => Use Mongo as database backend                                                   ───
    order       ───
    # ───                                   10

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────────    DATABASE OPTIONS    ──────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ──────────────────────  General  ──────────────────────────────────────────────────────────────────────────────────────────── 

    # ─── Database backend                                      ───
    data_backend                                        mongodb

    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────────────────────────── #

    # ─── USE ONLY  ───
    #IF "data_backend" IS SET TO "mongodb"                                                                        ───

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                  ───
    #           Default : mongodb => Use Mongo as───
 database backend  # ─── https://docs.mongodb.com/manual/reference/connection-string/                                                          ───
    #                                                                                                                           ───
    data_backend#           Default : mongodb://localhost/?w=1&fsync=false                           mongodb

    # ─────────────────  MongoDB parameters  ────────────────────────────────────────────────────────────────────────────────────── 

    # ─── USE ONLY IF "data_backend" IS SET TO "mongodb"               ───
    #  ───                                                   ───

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                                       ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/ ───
    mongodb_uri                                         mongodb://localhost/?w=1&fsync=false

    # ─── Database to use     ───
    #                                                                                              ───
    #                         ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                                                  ───
    #           ───
    #           Default : synchronizer                                                                                          ───
    # ───
       mongodb_uri                                         mongodb://localhost/?w=1&fsync=false

    # ─── Database to use                                                               ───
    mongodb_database                                    ───synchronizer

    # ─── username/password to authenticate to MongoDB.                                                                         ───
    # ─── Both parameters must be provided for authentication to function correctly.                             ───
    #           Default───
 : synchronizer  # ───                                                                                       ───
    #                            ───
    # synchronizer__source_discovery-import__database__username 

    # ───                                                                                    ───
    mongodb_database                               ───
    # synchronizer__source_discovery-import__database__password 

    # ─── SSH tunnel activation to secure your mongodb connection                                                               ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                                                  ───
    #                                                                                                                           ───
    #           Default : 0 => Disable ( disable ssh tunnel )                                                                   ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )                                                                    ───
    #  ───                                                                                                                         ───
    mongodb_use_ssh_tunnel                              0

    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive                       ───
    #                                                                                                                           ───
    #           Default : 1 ( number of retry )                                                                                 ───
    #  ───                                                                                                                         ───
    mongodb_use_ssh_retry_failure                       1

    # ─── SSH user to connect to the mongodb server.                                                                            ───
    #                                                                                                                           ───
    #           Default : shinken                                                                                               ───
    # ───                                                                                                                          ───
    mongodb_ssh_user                                    shinken

    # ─── SSH keyfile to connect to the mongodb server.                                                                         ───
    #                                                                                                                           ───
    #           Default : ~shinken/.ssh/id_rsa                                                                                  ───
    # ───                                                                                                                          ───
    mongodb_ssh_keyfile                                 ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                                              ───
    #                                                                                                                           ───
    #           Default : 10 ( seconds )                                                                                        ───
    #    ───                                                                                                                       ───
    mongodb_retry_timeout                               10

    # ─── Number of connection tries to do before considering a request as an error.                                            ───
    #                                                                                                                           ───
    #           Default : 15 ( tries )                                                                                          ───
    #    ───                                                                                                                       ───
    discovery-import__database__retry_connection_X_times_before_considering_an_error 15

    # ─── Time interval between each attempt.                                                                                   ───
    #                                                                                                                           ───
    #           Default : 5 ( seconds )                                                                                         ───
    #    ───                                                                                                                       ───
    discovery-import__database__wait_X_seconds_before_reconnect 5

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────────    INTERNAL OPTIONS    ──────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Path to your discovery rules file.                                                                                    ───
    #                                                                                                                           ───
    #           Default : /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/discovery_rules.json          ───
    #   ───                                                                                                                        ───
    rules_path                                          /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/discovery_rules.json

    # ─── Path to your nmap-mac-prefixes file.                                                                                  ───
    #                                                                                                                           ───
    #           Default : /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes        ───
    #   ───                                                                                                                        ───
    nmap_mac_prefixes_path                              /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes

}