"parent_device" property seems to be unseen by server at REST HTTP POST #11713

ViktorTelecom · 2023-02-09T12:13:13Z

ViktorTelecom
Feb 9, 2023

Dear community,

I have problems with uploading DCIM configuration when I need to populate my already uploaded parent chassis device with child devices. My HTTP POST message is the following. I collected it with TCP Dump.

HTTP: POST /api/dcim/devices/ HTTP/1.1
Authorization: Token gd7jjgsdaqdhfghdl8ydshdjhsdhs
Transfer-Encoding: chunked
traceparent: 00-cb642d0a00e80a058297c09f105ede82-1078be4dbf8e0b6b-00
Content-Type: application/json; charset=utf-8


{
  "name": "TestCard (1)",
  "device_type": {
    "model": "TestCard"
  },
  "device_role": {
    "name": "Linear Card"
  },
  "site": {
    "slug": "main-site"
  },
  "rack": {
    "name": "room 206, place 04",
    "site": {
      "slug": "main-site"
    }
  },
  "position": null,
  "face": null,
  "status": "planned",
  "comments": "",
  "parent_device": {
    "id": 254,
    "name": "QPL-WEM-1",
    "device_bay": {
      "name": "Bay-1",
      "device": {
        "id": 254
      }
    }
  }
}

The following is the server reply. Also captured with tcpdump.

