netbox_rpki.services.provider_write

Exceptions

ProviderWriteError

Inappropriate argument value (of correct type).

Functions

build_roa_change_plan_delta(plan)

build_aspa_change_plan_delta(plan)

build_roa_change_plan_preview_report(plan)

build_aspa_change_plan_preview_report(plan)

approve_rollback_bundle(bundle, *[, approved_by, ...])

apply_roa_rollback_bundle(bundle, *[, requested_by])

apply_aspa_rollback_bundle(bundle, *[, requested_by])

acknowledge_roa_lint_findings(plan, *[, ...])

approve_roa_change_plan(plan, *[, approved_by, ...])

approve_aspa_change_plan(plan, *[, approved_by, ...])

approve_roa_change_plan_secondary(plan, *[, ...])

approve_aspa_change_plan_secondary(plan, *[, ...])

preview_roa_change_plan_provider_write(plan, *[, ...])

preview_aspa_change_plan_provider_write(plan, *[, ...])

apply_roa_change_plan_provider_write(plan, *[, ...])

apply_aspa_change_plan_provider_write(plan, *[, ...])

Module Contents

exception netbox_rpki.services.provider_write.ProviderWriteError[source]

Bases: ValueError

Inheritance diagram of netbox_rpki.services.provider_write.ProviderWriteError

Inappropriate argument value (of correct type).

netbox_rpki.services.provider_write.build_roa_change_plan_delta(plan)[source]
Parameters:

plan (netbox_rpki.models.ROAChangePlan | int)

Return type:

dict[str, list[dict]]

netbox_rpki.services.provider_write.build_aspa_change_plan_delta(plan)[source]
Parameters:

plan (netbox_rpki.models.ASPAChangePlan | int)

Return type:

dict[str, list[dict]]

netbox_rpki.services.provider_write.build_roa_change_plan_preview_report(plan)[source]
Parameters:

plan (netbox_rpki.models.ROAChangePlan | int)

Return type:

dict[str, object]

netbox_rpki.services.provider_write.build_aspa_change_plan_preview_report(plan)[source]
Parameters:

plan (netbox_rpki.models.ASPAChangePlan | int)

Return type:

dict[str, object]

netbox_rpki.services.provider_write.approve_rollback_bundle(bundle, *, approved_by='', ticket_reference='', change_reference='', maintenance_window_start=None, maintenance_window_end=None, notes='')[source]
Parameters:

  • approved_by (str)

  • ticket_reference (str)

  • change_reference (str)

  • notes (str)

netbox_rpki.services.provider_write.apply_roa_rollback_bundle(bundle, *, requested_by='')[source]
Parameters:
Return type:

netbox_rpki.models.ROAChangePlanRollbackBundle

netbox_rpki.services.provider_write.apply_aspa_rollback_bundle(bundle, *, requested_by='')[source]
Parameters:
Return type:

netbox_rpki.models.ASPAChangePlanRollbackBundle

netbox_rpki.services.provider_write.acknowledge_roa_lint_findings(plan, *, acknowledged_finding_ids=None, previously_acknowledged_finding_ids=None, acknowledged_by='', ticket_reference='', change_reference='', notes='')[source]
Parameters:

  • plan (netbox_rpki.models.ROAChangePlan | int)

  • acknowledged_finding_ids (list[int] | None)

  • previously_acknowledged_finding_ids (list[int] | None)

  • acknowledged_by (str)

  • ticket_reference (str)

  • change_reference (str)

  • notes (str)

Return type:

list[netbox_rpki.models.ROALintAcknowledgement]

netbox_rpki.services.provider_write.approve_roa_change_plan(plan, *, approved_by='', requires_secondary_approval=None, ticket_reference='', change_reference='', maintenance_window_start=None, maintenance_window_end=None, approval_notes='', acknowledged_finding_ids=None, previously_acknowledged_finding_ids=None, acknowledged_simulation_result_ids=None, lint_acknowledgement_notes='')[source]
Parameters:

  • plan (netbox_rpki.models.ROAChangePlan | int)

  • approved_by (str)

  • requires_secondary_approval (bool | None)

  • ticket_reference (str)

  • change_reference (str)

  • approval_notes (str)

  • acknowledged_finding_ids (list[int] | None)

  • previously_acknowledged_finding_ids (list[int] | None)

  • acknowledged_simulation_result_ids (list[int] | None)

  • lint_acknowledgement_notes (str)

Return type:

netbox_rpki.models.ROAChangePlan

netbox_rpki.services.provider_write.approve_aspa_change_plan(plan, *, approved_by='', requires_secondary_approval=None, ticket_reference='', change_reference='', maintenance_window_start=None, maintenance_window_end=None, approval_notes='')[source]
Parameters:

  • plan (netbox_rpki.models.ASPAChangePlan | int)

  • approved_by (str)

  • requires_secondary_approval (bool | None)

  • ticket_reference (str)

  • change_reference (str)

  • approval_notes (str)

Return type:

netbox_rpki.models.ASPAChangePlan

netbox_rpki.services.provider_write.approve_roa_change_plan_secondary(plan, *, secondary_approved_by='', approval_notes='')[source]
Parameters:
Return type:

netbox_rpki.models.ROAChangePlan

netbox_rpki.services.provider_write.approve_aspa_change_plan_secondary(plan, *, secondary_approved_by='', approval_notes='')[source]
Parameters:
Return type:

netbox_rpki.models.ASPAChangePlan

netbox_rpki.services.provider_write.preview_roa_change_plan_provider_write(plan, *, requested_by='')[source]
Parameters:
Return type:

tuple[netbox_rpki.models.ProviderWriteExecution, dict[str, list[dict]]]

netbox_rpki.services.provider_write.preview_aspa_change_plan_provider_write(plan, *, requested_by='')[source]
Parameters:
Return type:

tuple[netbox_rpki.models.ProviderWriteExecution, dict[str, list[dict]]]

netbox_rpki.services.provider_write.apply_roa_change_plan_provider_write(plan, *, requested_by='')[source]
Parameters:
Return type:

tuple[netbox_rpki.models.ProviderWriteExecution, dict[str, list[dict]]]

netbox_rpki.services.provider_write.apply_aspa_change_plan_provider_write(plan, *, requested_by='')[source]
Parameters:
Return type:

tuple[netbox_rpki.models.ProviderWriteExecution, dict[str, list[dict]]]