File Connector

File Connector

Description

File Connector


Import hosts from a file in CSV, JSON or BVQ format.
This makes use of Check MKs Dynamic Host Configuration (DCD) feature.


Download


You can download releases of this package from fileconnector @ checkmk exchange.


The source code is available at GitHub: svalabs/checkmk_dcd_file_connector.


Usage


After installation you will have to create a new connection using the File Import connector type.


You will have to specify an existing file that will be used for importing.
Alongside that you have to choose the format your data is in.


The plugin tries to detect IP addresses and set them accordingly on your hosts. Field names that are assumed to contain an IP are ipv4, ip, ipaddress.
If an import file does not contain any of these fields existing IPs will not be changed.


Managing different host properties


The plugin supports handling different properties of a host.
This is achieved by using column or field names with special prefixes.


If you prefix the column with label_ the contents of the column will be treated as a label. This is the default behaviour if neither one of the specific keywords nor another prefix is used.


You can prefix a column name with tag_ for an explicit handling as a tag (tag group). Please make sure that you reference the tag ID so that a match can be made, i.e. to match the ID flower you have to write tag_flower.
Handling of tags is possible with checkmk instances using the deprecated web API (until 2.1) or with instances that support werk 13964.


If you prefix the column with attr_ the contents will be handled as an attribute. Please make sure to Missing attributes have to be created manually, the connector will not create these.


File Formats


The importer supports various file formats.


CSV file


The first column in the CSV is expected to contain the hostname.


Example


A file for an import might look like this:


csv
HOSTNAME,STANDORT,STADT,IDENT
ABC001,DARZ,Darmstadt,NET
ABC002,WIRZ,Wiesbaden,NET


JSON file


The file is to be expected to contain an array of JSON objects.


It will try to detect the field that contains the hostname.
If it fails it will try to find a field with an IP.


Example


A file for an import might look like this:


json
[
{
"hostname": "ABC001",
"STANDORT": "DARZ",
"STADT": "Darmstadt",
"IDENT": "NET"
},
{
"hostname": "ABC002",
"STANDORT": "WIRZ",
"STADT": "Wiesbaden",
"IDENT": "NET"
}
]


BVQ file


It is possible to import an BVQ state file by selecting the
corresponding Data Format during the connection configuration.


Troubleshooting


Logs


The connector uses the DCD logging.
Please keep in mind that there are separate log settings for the DCD that allow increasing the log level only for DCD.


You can also have a look at the log file.


omd restart


If problems occur after an update it is recommend run an omd restart once.


It is also recommended to execute omd restart if you happen to stumble upon an error message like Skipping connection "import_hosts" because of unknown connector type "fileconnector" or Failed to get the status from DCD (The connection "con_1" does not exist).


Latest Version

Version: 3.4.1
Packaged at: 12 Apr 2024
Created on Checkmk version: 2.0.0p6
Minimum Checkmk version required: 2.0.0p1
MKP MD5 hash: 0198d29a3feb6929d033ce7630e93983
This version requires Checkmk version 2.0.0 or higher
Libraries
  • check_mk/cee/dcd/plugins/connectors/fileconnector.py
GUI Extensions
  • plugins/wato/fileconnector.py
  • Version: 3.4.1
    Packaged at: 12 Apr 2024
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: 0198d29a3feb6929d033ce7630e93983
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.4.0
    Packaged at: 09 Jan 2024
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: 5b27f28a9860f1a80cabc156bea9b8b0
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.3.0
    Packaged at: 30 Mar 2023
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: 5401f5f9b1af06d9053635d52c214177
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.2.2
    Packaged at: 29 Dec 2022
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: d8e26860591574fd4ee40b4d7767162b
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.2.1
    Packaged at: 27 Dec 2022
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: fd40a2b52f66cd5d79db0dfea5412d9e
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.1.2
    Packaged at: 06 Sep 2022
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: 9f1c5c0fd95f0f74a9e2be2daabd1466
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.1.1
    Packaged at: 24 May 2022
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: a5dc3ffb169bb54a436d2ad5b3b03f3e
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.1.0
    Packaged at: 06 May 2022
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: 88750943e43e5f49c916e2131bfaf298
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.0.1
    Packaged at: 29 Apr 2022
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: 41863351e58e415ed3818d9c27b69e9a
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
  • Version: 3.0.0
    Packaged at: 27 Apr 2022
    Created on Checkmk version: 2.0.0p6
    Minimum Checkmk version required: 2.0.0p1
    MKP MD5 hash: 08b873c22980557d3c6c3666b14cbacb
    Description:
    Libraries
    • check_mk/cee/dcd/plugins/connectors/fileconnector.py
    GUI Extensions
    • plugins/wato/fileconnector.py
No reviews added yet.

By downloading packages from the Checkmk Exchange you agree to our Terms of Use.