Golden Config API Package¶
nautobot_golden_config.api
¶
REST API module for nautobot_golden_config app.
serializers
¶
REST API serializer capabilities for graphql app.
ComplianceFeatureSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
Serializer for ComplianceFeature object.
Source code in nautobot_golden_config/api/serializers.py
ComplianceRuleSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
Serializer for ComplianceRule object.
Source code in nautobot_golden_config/api/serializers.py
ConfigComplianceSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
Serializer for ConfigCompliance object.
Source code in nautobot_golden_config/api/serializers.py
ConfigPlanSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
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
, TaggedModelSerializerMixin
Serializer for ConfigRemove object.
Source code in nautobot_golden_config/api/serializers.py
ConfigReplaceSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
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: Meta
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
GenerateIntendedConfigSerializer
¶
Bases: Serializer
Serializer for GenerateIntendedConfigView.
Source code in nautobot_golden_config/api/serializers.py
GoldenConfigSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
Serializer for GoldenConfig object.
Source code in nautobot_golden_config/api/serializers.py
GoldenConfigSettingSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
Serializer for GoldenConfigSetting object.
Source code in nautobot_golden_config/api/serializers.py
GraphQLSerializer
¶
RemediationSettingSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
Serializer for RemediationSetting object.
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: NautobotAPIVersionMixin
, NotesViewSetMixin
, ModelViewSetMixin
, RetrieveModelMixin
, UpdateModelMixin
, DestroyModelMixin
, ListModelMixin
, BulkUpdateModelMixin
, BulkDestroyModelMixin
, GenericViewSet
API viewset for interacting with ConfigPlan objects. Does not support POST to create objects.
Source code in nautobot_golden_config/api/views.py
get_serializer_context()
¶
Gather all custom fields for the model. Copied from nautobot.extras.api.views.CustomFieldModelViewSet.
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
GenerateIntendedConfigException
¶
Bases: APIException
Exception for when the intended config cannot be generated.
Source code in nautobot_golden_config/api/views.py
GenerateIntendedConfigView
¶
Bases: NautobotAPIVersionMixin
, GenericAPIView
API view for generating the intended config for a Device.
Source code in nautobot_golden_config/api/views.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
|
get(request, *args, **kwargs)
¶
Generate intended configuration for a Device.
Source code in nautobot_golden_config/api/views.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
|
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.