Skip to content

Device Lifecycle Management API Package

nautobot_device_lifecycle_mgmt.api

REST API module for nautobot_device_lifecycle_mgmt app.

serializers

API serializers for nautobot_device_lifecycle_mgmt.

CVELCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

CVELCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class CVELCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """CVELCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.CVELCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.CVELCM
    fields = "__all__"

ContactLCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

ContactLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class ContactLCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """ContactLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.ContactLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.ContactLCM
    fields = "__all__"

ContractLCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

ContractLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class ContractLCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """ContractLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.ContractLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.ContractLCM
    fields = "__all__"

DeviceHardwareNoticeResultSerializer

Bases: NautobotModelSerializer

REST API serializer for DeviceHardwareNoticeResult records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class DeviceHardwareNoticeResultSerializer(NautobotModelSerializer):
    """REST API serializer for DeviceHardwareNoticeResult records."""

    class Meta:
        """Meta attributes."""

        model = models.DeviceHardwareNoticeResult
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.DeviceHardwareNoticeResult
    fields = "__all__"

DeviceSoftwareValidationResultSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

DeviceSoftwareValidationResult Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class DeviceSoftwareValidationResultSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """DeviceSoftwareValidationResult Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.DeviceSoftwareValidationResult
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.DeviceSoftwareValidationResult
    fields = "__all__"

HardwareLCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

HardwareLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class HardwareLCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """HardwareLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.HardwareLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.HardwareLCM
    fields = "__all__"

InventoryItemSoftwareValidationResultSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

InventoryItemSoftwareValidationResult Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class InventoryItemSoftwareValidationResultSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """InventoryItemSoftwareValidationResult Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.InventoryItemSoftwareValidationResult
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.InventoryItemSoftwareValidationResult
    fields = "__all__"

ProviderLCMSerializer

Bases: NautobotModelSerializer

ProviderLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class ProviderLCMSerializer(NautobotModelSerializer):  # pylint: disable=too-many-ancestors
    """ProviderLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.ProviderLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.ProviderLCM
    fields = "__all__"

SoftwareImageLCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

SoftwareImageLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class SoftwareImageLCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """SoftwareImageLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.SoftwareImageLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.SoftwareImageLCM
    fields = "__all__"

SoftwareLCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

SoftwareLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class SoftwareLCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """SoftwareLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.SoftwareLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.SoftwareLCM
    fields = "__all__"

ValidatedSoftwareLCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

ValidatedSoftwareLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class ValidatedSoftwareLCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """ValidatedSoftwareLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.ValidatedSoftwareLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.ValidatedSoftwareLCM
    fields = "__all__"

VulnerabilityLCMSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

VulnerabilityLCM Serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class VulnerabilityLCMSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """VulnerabilityLCM Serializer."""

    class Meta:
        """Meta attributes."""

        model = models.VulnerabilityLCM
        fields = "__all__"
        read_only_fields = [
            "id",
            "display",
            "url",
            "cve",
            "software",
            "device",
            "inventory_item",
        ]
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py
class Meta:
    """Meta attributes."""

    model = models.VulnerabilityLCM
    fields = "__all__"
    read_only_fields = [
        "id",
        "display",
        "url",
        "cve",
        "software",
        "device",
        "inventory_item",
    ]

urls

Django API urlpatterns declaration for nautobot_device_lifecycle_mgmt app.

views

API views for nautobot_device_lifecycle_mgmt.

CVELCMViewSet

Bases: NautobotModelViewSet

REST API viewset for CVELCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class CVELCMViewSet(NautobotModelViewSet):
    """REST API viewset for CVELCM records."""

    queryset = models.CVELCM.objects.all()
    serializer_class = serializers.CVELCMSerializer
    filterset_class = filters.CVELCMFilterSet

ContactLCMView

Bases: NautobotModelViewSet

CRUD operations set for the Contact Lifecycle Management view.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class ContactLCMView(NautobotModelViewSet):
    """CRUD operations set for the Contact Lifecycle Management view."""

    queryset = models.ContactLCM.objects.all()
    filterset_class = filters.ContactLCMFilterSet
    serializer_class = serializers.ContactLCMSerializer

ContractLCMView

Bases: NautobotModelViewSet

CRUD operations set for the Contract Lifecycle Management view.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class ContractLCMView(NautobotModelViewSet):
    """CRUD operations set for the Contract Lifecycle Management view."""

    queryset = models.ContractLCM.objects.all()
    filterset_class = filters.ContractLCMFilterSet
    serializer_class = serializers.ContractLCMSerializer

