Structured import of VMs/Devices e.g. with JSON #1235

New Issue

adam · 2025-12-29T16:30:27+01:00

adam commented

2025-12-29 16:30:27 +01:00

Originally created by @candlerb on GitHub (Sep 16, 2017).

Issue type

[X] Feature request
[ ] Bug report
[ ] Documentation

Environment

Python version: 3.5.2
NetBox version: v2.2-beta1

Description

Use case: I want to import VMs. I have an existing table of VMs with their IPv4 and IPv6 addresses.

Using CSV import, this would be a three-step affair:

Import VMs with just their names + cluster
Import interfaces (not yet supported, see #1492 and #822)
Import IP addresses (not yet supported for VMs, see #1500)

Importing Devices requires steps 1 and 3, if the Device Type has been properly configured to create the interfaces.

So I am suggesting some sort of structured import which can create the related items at once, e.g.

{"name":"unifi","platform":"Ubuntu 16.04","interfaces":[
  {"name":"eth0","mac":"54:00:00:28:56:1c","addresses":[
    {"address":"192.0.2.30/24","primary":True},
    {"address":"2001:db8::30/64","primary":True}
  ]}
]}

(If this were done for Device, then any interfaces which had been pre-created from the Device Type would be updated rather than created)

This sort of import could be done via the API. However as far as I can tell, the API doesn't support transactions, so the importer application would have to explicitly track changes and roll them back on error.

Originally created by @candlerb on GitHub (Sep 16, 2017). ### Issue type [X] Feature request  [ ] Bug report  [ ] Documentation  ### Environment * Python version: 3.5.2 * NetBox version: v2.2-beta1 ### Description Use case: I want to import VMs. I have an existing table of VMs with their IPv4 and IPv6 addresses. Using CSV import, this would be a three-step affair: 1. Import VMs with just their names + cluster 2. Import interfaces (not yet supported, see #1492 and #822) 3. Import IP addresses (not yet supported for VMs, see #1500) Importing Devices requires steps 1 and 3, if the Device Type has been properly configured to create the interfaces. So I am suggesting some sort of structured import which can create the related items at once, e.g. ~~~ {"name":"unifi","platform":"Ubuntu 16.04","interfaces":[ {"name":"eth0","mac":"54:00:00:28:56:1c","addresses":[ {"address":"192.0.2.30/24","primary":True}, {"address":"2001:db8::30/64","primary":True} ]} ]} ~~~ (If this were done for Device, then any interfaces which had been pre-created from the Device Type would be updated rather than created) This sort of import could be done via the API. However as far as I can tell, the API doesn't support transactions, so the importer application would have to explicitly track changes and roll them back on error.

adam closed this issue

2025-12-29 16:30:27 +01:00

adam commented

2025-12-29 16:30:27 +01:00

@jeremystretch commented on GitHub (Sep 18, 2017):

The CSV-formatted bulk import functions work with only one type of object at a time and are provided for convenience. Any bulk operations requiring more complex logic will need to be performed via the REST API (or directly via the CLI shell). As with most APIs, you'll need to handle errors on the client side accordingly.

@jeremystretch commented on GitHub (Sep 18, 2017): The CSV-formatted bulk import functions work with only one type of object at a time and are provided for convenience. Any bulk operations requiring more complex logic will need to be performed via the REST API (or directly via the CLI shell). As with most APIs, you'll need to handle errors on the client side accordingly.

adam referenced this issue

2025-12-29 22:20:05 +01:00

[PR #1251] [MERGED] Release v2.0.5 #12183

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#1235