Skip to content

Operational Compliance API Package

nautobot_operational_compliance.api

REST API module for the nautobot_operational_compliance app.

serializers

serializer.

CommandOutputSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
49
50
51
52
53
54
55
56
57
58
class CommandOutputSerializer(NautobotModelSerializer):
    """Serializer for API."""

    device_name = serializers.CharField(source="device.name")

    class Meta:
        """Meta class for ValidationResult Serializer."""

        model = models.CommandOutput
        fields = "__all__"
Meta

Meta class for ValidationResult Serializer.

Source code in nautobot_operational_compliance/api/serializers.py 
54
55
56
57
58
class Meta:
    """Meta class for ValidationResult Serializer."""

    model = models.CommandOutput
    fields = "__all__"

CommandParserSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
29
30
31
32
33
34
35
36
class CommandParserSerializer(NautobotModelSerializer):
    """Serializer for API."""

    class Meta:
        """Meta class for CommandParser Serializer."""

        model = models.CommandParser
        fields = "__all__"
Meta

Meta class for CommandParser Serializer.

Source code in nautobot_operational_compliance/api/serializers.py 
32
33
34
35
36
class Meta:
    """Meta class for CommandParser Serializer."""

    model = models.CommandParser
    fields = "__all__"

OperationalComplianceSettingSerializer

Bases: NautobotModelSerializer

Serializer for OperationalComplianceSetting API.

Source code in nautobot_operational_compliance/api/serializers.py 
74
75
76
77
78
79
80
81
class OperationalComplianceSettingSerializer(NautobotModelSerializer):
    """Serializer for OperationalComplianceSetting API."""

    class Meta:
        """Meta class for OperationalComplianceSetting Serializer."""

        model = models.OperationalComplianceSetting
        fields = "__all__"
Meta

Meta class for OperationalComplianceSetting Serializer.

Source code in nautobot_operational_compliance/api/serializers.py 
77
78
79
80
81
class Meta:
    """Meta class for OperationalComplianceSetting Serializer."""

    model = models.OperationalComplianceSetting
    fields = "__all__"

SnapshotSerializer

Bases: NautobotModelSerializer

Serializer for Snapshot API.

Source code in nautobot_operational_compliance/api/serializers.py 
39
40
41
42
43
44
45
46
class SnapshotSerializer(NautobotModelSerializer):
    """Serializer for Snapshot API."""

    class Meta:
        """Meta class for SnapshotSerializer."""

        model = models.Snapshot
        fields = "__all__"
Meta

Meta class for SnapshotSerializer.

Source code in nautobot_operational_compliance/api/serializers.py 
42
43
44
45
46
class Meta:
    """Meta class for SnapshotSerializer."""

    model = models.Snapshot
    fields = "__all__"

ValidationResultSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
61
62
63
64
65
66
67
68
69
70
71
class ValidationResultSerializer(NautobotModelSerializer):
    """Serializer for API."""

    device = serializers.CharField(source="device.name")
    validation_rule = serializers.CharField(source="validation_rule.name")

    class Meta:
        """Meta class for ValidationResult Serializer."""

        model = models.ValidationResult
        fields = "__all__"
Meta

Meta class for ValidationResult Serializer.

Source code in nautobot_operational_compliance/api/serializers.py 
67
68
69
70
71
class Meta:
    """Meta class for ValidationResult Serializer."""

    model = models.ValidationResult
    fields = "__all__"

ValidationRuleGroupSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
19
20
21
22
23
24
25
26
class ValidationRuleGroupSerializer(NautobotModelSerializer):
    """Serializer for API."""

    class Meta:
        """Meta class for ValidationRuleGroupSerializer."""

        model = models.ValidationRuleGroup
        fields = "__all__"
Meta

Meta class for ValidationRuleGroupSerializer.

Source code in nautobot_operational_compliance/api/serializers.py 
22
23
24
25
26
class Meta:
    """Meta class for ValidationRuleGroupSerializer."""

    model = models.ValidationRuleGroup
    fields = "__all__"

ValidationRuleSerializer

Bases: NautobotModelSerializer

Serializer for API.