DeviceHardwareNoticeResultListViewSet

Bases: NautobotModelViewSet

REST API viewset for DeviceHardwareNoticeResult records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class DeviceHardwareNoticeResultListViewSet(NautobotModelViewSet):
    """REST API viewset for DeviceHardwareNoticeResult records."""

    queryset = models.DeviceHardwareNoticeResult.objects.all()
    serializer_class = serializers.DeviceHardwareNoticeResultSerializer
    filterset_class = filters.DeviceHardwareNoticeResultFilterSet

    # Disabling POST as these should only be created via Job.
    http_method_names = ["get", "head", "options"]

DeviceSoftwareValidationResultListViewSet

Bases: NautobotModelViewSet

REST API viewset for DeviceSoftwareValidationResult records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class DeviceSoftwareValidationResultListViewSet(NautobotModelViewSet):
    """REST API viewset for DeviceSoftwareValidationResult records."""

    queryset = models.DeviceSoftwareValidationResult.objects.all()
    serializer_class = serializers.DeviceSoftwareValidationResultSerializer
    filterset_class = filters.DeviceSoftwareValidationResultFilterSet

    # Disabling POST as these should only be created via Job.
    http_method_names = ["get", "head", "options"]

HardwareLCMView

Bases: NautobotModelViewSet

CRUD operations set for the Hardware Lifecycle Management view.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class HardwareLCMView(NautobotModelViewSet):
    """CRUD operations set for the Hardware Lifecycle Management view."""

    queryset = models.HardwareLCM.objects.all()
    filterset_class = filters.HardwareLCMFilterSet
    serializer_class = serializers.HardwareLCMSerializer

InventoryItemSoftwareValidationResultListViewSet

Bases: NautobotModelViewSet

REST API viewset for DeviceSoftwareValidationResult records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class InventoryItemSoftwareValidationResultListViewSet(NautobotModelViewSet):
    """REST API viewset for DeviceSoftwareValidationResult records."""

    queryset = models.InventoryItemSoftwareValidationResult.objects.all()
    serializer_class = serializers.InventoryItemSoftwareValidationResultSerializer
    filterset_class = filters.InventoryItemSoftwareValidationResultFilterSet

    # Disabling POST as these should only be created via Job.
    http_method_names = ["get", "head", "options"]

ProviderLCMView

Bases: NautobotModelViewSet

CRUD operations set for the Contract Provider Lifecycle Management view.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class ProviderLCMView(NautobotModelViewSet):
    """CRUD operations set for the Contract Provider Lifecycle Management view."""

    queryset = models.ProviderLCM.objects.all()
    filterset_class = filters.ProviderLCMFilterSet
    serializer_class = serializers.ProviderLCMSerializer

SoftwareImageLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for SoftwareImageLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class SoftwareImageLCMViewSet(NautobotModelViewSet):
    """REST API viewset for SoftwareImageLCM records."""

    queryset = models.SoftwareImageLCM.objects.prefetch_related("software")
    serializer_class = serializers.SoftwareImageLCMSerializer
    filterset_class = filters.SoftwareImageLCMFilterSet

SoftwareLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for SoftwareLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class SoftwareLCMViewSet(NautobotModelViewSet):
    """REST API viewset for SoftwareLCM records."""

    queryset = models.SoftwareLCM.objects.prefetch_related("software_images")
    serializer_class = serializers.SoftwareLCMSerializer
    filterset_class = filters.SoftwareLCMFilterSet

ValidatedSoftwareLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for ValidatedSoftwareLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class ValidatedSoftwareLCMViewSet(NautobotModelViewSet):
    """REST API viewset for ValidatedSoftwareLCM records."""

    queryset = models.ValidatedSoftwareLCM.objects.all()
    serializer_class = serializers.ValidatedSoftwareLCMSerializer
    filterset_class = filters.ValidatedSoftwareLCMFilterSet

VulnerabilityLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for VulnerabilityLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py
class VulnerabilityLCMViewSet(NautobotModelViewSet):
    """REST API viewset for VulnerabilityLCM records."""

    queryset = models.VulnerabilityLCM.objects.all()
    serializer_class = serializers.VulnerabilityLCMSerializer
    filterset_class = filters.VulnerabilityLCMFilterSet

    # Disabling POST as these should only be created via Job.
    http_method_names = ["get", "put", "patch", "delete", "head", "options"]