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 implementation for the LifeCycle Management app.

CVELCMSerializer

Bases: NautobotModelSerializer

REST API serializer for CVELCM records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
89
90
91
92
93
94
95
96
class CVELCMSerializer(NautobotModelSerializer):  # pylint: disable=abstract-method,too-few-public-methods
    """REST API serializer for CVELCM records."""

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

        model = CVELCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
92
93
94
95
96
class Meta:
    """Meta attributes."""

    model = CVELCM
    fields = "__all__"

ContactLCMSerializer

Bases: NautobotModelSerializer

API serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
49
50
51
52
53
54
55
56
class ContactLCMSerializer(NautobotModelSerializer):  # pylint: disable=R0901,too-few-public-methods
    """API serializer."""

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

        model = ContactLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
52
53
54
55
56
class Meta:
    """Meta attributes."""

    model = ContactLCM
    fields = "__all__"

ContractLCMSerializer

Bases: NautobotModelSerializer

API serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
39
40
41
42
43
44
45
46
class ContractLCMSerializer(NautobotModelSerializer):  # pylint: disable=R0901,too-few-public-methods
    """API serializer."""

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

        model = ContractLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
42
43
44
45
46
class Meta:
    """Meta attributes."""

    model = ContractLCM
    fields = "__all__"

DeviceSoftwareValidationResultSerializer

Bases: NautobotModelSerializer

REST API serializer for DeviceSoftwareValidationResult records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
118
119
120
121
122
123
124
125
class DeviceSoftwareValidationResultSerializer(NautobotModelSerializer):
    """REST API serializer for DeviceSoftwareValidationResult records."""

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

        model = DeviceSoftwareValidationResult
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
121
122
123
124
125
class Meta:
    """Meta attributes."""

    model = DeviceSoftwareValidationResult
    fields = "__all__"

HardwareLCMSerializer

Bases: NautobotModelSerializer

API serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
19
20
21
22
23
24
25
26
class HardwareLCMSerializer(NautobotModelSerializer):  # pylint: disable=R0901,too-few-public-methods
    """API serializer."""

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

        model = HardwareLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
22
23
24
25
26
class Meta:
    """Meta attributes."""

    model = HardwareLCM
    fields = "__all__"

InventoryItemSoftwareValidationResultSerializer

Bases: NautobotModelSerializer

REST API serializer for InventoryItemSoftwareValidationResult records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
128
129
130
131
132
133
134
135
class InventoryItemSoftwareValidationResultSerializer(NautobotModelSerializer):
    """REST API serializer for InventoryItemSoftwareValidationResult records."""

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

        model = InventoryItemSoftwareValidationResult
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
131
132
133
134
135
class Meta:
    """Meta attributes."""

    model = InventoryItemSoftwareValidationResult
    fields = "__all__"

ProviderLCMSerializer

Bases: NautobotModelSerializer

API serializer.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
29
30
31
32
33
34
35
36
class ProviderLCMSerializer(NautobotModelSerializer):  # pylint: disable=R0901,too-few-public-methods
    """API serializer."""

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

        model = ProviderLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
32
33
34
35
36
class Meta:
    """Meta attributes."""

    model = ProviderLCM
    fields = "__all__"

SoftwareImageLCMSerializer

Bases: NautobotModelSerializer

REST API serializer for SoftwareImageLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
69
70
71
72
73
74
75
76
class SoftwareImageLCMSerializer(NautobotModelSerializer):
    """REST API serializer for SoftwareImageLCM records."""

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

        model = SoftwareImageLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
72
73
74
75
76
class Meta:
    """Meta attributes."""

    model = SoftwareImageLCM
    fields = "__all__"

SoftwareLCMSerializer

Bases: NautobotModelSerializer

REST API serializer for SoftwareLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
59
60
61
62
63
64
65
66
class SoftwareLCMSerializer(NautobotModelSerializer):
    """REST API serializer for SoftwareLCM records."""

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

        model = SoftwareLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
