Use CMDBsyncer as a Simple CMDB

CMDBsyncer can be used as a lightweight CMDB, even without a full external source system. In this mode, you create and maintain objects and hosts directly in the UI.

What CMDB mode does

If CMDB_MODE is enabled, you can manage CMDB-like data directly inside CMDBsyncer:

• Create Objects (for example application, network, contact, group)
• Create Templates and assign them to hosts/objects
• Maintain custom fields (cmdb_fields) with your Data

Enable CMDB mode

In your local_config.py, enable CMDB mode:

config = {
  "CMDB_MODE": True,
}

Thats default enabled with Syncer Version 3.12.4.

Create hosts

1. Open Hosts.
2. Click Create.
3. Fill basic data:
4. hostname
5. object_type
6. available
7. optional cmdb_templates
8. Add or update CMDB fields in the form.
9. Save.

Hosts created this way are treated as CMDB-managed entries inside the syncer.

Create objects

1. Open the admin UI.
2. Go to Objects → All Objects.
3. Click Create.
4. Fill:
5. Object Name
6. Object Type
7. CMDB Fields (key/value pairs)
8. Save.

Objects are stored as internal CMDB entries and can be used by rules, filters, but not host exports.

Use Account object mode (cmdb_object) for external imports

You can also import objects from external sources and still treat them as CMDB-managed entries in CMDBsyncer.

In the related account, enable object mode and set cmdb_object:

• Enable cmdb_object
• Ifis_object is enabled, the data can be used in rules, but will not exportet to systems like Checkmk
• Set the matching object_type

Create and use templates (cmdb_match)

Templates are special CMDB objects used to standardize fields.

1. Open Objects → Templates.
2. Create or edit a template with:
3. template name
4. Add CMDB Fields
5. optional cmdb_match
6. Save.

cmdb_match is used for automatic assignment of templates to objects/hosts.

• Format: label_key:label_value
• Matching is exact (label key and value)
• Example: site:dc1

When an object/host is created or processed and its labels match the expression, the template is added automatically to cmdb_templates.

If you changed template matching rules and want to re-apply matching to existing objects/hosts, run:

./cmdbsyncer sys update_cmdb

Define default CMDB fields in local_config.py

You can predefine CMDB fields globally and per object type via CMDB_MODELS. Use application/config.py as the structure reference, then override it in local_config.py.

Example

config = {
  "CMDB_MODE": True,
  "CMDB_MODELS": {
    "host": {
      "ipaddress": {"type": "string"},
      "environment": {"type": "string"}
    },
    "network": {
      "cidr": {"type": "string"}
    },
    "all": {
      "owner": {"type": "string"},
      "managed": {"type": "boolean"}
    }
  }
}

How it works

• all: fields added for every object/host type
• <object_type> (for example host, network): fields only for that type
• supported field types in forms:
• string
• boolean

When you save a host/object, missing configured fields are added automatically to cmdb_fields.

Notes

• Keep CMDB_MODE enabled if you want to maintain CMDB data in the UI.
• After changing local_config.py, restart the application.
• Start with a small set of required fields in CMDB_MODELS and extend gradually.