netbox_rpki.services.routing_intent

Attributes

`MATCH_SCORES`
`REPLACEMENT_REASON_TEXT`
`REPLACEMENT_REASON_PRIORITY`
`INTENT_RESULT_FROM_REPLACEMENT_REASON`
`PUBLISHED_RESULT_FROM_REPLACEMENT_REASON`
`REPLACEMENT_INTENT_RESULT_TYPES`

Exceptions

RoutingIntentExecutionError

Inappropriate argument value (of correct type).

Classes

`PublishedAuthorization`
`CompiledTemplateBinding`
`CompiledRoutingIntentException`
`RoutingIntentBindingRegenerationAssessment`
`CompiledRoutingIntentPolicy`
`ROAIntentPreviewResult`
`RoutingIntentDerivationPreview`

Functions

`compile_routing_intent_policy`(profile, *[, bindings, ...])
`derive_roa_intents`(profile, *[, trigger_mode, ...])
`preview_routing_intent_template_binding`(binding)
`refresh_routing_intent_template_binding_state`(binding)
`run_routing_intent_template_binding_pipeline`(binding, *)
`reconcile_roa_intents`(derivation_run, *[, ...])
`run_routing_intent_pipeline`(profile, *[, ...])
`create_roa_change_plan`(reconciliation_run, *[, name])

Module Contents

exception netbox_rpki.services.routing_intent.RoutingIntentExecutionError[source]

Bases: ValueError

Inheritance diagram of netbox_rpki.services.routing_intent.RoutingIntentExecutionError

Inappropriate argument value (of correct type).

class netbox_rpki.services.routing_intent.PublishedAuthorization[source]

source_key: str[source]

source_name: str[source]

roa_object: netbox_rpki.models.RoaObject | None[source]

roa_object_prefix: netbox_rpki.models.RoaObjectPrefix | None[source]

imported_authorization: netbox_rpki.models.ImportedRoaAuthorization | None[source]

network: netaddr.IPNetwork[source]

prefix_cidr_text: str[source]

origin_asn_value: int | None[source]

max_length: int | None[source]

stale: bool[source]

class netbox_rpki.services.routing_intent.CompiledTemplateBinding[source]

binding: netbox_rpki.models.RoutingIntentTemplateBinding[source]

rules: tuple[netbox_rpki.models.RoutingIntentTemplateRule, Ellipsis][source]

context_groups: tuple[netbox_rpki.models.RoutingIntentContextGroup, Ellipsis][source]

prefix_ids: frozenset[int][source]

selected_asns: tuple[ipam.models.ASN, Ellipsis][source]

default_origin_asn: ipam.models.ASN | None[source]

template_fingerprint: str[source]

binding_fingerprint: str[source]

warnings: tuple[str, Ellipsis][source]

class netbox_rpki.services.routing_intent.CompiledRoutingIntentException[source]

exception: netbox_rpki.models.RoutingIntentException[source]

fingerprint: str[source]

class netbox_rpki.services.routing_intent.RoutingIntentBindingRegenerationAssessment[source]

binding: netbox_rpki.models.RoutingIntentTemplateBinding[source]

state: str[source]

changed: bool[source]

previous_fingerprint: str | None[source]

current_fingerprint: str | None[source]

reason_codes: tuple[str, Ellipsis][source]

reason_summary: str[source]

class netbox_rpki.services.routing_intent.CompiledRoutingIntentPolicy[source]

profile: netbox_rpki.models.RoutingIntentProfile[source]

prefixes: tuple[ipam.models.Prefix, Ellipsis][source]

selected_asns: tuple[ipam.models.ASN, Ellipsis][source]

default_origin_asn: ipam.models.ASN | None[source]

profile_context_groups: tuple[netbox_rpki.models.RoutingIntentContextGroup, Ellipsis][source]

local_rules: tuple[netbox_rpki.models.RoutingIntentRule, Ellipsis][source]

exceptions: tuple[CompiledRoutingIntentException, Ellipsis][source]

overrides: tuple[netbox_rpki.models.ROAIntentOverride, Ellipsis][source]

template_bindings: tuple[CompiledTemplateBinding, Ellipsis][source]

warnings: tuple[str, Ellipsis][source]

