Full Ingested Entity Details

Oct 13, 2025 by thesweetdesigns.com 17 views

Introduction

Ingesting virtual machines (VMs) into a NetBox environment is a crucial task for many organizations. However, when this process fails, it can lead to significant downtime and data loss. In this article, we will delve into the issue of virtual machine ingestion failing and explore the possible causes and solutions.

Background

The issue at hand involves the Diode SDK Python version v0.4.2, Diode version v0.6.0, Diode NetBox Plugin version v0.6.0, and NetBox version 4.2.2. The problem arises when trying to ingest a virtual machine using the code provided in the examples on the Diode SDK Python repository.

Expected Behavior

The expected behavior is that the VM should be imported with the correct sites created. However, the observed behavior is that the VM is provisioned with an "undefined" site and no cluster is created.

Observed Behavior

The error message from the Diode -> Ingestion logs is as follows:

{
    "message": "failed to apply change set",
    "code": 400,
    "details": {
        "changeSetId": "26d66602-7c89-40a3-9f4c-8534cd425d78",
        "result": "failed",
        "errors": [
            {
                "error": "cluster: Cannot resolve keyword 'site' into field. Choices are: _location, _location_id, _region, _region_id, _site, _site_group, _site_group_id, _site_id, bookmarks, comments, contacts, created, custom_field_data, description, devices, group, group_id, id, journal_entries, last_updated, name, scope, scope_id, scope_type, scope_type_id, status, subscriptions, tagged_items, tags, tenant, tenant_id, type, type_id, virtual_machines, vlan_groups",
                "changeId": "d675a5cb-18a4-4dd3-a456-08b7e3c66583"
            }
        ]
    }
}

This error message indicates that there is a problem with the change set, specifically with the cluster object.

Full Ingested Entity Details

The full ingested entity details are as follows:

{
    "virtualMachine": {
        "name": "VM A",
        "status": "active",
        "site": {
            "name": "Site ABC",
            "status": "active",
            "facility": "Data Center 1",
            "timeZone": "UTC",
            "description": "Site A description",
            "comments": "Lorem ipsum dolor sit amet",
            "tags": [
                {
                    "name": "tag 1"
                },
                {
                    "name": "tag 2"
                }
            ]
        },
        "cluster": {
            "name": "Cluster A",
            "type": {
                "name": "Cluster Type A",
                "description": "Cluster Type description",
                "tags": [
                    {
                        "name": "tag 1"
                    },
                    {
                        "name": "tag 2"
                    }
                ]
            },
            "group": {
                "name": "Cluster Group",
                "description": "Cluster Group description",
                "tags": [
                    {
                        "name": "tag 1"
                    },
                    {
                        "name": "tag 2"
                    }
                ]
            },
            "site": {
                "name": "Site ABC",
                "status": "active",
                "facility": "Data Center 1",
                "timeZone": "UTC",
                "description": "Site A description",
                "comments": "Lorem ipsum dolor sit amet",
                "tags": [
                    {
                        "name": "tag 1"
                    },
                    {
                        "name": "tag 2"
                    }
                ]
            },
            "description": "Cluster A description",
            "tags": [
                {
                    "name": "tag 1"
                },
                {
                    "name": "tag 2"
                }
            ]
        },
        "role": {
            "name": "Role ABC",
            "tags": [
                {
                    "name": "tag 1"
                },
                {
                    "name": "tag 3"
                }
            ]
        },
        "device": {
            "name": "Device A",
            "deviceType": {
                "model": "Device Type A",
                "manufacturer": {
                    "name": "Manufacturer A"
                }
            },
            "role": {
                "name": "Role ABC",
                "tags": [
                    {
                        "name": "tag 1"
                    },
                    {
                        "name": "tag 3"
                    }
                ]
            },
            "platform": {
                "name": "Platform A",
                "manufacturer": {
                    "name": "Manufacturer A"
                }
            },
            "serial": "123456",
            "site": {
                "name": "Site ABC"
            },
            "assetTag": "123456",
            "status": "active",
            "comments": "Lorem ipsum dolor sit amet",
            "tags": [
                {
                    "name": "tag 1"
                },
                {
                    "name": "tag 2"
                }
            ]
        },
        "platform": {
            "name": "Platform A",
            "manufacturer": {
                "name": "Manufacturer A"
            }
        },
        "vcpus": 8,
        "memory": 12128,
        "disk": 16786,
        "description": "Virtual Machine A description",
        "comments": "Lorem ipsum dolor sit amet",
        "tags": [
            {
                "name": "tag 1"
            },
            {
                "name": "tag 2"
            }
        ]
    }
}

This ingested entity details show that the site and cluster objects are not being created correctly.

Change Set Details

The change set details are as follows:

