Nautobot Ansible Automation API Package¶

`nautobot_ansible_automation.api` ¶

REST API module for nautobot_ansible_automation app.

`serializers` ¶

API serializers for nautobot_ansible_automation.

`AnsibleControllerJobTemplateSerializer` ¶

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

AnsibleControllerJobTemplate Serializer.

Source code in nautobot_ansible_automation/api/serializers.py

class AnsibleControllerJobTemplateSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """AnsibleControllerJobTemplate Serializer."""

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

        model = models.AnsibleControllerJobTemplate
        fields = "__all__"
        extra_kwargs = {
            "name": {"read_only": True},
            "controller_id": {"read_only": True},
            "controller_organization_id": {"read_only": True},
            "description": {"read_only": True},
            "ansible_controller": {"read_only": True},
            "job_model": {"read_only": True},
        }

`Meta` ¶

Meta attributes.

Source code in nautobot_ansible_automation/api/serializers.py

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

    model = models.AnsibleControllerJobTemplate
    fields = "__all__"
    extra_kwargs = {
        "name": {"read_only": True},
        "controller_id": {"read_only": True},
        "controller_organization_id": {"read_only": True},
        "description": {"read_only": True},
        "ansible_controller": {"read_only": True},
        "job_model": {"read_only": True},
    }

`AnsibleControllerSerializer` ¶

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

AnsibleController Serializer.

Source code in nautobot_ansible_automation/api/serializers.py

class AnsibleControllerSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
    """AnsibleController Serializer."""

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

        model = models.AnsibleController
        fields = "__all__"

`Meta` ¶

Meta attributes.

Source code in nautobot_ansible_automation/api/serializers.py

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

    model = models.AnsibleController
    fields = "__all__"

`urls` ¶

Django API urlpatterns declaration for nautobot_ansible_automation app.

`views` ¶

API views for nautobot_ansible_automation.

`AnsibleControllerJobTemplateViewSet` ¶

Bases: NautobotModelViewSet

AnsibleControllerJobTemplate viewset.

Source code in nautobot_ansible_automation/api/views.py

class AnsibleControllerJobTemplateViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """AnsibleControllerJobTemplate viewset."""

    queryset = models.AnsibleControllerJobTemplate.objects.all()
    serializer_class = serializers.AnsibleControllerJobTemplateSerializer
    filterset_class = filters.AnsibleControllerJobTemplateFilterSet

`AnsibleControllerViewSet` ¶

Bases: NautobotModelViewSet

AnsibleController viewset.

Source code in nautobot_ansible_automation/api/views.py

class AnsibleControllerViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """AnsibleController viewset."""

    queryset = models.AnsibleController.objects.all()
    serializer_class = serializers.AnsibleControllerSerializer
    filterset_class = filters.AnsibleControllerFilterSet

Nautobot Ansible Automation API Package¶