The Nautobot importer can be used to import devices from Nautobot to Unimus using the Nautobot API.
If the importer is configured to run periodically on a schedule, this will effectively sync devices in your Nautobot instance to Unimus.
The importer supports syncing devices based on Role, Tag, Location or Custom field.
Nautobot importer supports remote UUIDs.
How to configure the importer
1) Provide the full Nautobot server URL in the "Nautobot server url" field.
For example: "https://10.2.0.111:2324/".
2) Provide Api token to access Nautobot.
3) Configure Role, Tag, Location or Custom field, to import devices from, one per line.
Device group must be configured in key value format e.g. "role= Switch", “tag=TagName”, "location=Server room racks", "field=FieldKey:FieldValue" (without quotes).
Values in Nautobot are case-sensitive, which is why it is necessary to use the exact same format of the value as stored in Nautobot.
Please be aware that for use of Custom field is necessary to specify custom field key (in Nautobot it can be found directly in the custom field section) NOT a label which is displayed in Nautobot UI.
The label is currently not supported by the Nautobot API, which is why no results can be expected for import using this parameter.
4) Optionally, you can also schedule the importer.
You simply need to select an existing (or use the default) schedule.
With this configuration, Unimus will sync against Nautobot periodically.
State field handling
Unimus will set the "Unmanaged" flag for a device based on the "status" field in Nautobot.
The managed state in Unimus will be set like this:
Nautobot status | Unimus status |
---|---|
active | set as Managed |
offline, failed, decommissioning, planned | set as Unmanaged |
any other value | set as Managed (New device) no change (Existing device) |