Golden Config API Package¶
nautobot_golden_config.api
¶
REST API module for nautobot_golden_config plugin.
serializers
¶
REST API serializer capabilities for graphql plugin.
ComplianceFeatureSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for ComplianceFeature object.
Source code in nautobot_golden_config/api/serializers.py
ComplianceRuleSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for ComplianceRule object.
Source code in nautobot_golden_config/api/serializers.py
ConfigComplianceSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for ConfigCompliance object.
Source code in nautobot_golden_config/api/serializers.py
ConfigPlanSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
, StatusModelSerializerMixin
Serializer for ConfigPlan object.
Source code in nautobot_golden_config/api/serializers.py
Meta
¶
Set Meta Data for ConfigPlan, will serialize all fields.
Source code in nautobot_golden_config/api/serializers.py
ConfigRemoveSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for ConfigRemove object.
Source code in nautobot_golden_config/api/serializers.py
ConfigReplaceSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for ConfigReplace object.
Source code in nautobot_golden_config/api/serializers.py
ConfigToPushSerializer
¶
Bases: DeviceSerializer
Serializer for ConfigToPush view.
Source code in nautobot_golden_config/api/serializers.py
Meta
¶
Bases: DeviceSerializer
Extend the Device serializer with the configuration after postprocessing.
Source code in nautobot_golden_config/api/serializers.py
get_config(obj)
¶
Provide the intended configuration ready after postprocessing to the config field.
Source code in nautobot_golden_config/api/serializers.py
GoldenConfigSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for GoldenConfig object.
Source code in nautobot_golden_config/api/serializers.py
GoldenConfigSettingSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for GoldenConfigSetting object.
Source code in nautobot_golden_config/api/serializers.py
Meta
¶
create(validated_data)
¶
Overload to handle ability to post scope instead of dynamic_group.
Source code in nautobot_golden_config/api/serializers.py
validate(data)
¶
Validate scope & dynamic_group are not both submitted.
Source code in nautobot_golden_config/api/serializers.py
GraphQLSerializer
¶
NestedConfigPlanSerializer
¶
Bases: WritableNestedSerializer
Nested serializer for ConfigPlan object.
Source code in nautobot_golden_config/api/serializers.py
RemediationSettingSerializer
¶
Bases: NautobotModelSerializer
, TaggedObjectSerializer
Serializer for RemediationSetting object.
Source code in nautobot_golden_config/api/serializers.py
Meta
¶
Set Meta Data for RemediationSetting, will serialize all fields.
Source code in nautobot_golden_config/api/serializers.py
urls
¶
API for Custom Jobs .
views
¶
View for Golden Config APIs.
ComplianceFeatureViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with ComplianceFeature objects.
Source code in nautobot_golden_config/api/views.py
ComplianceRuleViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with ComplianceRule objects.
Source code in nautobot_golden_config/api/views.py
ConfigComplianceViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with ConfigCompliance objects.
Source code in nautobot_golden_config/api/views.py
ConfigPlanViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with ConfigPlan objects.
Source code in nautobot_golden_config/api/views.py
ConfigPushPermissions
¶
Bases: BasePermission
Permissions class to validate access to Devices and GoldenConfig view.
Source code in nautobot_golden_config/api/views.py
ConfigRemoveViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with ConfigRemove objects.
Source code in nautobot_golden_config/api/views.py
ConfigReplaceViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with ConfigReplace objects.
Source code in nautobot_golden_config/api/views.py
ConfigToPushViewSet
¶
Bases: RetrieveModelMixin
, GenericViewSet
Detail REST API view showing configuration after postprocessing.
Source code in nautobot_golden_config/api/views.py
GoldenConfigRootView
¶
Bases: APIRootView
Golden Config API root view.
Source code in nautobot_golden_config/api/views.py
GoldenConfigSettingViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with GoldenConfigSetting objects.
Source code in nautobot_golden_config/api/views.py
GoldenConfigViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with GoldenConfig objects.
Source code in nautobot_golden_config/api/views.py
RemediationSettingViewSet
¶
Bases: NautobotModelViewSet
API viewset for interacting with RemediationSetting objects.
Source code in nautobot_golden_config/api/views.py
SOTAggDeviceDetailView
¶
Bases: APIView
Detail REST API view showing graphql, with a potential "transformer" of data on a specific device.
Source code in nautobot_golden_config/api/views.py
get(request, *args, **kwargs)
¶
Get method serialize for a dictionary to json response.