{
    "change_set_id": "26d66602-7c89-40a3-9f4c-8534cd425d78",
    "change_set": [
        {
            "change_id": "8222006d-be9f-47fa-84d8-5079402e2964",
            "change_type": "create",
            "object_type": "extras.tag",
            "data": {
                "name": "tag 1",
                "slug": "tag-1"
            }
        },
        {
            "change_id": "c723910b-71ac-4e68-80e0-cef94679d176",
            "change_type": "create",
            "object_type": "extras.tag",
            "data": {
                "name": "tag 2",
                "slug": "tag-2"
            }
        },
        {
            "change_id": "ee9092f9-282f-4f9d-9d04-24954a0d14f5",
            "change_type": "create",
            "object_type": "dcim.site",
            "data": {
                "name": "Site ABC",
                "slug": "site-abc",
                "status": "active",
                "facility": "Data Center 1",
                "time_zone": "UTC",
                "description": "Site A description",
                "comments": "Lorem ipsum dolor sit amet",
                "tags": [
                    {
                        "name": "tag 1",
                        "slug": "tag-1"
                    },
                    {
                        "name": "tag 2",
                        "slug": "tag-2"
                    }
                ]
            }
        },
        {
            "change_id": "7d8e7f2c-7899-47ed-b914-212964608b3a",
            "change_type": "create",
            "object_type": "virtualization.clustertype",
            "data": {
                "name": "Cluster Type A",
                "slug": "cluster-type-a",
                "description": "Cluster Type description",
                "tags": [
                    {
                        "name": "tag 1",
                        "slug": "tag-1"
                    },
                    {
                        "name": "tag 2",
                        "slug": "tag-2"
                    }
                ]
            }
        },
        {
            "change_id": "09d3a559-6931-458a-b611-308c66ef82d7",
            "change_type": "create",
            "object_type": "virtualization.clustergroup",
            "data": {
                "name": "Cluster Group",
                "slug": "cluster-group",
                "description": "Cluster Group description",
                "tags": [
                    {
                        "name": "tag 1",
                        "slug": "tag-1"
                    },
                    {
                        "name": "tag 2",
                        "slug": "tag-2"
                    }
                ]
            }
        },
        {
            "change_id": "5cdb4d5f-dfbd-4443-8f8d-67ccb9d2c41f",
            "change_type": "create",
            "object_type": "virtualization.cluster",
            "data": {
                "name": "Cluster A",
                "type": {
                    "name": "Cluster Type A",
                    "slug": "cluster-type-a",
                    "description": "Cluster Type description"
                },
                "group": {
                    "name": "Cluster Group",
                   <br/>
**Virtual Machine Ingestion Fails: A Q&A Article**
=====================================================

**Q: What is the expected behavior when ingesting a virtual machine into NetBox?**
--------------------------------------------------------------------------------

A: The expected behavior is that the VM should be imported with the correct sites created.

**Q: What is the observed behavior when ingesting a virtual machine into NetBox?**
--------------------------------------------------------------------------------

A: The observed behavior is that the VM is provisioned with an "undefined" site and no cluster is created.

**Q: What is the error message from the Diode -> Ingestion logs?**
----------------------------------------------------------------

A: The error message from the Diode -> Ingestion logs is as follows:
```json
{
    "message": "failed to apply change set",
    "code": 400,
    "details": {
        "changeSetId": "26d66602-7c89-40a3-9f4c-8534cd425d78",
        "result": "failed",
        "errors": [
            {
                "error": "cluster: Cannot resolve keyword 'site' into field. Choices are: _location, _location_id, _region, _region_id, _site, _site_group, _site_group_id, _site_id, bookmarks, comments, contacts, created, custom_field_data, description, devices, group, group_id, id, journal_entries, last_updated, name, scope, scope_id, scope_type, scope_type_id, status, subscriptions, tagged_items, tags, tenant, tenant_id, type, type_id, virtual_machines, vlan_groups",
                "changeId": "d675a5cb-18a4-4dd3-a456-08b7e3c66583"
            }
        ]
    }
}

Q: What are the possible causes of the issue?

A: The possible causes of the issue are:

Incorrect configuration: The Diode SDK Python version, Diode version, Diode NetBox Plugin version, and NetBox version may not be compatible with each other.
Missing or incorrect data: The ingested entity details may be missing or incorrect, which can cause the change set to fail.
NetBox database issues: There may be issues with the NetBox database, such as corrupted data or incorrect schema.

Q: How can I troubleshoot the issue?

A: To troubleshoot the issue, you can:

Check the Diode SDK Python version, Diode version, Diode NetBox Plugin version, and NetBox version: Ensure that all versions are compatible with each other.
Verify the ingested entity details: Check that the ingested entity details are complete and correct.
Check the NetBox database: Verify that the NetBox database is correct and not corrupted.

Q: How can I resolve the issue?

A: To resolve the issue, you can:

Update the Diode SDK Python version, Diode version, Diode NetBox Plugin version, and NetBox version: Ensure that all versions are compatible with each other.
Correct the ingested entity details: Ensure that the ingested entity details are complete and correct.
Fix the NetBox database issues: Correct any issues with the NetBox database.

Q: What are the best practices for ingesting virtual machines into NetBox?

A: The best practices for ingesting virtual machines into NetBox are:

Use the correct Diode SDK Python version, Diode version, Diode NetBox Plugin version, and NetBox version: Ensure that all versions are compatible with each other.
Verify the ingested entity details: Check that the ingested entity details are complete and correct.
Regularly back up the NetBox database: Ensure that the NetBox database is correct and not corrupted.

By following these best practices and troubleshooting the issue, you can resolve the problem of virtual machine ingestion failing in NetBox.