`HTTP/1.1 201 Created
Server: nginx/1.18.0 (Ubuntu)
Date: Thu, 09 Feb 2023 11:39:15 GMT
Content-Type: application/json
Content-Length: 1636
Connection: keep-alive
Location: http://netbox.example.com/api/dcim/devices/258/
Vary: Accept, Cookie, Origin
Allow: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
API-Version: 3.2
X-Content-Type-Options: nosniff
Referrer-Policy: same-origin
Cross-Origin-Opener-Policy: same-origin
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains

{
  "id": 258,
  "url": "http://netbox.example.com/api/dcim/devices/258/",
  "display": "TestCard  (1)",
  "name": "TestCard  (1)",
  "device_type": {
    "id": 19,
    "url": "http://netbox.example.com/api/dcim/device-types/19/",
    "display": "TestCard",
    "manufacturer": {
      "id": 6,
      "url": "http://netbox.example.com/api/dcim/manufacturers/6/",
      "display": "TestVendor",
      "name": "TestVendor",
      "slug": "testvendor"
    },
    "model": "TestCard",
    "slug": "testcard"
  },
  "device_role": {
    "id": 16,
    "url": "http://netbox.example.com/api/dcim/device-roles/16/",
    "display": "Linear Card",
    "name": "Linear Card",
    "slug": "linear-card"
  },
  "tenant": null,
  "platform": null,
  "serial": "",
  "asset_tag": null,
  "site": {
    "id": 81,
    "url": "http://netbox.example.com/api/dcim/sites/81/",
    "display": "Main Site",
    "name": "Main Site",
    "slug": "main-site"
  },
  "location": null,
  "rack": {
    "id": 154,
    "url": "http://netbox.example.com/api/dcim/racks/154/",
    "display": "room 206, place 04",
    "name": "room 206, place 04"
  },
  "position": null,
  "face": null,
  "parent_device": null,
  "status": {
    "value": "planned",
    "label": "Planned"
  },
  "airflow": null,
  "primary_ip": null,
  "primary_ip4": null,
  "primary_ip6": null,
  "cluster": null,
  "virtual_chassis": null,
  "vc_position": null,
  "vc_priority": null,
  "comments": "",
  "local_context_data": null,
  "tags": [],
  "custom_fields": {},
  "config_context": {},
  "created": "2023-02-09T11:39:15.551540Z",
  "last_updated": "2023-02-09T11:39:15.551551Z"
}

We see that almost all introduced properties had been successfully accepted and processed. Only property "parent_device" was somehow ignored. I tried to send data of any type under "parent_device" but there was no reaction from the server. Even no error message. As if this property does not exist at all on server.

In web console I can see the created module on the correct site and in the correct rack so it it can be manually installed to the parent device "device-bay". But this does not go right with API.

What do I do wrong? It seems to be an obvious scenario.

When I use modules instead I successfully install modules in module-bays of parent device. But modules do not allow the same port name on different modules on one device. So I use child devices.

Answered by jsenecal

Feb 9, 2023

Thats because parent_device is a nested serializer:

netbox/netbox/dcim/api/serializers.py

Lines 663 to 672 in 19da92b

     @swagger_serializer_method(serializer_or_field=NestedDeviceSerializer)  
   def get_parent_device(self, obj):  
   try:  
   device_bay = obj.parent_bay  
   except DeviceBay.DoesNotExist:  
   return None  
   context = {'request': self.context['request']}  
   data = NestedDeviceSerializer(instance=device_bay.device, context=context).data  
   data['device_bay'] = NestedDeviceBaySerializer(instance=device_bay, context=context).data  
   return data  

 

I don't think it was ever intended to get written to however.

You need to find the device_bay id and then …

View full answer

jsenecal · 2023-02-09T21:10:01Z

jsenecal
Feb 9, 2023

Thats because parent_device is a nested serializer:

netbox/netbox/dcim/api/serializers.py

Lines 663 to 672 in 19da92b

    
           @swagger_serializer_method(serializer_or_field=NestedDeviceSerializer) 
        
           def get_parent_device(self, obj): 
        
               try: 
        
                   device_bay = obj.parent_bay 
        
               except DeviceBay.DoesNotExist: 
        
                   return None 
        
               context = {'request': self.context['request']} 
        
               data = NestedDeviceSerializer(instance=device_bay.device, context=context).data 
        
               data['device_bay'] = NestedDeviceBaySerializer(instance=device_bay, context=context).data 
        
               return data

I don't think it was ever intended to get written to however.

You need to find the device_bay id and then add your newly created device there: put /dcim/device-bays/{id}/ if I'm not mistaken...

2 replies

jsenecal Feb 9, 2023

I think we need to add read_only=True there:

netbox/netbox/dcim/api/serializers.py

Line 649 in 19da92b

parent_device = serializers.SerializerMethodField()

ViktorTelecom Feb 10, 2023
Author

@jsenecal It works! Thank you for assistance.

PUT /api/dcim/device-bays/ HTTP/1.1
............
[
{
  "id": 132,
  "name": "Bay-1",
  "device": 339,
  "installed_device": {
    "id": 340
  }
}
]


HTTP/1.1 200 OK
............

[
  {
    "id": 132,
    "url": "http://netbox.example.com/api/dcim/device-bays/132/",
    "display": "Bay-1",
    "device": {
      "id": 339,
      "url": "http://netbox.example.com/api/dcim/devices/339/",
      "display": "QPL-WEM-1",
      "name": "QPL-WEM-1"
    },
    "name": "Bay-1",
    "label": "",
    "description": "",
    "installed_device": {
      "id": 340,
      "url": "http://netbox.example.com/api/dcim/devices/340/",
      "display": "TestCard (1)",
      "name": "TestCard  (1)"
    },
    "tags": [],
    "custom_fields": {},
    "created": "2023-02-10T09:36:32.792055Z",
    "last_updated": "2023-02-10T09:36:33.228140Z"
  }
]

mtinberg · 2023-02-10T16:18:13Z

mtinberg
Feb 10, 2023

The format used to POST/PUT/PATCH data isn't the same as data is returned, eg foreign key fields are often returned with details like name, id, display, url, etc. but are written as just the id number, eg installedDevice: 1234. or sometimes they are updated on a different data model entirely, eg. IP Address is associated with Interface on the IP Address model not the Interface model, but is available on Interface and Device. Take a look at the Swagger/OpenAPI docs to see what the field names and expected values are for the field you are trying to update. — Mark Tinberg ***@***.***> Division of Information Technology-Network Services University of Wisconsin-Madison

…

________________________________ From: Viktor Patrukhachev ***@***.***> Sent: Friday, February 10, 2023 3:06 AM To: netbox-community/netbox ***@***.***> Cc: Subscribed ***@***.***> Subject: Re: [netbox-community/netbox] "parent_device" property seems to be unseen by server at REST HTTP POST (Discussion #11713) @jsenecal<https://github.com/jsenecal> Thank you for assistance. I tried your recommendation. It passed without errors but still without the required effect. PUT /api/dcim/device-bays/ HTTP/1.1 Host: 192.168.105.5 Authorization: Token b8ef4c32408b225a22f924fb7939634f93c3c6c6 Transfer-Encoding: chunked traceparent: 00-3f3b152d5c173227b9826c5002ff5949-d77b02c06e59a02f-00 Content-Type: application/json; charset=utf-8 [ { "id": 128, "name": "Bay-1", "device": 330, "installedDevice": { "id": 331 } } ] HTTP/1.1 200 OK Server: nginx/1.18.0 (Ubuntu) Date: Fri, 10 Feb 2023 08:54:54 GMT Content-Type: application/json Content-Length: 410 Connection: keep-alive Vary: Accept, Cookie, Origin Allow: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS API-Version: 3.2 X-Content-Type-Options: nosniff Referrer-Policy: same-origin Cross-Origin-Opener-Policy: same-origin X-Frame-Options: SAMEORIGIN Strict-Transport-Security: max-age=31536000; includeSubDomains [ { "id": 128, "url": "http://netbox.example.com/api/dcim/device-bays/128/", "display": "Bay-1", "device": { "id": 330, "url": "http://netbox.example.com/api/dcim/devices/330/", "display": "QPL-WEM-1", "name": "QPL-WEM-1" }, "name": "Bay-1", "label": "", "description": "", "installed_device": null, "tags": [], "custom_fields": {}, "created": "2023-02-10T08:54:53.866019Z", "last_updated": "2023-02-10T08:54:54.189061Z" } ] There is ""installed_device": null" in the reply. Probably "installed_device" is also a read-only property. So we need to search further. — Reply to this email directly, view it on GitHub<#11713 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAS7UM6SGQJ2SK3NJJQDUHLWWYALBANCNFSM6AAAAAAUWPB75U>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

1 reply

ViktorTelecom Feb 11, 2023
Author

Hi, Mark!

I use swagger data but this information was not useful for my task. Because "installed_device" property can be found in several places and swagger does not show which exact object is the true owner of the property while others just reflect it. So I need to try everything or ask the community.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

"parent_device" property seems to be unseen by server at REST HTTP POST #11713

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 2 comments 3 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

	@swagger_serializer_method(serializer_or_field=NestedDeviceSerializer)
	def get_parent_device(self, obj):
	try:
	device_bay = obj.parent_bay
	except DeviceBay.DoesNotExist:
	return None
	context = {'request': self.context['request']}
	data = NestedDeviceSerializer(instance=device_bay.device, context=context).data
	data['device_bay'] = NestedDeviceBaySerializer(instance=device_bay, context=context).data
	return data

"parent_device" property seems to be unseen by server at REST HTTP POST #11713

Uh oh!

Uh oh!

ViktorTelecom Feb 9, 2023

Replies: 2 comments · 3 replies

Uh oh!

jsenecal Feb 9, 2023

Uh oh!

jsenecal Feb 9, 2023

Uh oh!

Uh oh!

ViktorTelecom Feb 10, 2023 Author

Uh oh!

mtinberg Feb 10, 2023

Uh oh!

Uh oh!

ViktorTelecom Feb 11, 2023 Author

ViktorTelecom
Feb 9, 2023

Replies: 2 comments 3 replies

jsenecal
Feb 9, 2023

ViktorTelecom Feb 10, 2023
Author

mtinberg
Feb 10, 2023

ViktorTelecom Feb 11, 2023
Author