Source code in nautobot_operational_compliance/api/serializers.py 
 9
10
11
12
13
14
15
16
class ValidationRuleSerializer(NautobotModelSerializer):
    """Serializer for API."""

    class Meta:
        """Meta class for ValidationRuleSerializer."""

        model = models.ValidationRule
        fields = "__all__"
Meta

Meta class for ValidationRuleSerializer.

Source code in nautobot_operational_compliance/api/serializers.py 
12
13
14
15
16
class Meta:
    """Meta class for ValidationRuleSerializer."""

    model = models.ValidationRule
    fields = "__all__"

urls

API URLs.

views

API Views.

CommandOutputViewSet

Bases: NautobotModelViewSet

API view for CommandOutput operations (read/delete only).

Source code in nautobot_operational_compliance/api/views.py 
43
44
45
46
47
48
49
class CommandOutputViewSet(NautobotModelViewSet):
    """API view for CommandOutput operations (read/delete only)."""

    filterset_class = filters.CommandOutputFilterSet
    queryset = CommandOutput.objects.all()
    serializer_class = CommandOutputSerializer
    http_method_names = ["get", "delete", "head", "options"]

CommandParserViewSet

Bases: NautobotModelViewSet

API view for CRUD for Command parser operations.

Source code in nautobot_operational_compliance/api/views.py 
61
62
63
64
65
66
class CommandParserViewSet(NautobotModelViewSet):
    """API view for CRUD for Command parser operations."""

    filterset_class = filters.CommandParserFilterSet
    queryset = CommandParser.objects.all()
    serializer_class = CommandParserSerializer

OperationalComplianceSettingAPIView

Bases: NautobotModelViewSet

API view for CRUD OperationalComplianceSetting operations.

Source code in nautobot_operational_compliance/api/views.py 
77
78
79
80
81
82
class OperationalComplianceSettingAPIView(NautobotModelViewSet):
    """API view for CRUD OperationalComplianceSetting operations."""

    filterset_class = filters.OperationalComplianceSettingFilterSet
    queryset = OperationalComplianceSetting.objects.all()
    serializer_class = OperationalComplianceSettingSerializer

SnapshotViewSet

Bases: NautobotModelViewSet

API view for Snapshot operations (read/delete only).

Source code in nautobot_operational_compliance/api/views.py 
26
27
28
29
30
31
32
class SnapshotViewSet(NautobotModelViewSet):
    """API view for Snapshot operations (read/delete only)."""

    filterset_class = filters.SnapshotFilterSet
    queryset = Snapshot.objects.all()
    serializer_class = SnapshotSerializer
    http_method_names = ["get", "delete", "head", "options"]

ValidationResultViewSet

Bases: NautobotModelViewSet

API view for ValidationResult operations (read/delete only).

Source code in nautobot_operational_compliance/api/views.py 
52
53
54
55
56
57
58
class ValidationResultViewSet(NautobotModelViewSet):
    """API view for ValidationResult operations (read/delete only)."""

    filterset_class = filters.ValidationResultFilterSet
    queryset = ValidationResult.objects.all()
    serializer_class = ValidationResultSerializer
    http_method_names = ["get", "delete", "head", "options"]

ValidationRuleGroupViewSet

Bases: NautobotModelViewSet

API view for CRUD for Validation Rule Group operations.

Source code in nautobot_operational_compliance/api/views.py 
69
70
71
72
73
74
class ValidationRuleGroupViewSet(NautobotModelViewSet):
    """API view for CRUD for Validation Rule Group operations."""

    filterset_class = filters.ValidationRuleGroupFilterSet
    queryset = ValidationRuleGroup.objects.all()
    serializer_class = ValidationRuleGroupSerializer

ValidationRuleViewSet

Bases: NautobotModelViewSet

API view for CRUD ValidationRule operations.

Source code in nautobot_operational_compliance/api/views.py 
35
36
37
38
39
40
class ValidationRuleViewSet(NautobotModelViewSet):
    """API view for CRUD ValidationRule operations."""

    filterset_class = filters.ValidationRuleFilterSet
    queryset = ValidationRule.objects.all()
    serializer_class = ValidationRuleSerializer