netbox_rpki.services

Submodules

• netbox_rpki.services.aspa_intent
• netbox_rpki.services.provider_sync
• netbox_rpki.services.provider_sync_contract
• netbox_rpki.services.provider_sync_diff
• netbox_rpki.services.provider_sync_krill
• netbox_rpki.services.provider_write
• netbox_rpki.services.roa_lint
• netbox_rpki.services.routing_intent
• netbox_rpki.services.rov_simulation

Exceptions

ProviderSyncError	Common base class for all non-exit exceptions.
ProviderWriteError	Inappropriate argument value (of correct type).
ASPAReconciliationExecutionError	Inappropriate argument value (of correct type).
RoutingIntentExecutionError	Inappropriate argument value (of correct type).

Functions

sync_provider_account(provider_account, *[, snapshot_name])
apply_roa_change_plan_provider_write(plan, *[, ...])
approve_roa_change_plan(plan, *[, approved_by, ...])
build_roa_change_plan_delta(plan)
preview_roa_change_plan_provider_write(plan, *[, ...])
run_roa_lint(reconciliation_run, *[, change_plan, ...])
simulate_roa_change_plan(plan, *[, run_name])
reconcile_aspa_intents(intent_profile, *[, ...])
run_aspa_reconciliation_pipeline(intent_profile, *[, ...])
create_roa_change_plan(reconciliation_run, *[, name])
derive_roa_intents(profile, *[, trigger_mode, run_name])
reconcile_roa_intents(derivation_run, *[, ...])
run_routing_intent_pipeline(profile, *[, ...])

Package Contents

exception netbox_rpki.services.ProviderSyncError

Bases: Exception

Common base class for all non-exit exceptions.

netbox_rpki.services.sync_provider_account(provider_account, *, snapshot_name=None)

Parameters:

• provider_account (netbox_rpki.models.RpkiProviderAccount | int)

• snapshot_name (str | None)

Return type:

tuple[netbox_rpki.models.ProviderSyncRun, netbox_rpki.models.ProviderSnapshot]

exception netbox_rpki.services.ProviderWriteError

Bases: ValueError

Inappropriate argument value (of correct type).

netbox_rpki.services.apply_roa_change_plan_provider_write(plan, *, requested_by='')

Parameters:

• plan (netbox_rpki.models.ROAChangePlan | int)

• requested_by (str)

Return type:

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

netbox_rpki.services.approve_roa_change_plan(plan, *, approved_by='', ticket_reference='', change_reference='', maintenance_window_start=None, maintenance_window_end=None, approval_notes='')

Parameters:

• plan (netbox_rpki.models.ROAChangePlan | int)

• approved_by (str)

• ticket_reference (str)

• change_reference (str)

• approval_notes (str)

Return type:

netbox_rpki.models.ROAChangePlan

netbox_rpki.services.build_roa_change_plan_delta(plan)

Parameters:

plan (netbox_rpki.models.ROAChangePlan | int)

Return type:

dict[str, list[dict]]

netbox_rpki.services.preview_roa_change_plan_provider_write(plan, *, requested_by='')

Parameters:

• plan (netbox_rpki.models.ROAChangePlan | int)

• requested_by (str)

Return type:

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

netbox_rpki.services.run_roa_lint(reconciliation_run, *, change_plan=None, run_name=None)

Parameters:

• reconciliation_run (netbox_rpki.models.ROAReconciliationRun | int)

• change_plan (netbox_rpki.models.ROAChangePlan | int | None)

• run_name (str | None)

Return type:

netbox_rpki.models.ROALintRun

netbox_rpki.services.simulate_roa_change_plan(plan, *, run_name=None)

Parameters:

• plan (netbox_rpki.models.ROAChangePlan | int)

• run_name (str | None)

Return type:

netbox_rpki.models.ROAValidationSimulationRun

exception netbox_rpki.services.ASPAReconciliationExecutionError

Bases: ValueError

Inappropriate argument value (of correct type).

netbox_rpki.services.reconcile_aspa_intents(intent_profile, *, comparison_scope=ASPA_COMPARISON_SCOPE_LOCAL, provider_snapshot=None, run_name=None)

Parameters:

• comparison_scope (str)

• run_name (str | None)

netbox_rpki.services.run_aspa_reconciliation_pipeline(intent_profile, *, comparison_scope=ASPA_COMPARISON_SCOPE_LOCAL, provider_snapshot=None, run_name=None)

Parameters:

• comparison_scope (str)

• run_name (str | None)

exception netbox_rpki.services.RoutingIntentExecutionError

Bases: ValueError

Inappropriate argument value (of correct type).

netbox_rpki.services.create_roa_change_plan(reconciliation_run, *, name=None)

Parameters:

• reconciliation_run (netbox_rpki.models.ROAReconciliationRun)

• name (str | None)

Return type:

netbox_rpki.models.ROAChangePlan

netbox_rpki.services.derive_roa_intents(profile, *, trigger_mode=rpki_models.IntentRunTriggerMode.MANUAL, run_name=None)

Parameters:

• profile (netbox_rpki.models.RoutingIntentProfile)

• trigger_mode (str)

• run_name (str | None)

Return type:

netbox_rpki.models.IntentDerivationRun

netbox_rpki.services.reconcile_roa_intents(derivation_run, *, comparison_scope=rpki_models.ReconciliationComparisonScope.LOCAL_ROA_RECORDS, provider_snapshot=None, run_name=None)

Parameters:

• derivation_run (netbox_rpki.models.IntentDerivationRun)

• comparison_scope (str)

• provider_snapshot (netbox_rpki.models.ProviderSnapshot | int | None)

• run_name (str | None)

Return type:

netbox_rpki.models.ROAReconciliationRun

netbox_rpki.services.run_routing_intent_pipeline(profile, *, trigger_mode=rpki_models.IntentRunTriggerMode.MANUAL, comparison_scope=rpki_models.ReconciliationComparisonScope.LOCAL_ROA_RECORDS, provider_snapshot=None)

Parameters:

• profile (netbox_rpki.models.RoutingIntentProfile)

• trigger_mode (str)

• comparison_scope (str)

• provider_snapshot (netbox_rpki.models.ProviderSnapshot | int | None)

Return type:

tuple[netbox_rpki.models.IntentDerivationRun, netbox_rpki.models.ROAReconciliationRun]