Documentation sync with IT Glue and Hudu

Documentation sync keeps IT Glue or Hudu up to date with the devices Monitaria monitors. Each device gets one record in the customer its site belongs to: an IT Glue configuration in an organization, or a Hudu asset in a company. Monitaria fills it with what it knows about the device and keeps those details current.

• One-way: Monitaria writes to IT Glue or Hudu and never reads documentation back.
• No duplicates: an existing record is found by serial number, then MAC address, then name, before anything is added.
• Nothing is deleted: when a device leaves Monitaria, its record gets "Not seen by Monitaria since <date>." in its notes, once, and stays where it is.
• Preview first: Preview changes lists every add and update and changes nothing.
• Off by default: nothing leaves the collector until an admin saves an API key, turns a connection on, matches a site to a customer, and then previews, syncs or turns on the daily sync.

1. Connect IT Glue or Hudu

1. Create an API key. In IT Glue, use Account › Settings › API Keys and give the key rights to read and edit configurations. In Hudu, create it under API Keys in Hudu's admin area, without a company restriction, so every customer can be matched.
2. Open Settings › Documentation sync.
3. In the IT Glue panel, choose your Region. In the Hudu panel, enter your Hudu address, such as https://docs.example.com. Paste the key under API key.
4. Tick Turn on: let Monitaria read and write IT Glue (or Hudu). Choose Save, then Test connection.

2. Match sites and device types

1. Under Matching, choose Load lists from IT Glue (or Hudu). It reads your organizations or companies, and your configuration types or asset layouts.
2. Under Sites, choose the organization or company for each site, for example Warehouse goes to Riverbend Logistics. A site whose name matches a customer is marked suggested. Sites left on Not synced are skipped.
3. Under Device types, choose what each kind of device becomes. In IT Glue it's a configuration type, suggested by name (Switches becomes Switch), and All other device types starts as Don't sync. In Hudu it's an asset layout, starting as Monitaria device (made by Monitaria), which is created the first time it's needed. Websites & services start as Don't sync, since they aren't devices.
4. If a device type goes to one of your own Hudu layouts, choose under Hudu fields which field each detail fills. Fields left on Don't fill are left alone.
5. Choose Save matching.

3. Preview, sync and schedule

1. Choose Preview changes. Every device is listed with what would happen and why: to add, to update (each field from → to, and how the record was matched), unchanged, to mark not seen, or skipped, with the reason. Each number in the summary filters the list.
2. Choose Leave out next to any device that should never be synced. Include again is under Matching.
3. Choose Sync now and confirm.
4. Under Daily sync, tick Sync every day at, pick the hour and choose Save. The hour is the collector's local time. If the collector is off then, the sync runs when it starts again.

After each run, Results shows what happened to every device, with an Open link to its record; History lists recent previews and syncs, and Log shows a run line by line. Once a device has a record, its details show a Documentation panel with when it was last checked and an Open in IT Glue or Open in Hudu link. Syncs that add or change a record also appear in the device's timeline. Each real sync emits docsync.completed or docsync.failed, so Settings › Webhooks can tell another system how it went.

What is written

Each record gets the device's host name, IP and MAC address, serial number, manufacturer and model, operating system and firmware, plus a short note in a marked [Monitaria] … [/Monitaria] block with its site, device type and sensors. Monitaria replaces only that block and keeps anything people wrote around it. A new record is named after the device without its site and address, so Warehouse · RB-WH-SW01 (198.51.100.20) becomes RB-WH-SW01; names, configuration types and statuses are then yours to change, and Monitaria won't change them back. An empty value never clears anything, and if IT Glue's key can't add a missing manufacturer or model, the record is saved without it.

Tip: When two or more records share a serial number, MAC address or name, Monitaria doesn't guess. It skips the device and says why: remove the duplicates in IT Glue or Hudu, or leave the device out. Placeholder serials such as To Be Filled By O.E.M. are ignored when matching.

Security and limits

• API keys are write-only: stored on the collector only, never shown again or logged, and only sent to the address they were saved for. Disconnect removes a key and changes nothing in IT Glue or Hudu.
• Only the details under What is written leave the network, and only to the saved address. Requests never go to link-local or cloud metadata addresses, redirects aren't followed, and there's no proxy support.
• Monitaria checks Hudu's certificate. Untick Check the certificate only for a self-hosted Hudu with its own certificate.
• Each site maps to one organization or company; IT Glue locations aren't set.
• A device that moves to another customer's site gets a new record there, and its old record isn't marked not seen.
• Interfaces, contacts and passwords aren't written, and Hudu asset links and relations aren't created.
• Changing the device type matching doesn't move or retype existing records. It applies to records added from then on.