62
63
64
65
66
class Meta:
    """Meta attributes."""

    model = SoftwareLCM
    fields = "__all__"

ValidatedSoftwareLCMSerializer

Bases: NautobotModelSerializer

REST API serializer for ValidatedSoftwareLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
79
80
81
82
83
84
85
86
class ValidatedSoftwareLCMSerializer(NautobotModelSerializer):
    """REST API serializer for ValidatedSoftwareLCM records."""

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

        model = ValidatedSoftwareLCM
        fields = "__all__"
Meta

Meta attributes.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
82
83
84
85
86
class Meta:
    """Meta attributes."""

    model = ValidatedSoftwareLCM
    fields = "__all__"

VulnerabilityLCMSerializer

Bases: NautobotModelSerializer

REST API serializer for VulnerabilityLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/serializers.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
class VulnerabilityLCMSerializer(NautobotModelSerializer):  # pylint: disable=abstract-method,too-few-public-methods
    """REST API serializer for VulnerabilityLCM records."""

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

        model = 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 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
class Meta:
    """Meta attributes."""

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

urls

API URLs for the Lifecycle Management app.

views

API Views implementation for the Lifecycle Management app.

CVELCMViewSet

Bases: NautobotModelViewSet

REST API viewset for CVELCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py 
102
103
104
105
106
107
class CVELCMViewSet(NautobotModelViewSet):
    """REST API viewset for CVELCM records."""

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

ContactLCMView

Bases: NautobotModelViewSet

CRUD operations set for the Contact Lifecycle Management view.

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

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

ContractLCMView

Bases: NautobotModelViewSet

CRUD operations set for the Contract Lifecycle Management view.

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

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

DeviceSoftwareValidationResultListViewSet

Bases: NautobotModelViewSet

REST API viewset for DeviceSoftwareValidationResult records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py 
121
122
123
124
125
126
127
128
129
class DeviceSoftwareValidationResultListViewSet(NautobotModelViewSet):
    """REST API viewset for DeviceSoftwareValidationResult records."""

    queryset = DeviceSoftwareValidationResult.objects.all()
    serializer_class = DeviceSoftwareValidationResultSerializer
    filterset_class = 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 
46
47
48
49
50
51
class HardwareLCMView(NautobotModelViewSet):
    """CRUD operations set for the Hardware Lifecycle Management view."""

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

InventoryItemSoftwareValidationResultListViewSet

Bases: NautobotModelViewSet

REST API viewset for DeviceSoftwareValidationResult records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py 
132
133
134
135
136
137
138
139
140
class InventoryItemSoftwareValidationResultListViewSet(NautobotModelViewSet):
    """REST API viewset for DeviceSoftwareValidationResult records."""

    queryset = InventoryItemSoftwareValidationResult.objects.all()
    serializer_class = InventoryItemSoftwareValidationResultSerializer
    filterset_class = 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 
62
63
64
65
66
67
class ProviderLCMView(NautobotModelViewSet):
    """CRUD operations set for the Contract Provider Lifecycle Management view."""

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

SoftwareImageLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for SoftwareImageLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py 
86
87
88
89
90
91
class SoftwareImageLCMViewSet(NautobotModelViewSet):
    """REST API viewset for SoftwareImageLCM records."""

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

SoftwareLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for SoftwareLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py 
78
79
80
81
82
83
class SoftwareLCMViewSet(NautobotModelViewSet):
    """REST API viewset for SoftwareLCM records."""

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

ValidatedSoftwareLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for ValidatedSoftwareLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py 
94
95
96
97
98
99
class ValidatedSoftwareLCMViewSet(NautobotModelViewSet):
    """REST API viewset for ValidatedSoftwareLCM records."""

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

VulnerabilityLCMViewSet

Bases: NautobotModelViewSet

REST API viewset for VulnerabilityLCM records.

Source code in nautobot_device_lifecycle_mgmt/api/views.py 
110
111
112
113
114
115
116
117
118
class VulnerabilityLCMViewSet(NautobotModelViewSet):
    """REST API viewset for VulnerabilityLCM records."""

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

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