From 82c179ca9539cecc6a228e250f84cbc5aecfafb4 Mon Sep 17 00:00:00 2001 From: Pavel Korovin Date: Mon, 18 Sep 2023 23:03:36 +0300 Subject: [PATCH] Add /api/virtualization/virtual-machines/{id}/render-config/ endpoint --- netbox/virtualization/api/views.py | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index 5b9cf4117..d785c0917 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -1,7 +1,12 @@ +from rest_framework.decorators import action +from rest_framework.renderers import JSONRenderer +from rest_framework.response import Response from rest_framework.routers import APIRootView +from rest_framework.status import HTTP_400_BAD_REQUEST from dcim.models import Device -from extras.api.mixins import ConfigContextQuerySetMixin +from extras.api.mixins import ConfigContextQuerySetMixin, ConfigTemplateRenderMixin +from netbox.api.renderers import TextRenderer from netbox.api.viewsets import NetBoxModelViewSet from utilities.utils import count_related from virtualization import filtersets @@ -52,9 +57,9 @@ class ClusterViewSet(NetBoxModelViewSet): # Virtual machines # -class VirtualMachineViewSet(ConfigContextQuerySetMixin, NetBoxModelViewSet): +class VirtualMachineViewSet(ConfigContextQuerySetMixin, ConfigTemplateRenderMixin, NetBoxModelViewSet): queryset = VirtualMachine.objects.prefetch_related( - 'site', 'cluster', 'device', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags' + 'site', 'cluster', 'device', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'config_template', 'tags' ) filterset_class = filtersets.VirtualMachineFilterSet @@ -78,6 +83,23 @@ class VirtualMachineViewSet(ConfigContextQuerySetMixin, NetBoxModelViewSet): return serializers.VirtualMachineWithConfigContextSerializer + @action(detail=True, methods=['post'], url_path='render-config', renderer_classes=[JSONRenderer, TextRenderer]) + def render_config(self, request, pk): + """ + Resolve and render the preferred ConfigTemplate for this Device. + """ + instance = self.get_object() + configtemplate = instance.get_config_template() + if not configtemplate: + return Response({'error': 'No config template found for this virtual machine.'}, status=HTTP_400_BAD_REQUEST) + + # Compile context data + context_data = instance.get_config_context() + context_data.update(request.data) + context_data.update({'virtualmachine': instance}) + + return self.render_configtemplate(request, configtemplate, context_data) + class VMInterfaceViewSet(NetBoxModelViewSet): queryset = VMInterface.objects.prefetch_related(