> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/netbox-synchronizer.md).

# NetBox (synchronizer)

Configure NetBox synchronizer settings in Remote Desktop Manager, including URL, token ID, template, fields, schedule, and duplicate check options.

Every field from the ***NetBox*** entry is described in this article. The entry can be found in ***Edit*** – ***Add entry*** – ***Synchronizer***.

{% hint style="info" %}
The ***Schedule*** tab is shown only when the data source is Devolutions Server.
{% endhint %}

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>SETTINGS</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Name</strong></td><td>Enter a name for the entry.</td></tr><tr><td><strong>Folder</strong></td><td>Define in which folder the entry is going to exist (if any).</td></tr><tr><td><strong>Credentials</strong></td><td>Choose a credential mode. Read more on <a href="/rdm/ribbon-menu-bar/edit/entry-credentials-options.md"><em><strong>credentials</strong></em> options</a>.</td></tr><tr><td><strong>Synchronize automatically</strong></td><td>Check this option to automatically synchronize between NetBox and Remote Desktop Manager.</td></tr></tbody></table>

### General

<table><thead><tr><th width="250">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>URL</strong></td><td>Enter the URL of your NetBox domain. Required.</td></tr><tr><td><strong>Token id</strong></td><td>Enter your NetBox token ID. Required. When the token is a NetBox v1 API token, a warning indicates that v1 tokens are deprecated and that a v2 token should be created in NetBox and used instead.</td></tr><tr><td><strong>Template</strong></td><td>Choose a template for the sessions entries that will be synchronized.</td></tr><tr><td><strong>Destination folder</strong></td><td>Set a destination folder for the synchronized entries.</td></tr><tr><td><strong>Only synchronize devices containing a management IP</strong></td><td>Omit devices without a management IP in NetBox from the synchronization task.</td></tr><tr><td><strong>Include virtual machines</strong></td><td>Include the NetBox virtual machines in the synchronization.</td></tr></tbody></table>

### Fields

<table><thead><tr><th width="230">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Fields list</strong></td><td><p>Check which fields will always be synchronized, and which will not. Use the <em><strong>Search</strong></em> box above the list to filter it by name. The available fields are:</p><ul><li><strong>Session name</strong></li><li><strong>Hostname</strong></li><li><strong>Description</strong></li><li><strong>Tags</strong></li><li><strong>Manufacturer</strong></li><li><strong>Serial number</strong></li><li><strong>Region</strong></li><li><strong>Site</strong></li><li><strong>Room</strong></li><li><strong>Rack</strong></li><li><strong>Asset Tag</strong></li><li><strong>Role</strong></li><li><strong>Device type</strong></li></ul></td></tr><tr><td><strong>Filter value</strong></td><td>A value used to filter the synchronized items on that field. The filter expects values in slug format. Available next to the <em><strong>Session name</strong></em>, <em><strong>Role</strong></em>, <em><strong>Tags</strong></em>, <em><strong>Site</strong></em>, <em><strong>Region</strong></em>, <em><strong>Rack</strong></em>, <em><strong>Manufacturer</strong></em>, and <em><strong>Device type</strong></em> fields.</td></tr><tr><td><strong>Session name prefix</strong></td><td>Add a prefix for the entry that will be created through the synchronizer. Shown when <em><strong>Session name</strong></em> is selected in the list.</td></tr><tr><td><strong>Session name suffix</strong></td><td>Add a suffix for the entry that will be created through the synchronizer. Shown when <em><strong>Session name</strong></em> is selected in the list.</td></tr><tr><td><strong>Host type</strong></td><td><p>Choose which value is used for the host of the synchronized entries. Shown when <em><strong>Hostname</strong></em> is selected in the list:</p><ul><li><strong>Default</strong></li><li><strong>IPv4</strong></li><li><strong>IPv6</strong></li></ul></td></tr></tbody></table>

### Schedule

<table><thead><tr><th width="230">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Enabled</strong></td><td>Run the synchronizer on a schedule.</td></tr><tr><td><strong>Every</strong></td><td><p>Enter the interval between two runs (minimum 1), then choose its unit:</p><ul><li><strong>Days</strong></li><li><strong>Hours</strong></li></ul></td></tr><tr><td><strong>At</strong></td><td>The time of day at which the synchronizer runs. Shown when the interval unit is <em><strong>Days</strong></em>.</td></tr></tbody></table>

### Advanced

<table><thead><tr><th width="230">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Silent mode</strong></td><td>This option disables error dialogs (useful when the synchronizer runs automatically at set intervals).</td></tr><tr><td><strong>Duplicate check</strong></td><td><p>Duplicate checks prevent the importation of entries with the same type and host. Choose between:</p><ul><li><strong>Root</strong>: Check for duplicates within the whole workspace.</li><li><strong>Destination folder</strong>: Check for duplicates only within the Remote Desktop Manager destination folder or subfolder.</li></ul></td></tr><tr><td><strong>Action on entry mismatch</strong></td><td><p>Choose between:</p><ul><li><strong>None</strong>: Do nothing.</li><li><strong>Delete</strong>: Delete that entry.</li><li><strong>Move to</strong>: Move to the selected <em><strong>Destination folder</strong></em>.</li><li><strong>Make expired</strong>: Mark that entry as expired (expiration message can be set up).</li></ul></td></tr><tr><td><strong>Destination folder</strong></td><td>The folder where mismatched entries are moved. Shown when <em><strong>Action on entry mismatch</strong></em> is <em><strong>Move to</strong></em>.</td></tr><tr><td><strong>Expiration message</strong></td><td>The message set on mismatched entries when they are marked as expired. Shown when <em><strong>Action on entry mismatch</strong></em> is <em><strong>Make expired</strong></em>.</td></tr></tbody></table>

### See also

* [Synchronizers](/rdm/concepts/advanced-concepts/synchronizers.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/netbox-synchronizer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