input_fingerprint: str[source]

class netbox_rpki.services.routing_intent.ROAIntentPreviewResult[source]

prefix: ipam.models.Prefix[source]

prefix_cidr_text: str[source]

origin_asn: ipam.models.ASN | None[source]

origin_asn_value: int | None[source]

max_length: int | None[source]

derived_state: str[source]

exposure_state: str[source]

source_rule: netbox_rpki.models.RoutingIntentRule | None[source]

applied_override: netbox_rpki.models.ROAIntentOverride | None[source]

explanation: str[source]

class netbox_rpki.services.routing_intent.RoutingIntentDerivationPreview[source]

profile: netbox_rpki.models.RoutingIntentProfile[source]

compiled_policy: CompiledRoutingIntentPolicy[source]

results: tuple[ROAIntentPreviewResult, Ellipsis][source]

warnings: tuple[str, Ellipsis][source]

netbox_rpki.services.routing_intent.MATCH_SCORES[source]

netbox_rpki.services.routing_intent.REPLACEMENT_REASON_TEXT[source]

netbox_rpki.services.routing_intent.REPLACEMENT_REASON_PRIORITY[source]

netbox_rpki.services.routing_intent.INTENT_RESULT_FROM_REPLACEMENT_REASON[source]

netbox_rpki.services.routing_intent.PUBLISHED_RESULT_FROM_REPLACEMENT_REASON[source]

netbox_rpki.services.routing_intent.REPLACEMENT_INTENT_RESULT_TYPES[source]

netbox_rpki.services.routing_intent.compile_routing_intent_policy(profile, *, bindings=None, include_inactive_bindings=False, persist_state=False, commit_binding_state=False)[source]

Parameters:

profile (netbox_rpki.models.RoutingIntentProfile)
bindings (tuple[netbox_rpki.models.RoutingIntentTemplateBinding, Ellipsis] | None)
include_inactive_bindings (bool)
persist_state (bool)
commit_binding_state (bool)

Return type:

CompiledRoutingIntentPolicy

netbox_rpki.services.routing_intent.derive_roa_intents(profile, *, trigger_mode=rpki_models.IntentRunTriggerMode.MANUAL, run_name=None, compiled_policy=None)[source]

Parameters:

profile (netbox_rpki.models.RoutingIntentProfile)
trigger_mode (str)
run_name (str | None)
compiled_policy (CompiledRoutingIntentPolicy | None)

Return type:

netbox_rpki.models.IntentDerivationRun

netbox_rpki.services.routing_intent.preview_routing_intent_template_binding(binding)[source]

Parameters:: binding (netbox_rpki.models.RoutingIntentTemplateBinding)
Return type:: RoutingIntentDerivationPreview

netbox_rpki.services.routing_intent.refresh_routing_intent_template_binding_state(binding)[source]

Parameters:: binding (netbox_rpki.models.RoutingIntentTemplateBinding)
Return type:: RoutingIntentBindingRegenerationAssessment

netbox_rpki.services.routing_intent.run_routing_intent_template_binding_pipeline(binding, *, trigger_mode=rpki_models.IntentRunTriggerMode.MANUAL, comparison_scope=rpki_models.ReconciliationComparisonScope.LOCAL_ROA_RECORDS, provider_snapshot=None)[source]

Parameters:

binding (netbox_rpki.models.RoutingIntentTemplateBinding)
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]

netbox_rpki.services.routing_intent.reconcile_roa_intents(derivation_run, *, comparison_scope=rpki_models.ReconciliationComparisonScope.LOCAL_ROA_RECORDS, provider_snapshot=None, run_name=None)[source]

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.routing_intent.run_routing_intent_pipeline(profile, *, trigger_mode=rpki_models.IntentRunTriggerMode.MANUAL, comparison_scope=rpki_models.ReconciliationComparisonScope.LOCAL_ROA_RECORDS, provider_snapshot=None)[source]

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]

netbox_rpki.services.routing_intent.create_roa_change_plan(reconciliation_run, *, name=None)[source]

Parameters:

reconciliation_run (netbox_rpki.models.ROAReconciliationRun)
name (str | None)

Return type:

netbox_rpki.models.ROAChangePlan