Skip to main content

Peering IXP

This schema extension contains all you need to model anything revolving around internet peering (Exchange points ...)!

Details

Nodes

IXP

  • Label: Internet Exchange
  • Description: An Internet Exchange Point (IXP) for peering
  • Namespace: Peering
  • Icon: mdi:network
  • Human Friendly ID: name__value

Attributes

namedescriptionkindoptionaldefault_valuechoices
nameName of the Internet ExchangeTextFalse
descriptionAn optional description of the Internet ExchangeTextTrue
statusDropdownFalseenabledenabled, disabled

Relationships

namepeeroptionalcardinalitykind
connectionsPeeringIXPConnectionTruemanyComponent
local_asRoutingAutonomousSystemTrueoneAttribute
import_policiesRoutingPolicyBGPTruemanyGeneric
export_policiesRoutingPolicyBGPTruemanyGeneric
bgp_communitiesRoutingBGPCommunityTruemanyGeneric
tagsBuiltinTagTruemanyAttribute

IXPConnection

  • Label: IXP Connection
  • Description: A connection to an Internet Exchange Point (IXP)
  • Namespace: Peering
  • Icon: mdi:lan-connect
  • Uniqueness Constraints:
    • name__value
  • Human Friendly ID: name__value

Attributes

namedescriptionkindoptionaldefault_valuechoices
nameName of the IXP ConnectionTextFalse
descriptionDescription of the IXP ConnectionTextTrue
peeringdb_netixlanPeeringDB ID for the IXP connectionNumberTrue
statusDropdownTrueenabledenabled, pre_maintenance, maintenance, post_maintenance, disabled
vlanVLAN ID for the connectionNumberTrue
mac_addressMAC address associated with the connectionMacAddressTrue

Relationships

namepeeroptionalcardinalitykind
ipv6_addressIpamIPAddressTrueoneAttribute
ipv4_addressIpamIPAddressTrueoneAttribute
internet_exchange_pointPeeringIXPFalseoneParent
routerDcimDeviceTrueoneAttribute
bgp_sessionsRoutingBGPSessionTruemanyComponent
tagsBuiltinTagTruemanyAttribute

Extensions

note

In this context "extensions" refer to modifications or additions to the existing schema, such as adding new attributes, relationships, or other schema elements.

RoutingBGPSession

Relationships

namepeeroptionalcardinalitykind
ixp_connectionPeeringIXPConnectionTrueoneAttribute

Code

version: '1.0'
nodes:
- name: IXP
namespace: Peering
description: An Internet Exchange Point (IXP) for peering
label: Internet Exchange
icon: mdi:network
include_in_menu: true
human_friendly_id:
- name__value
order_by:
- name__value
display_label: name__value
attributes:
- name: name
kind: Text
unique: true
optional: false
description: Name of the Internet Exchange
order_weight: 1000
- name: description
kind: Text
optional: true
description: An optional description of the Internet Exchange
order_weight: 1100
- name: status
kind: Dropdown
default_value: enabled
choices:
- name: enabled
label: Enabled
description: Internet Exchange is active and operational
color: '#00d25b'
- name: disabled
label: Disabled
description: Internet Exchange is not operational
color: '#b0bec5'
optional: false
order_weight: 1200
relationships:
- name: connections
peer: PeeringIXPConnection
kind: Component
cardinality: many
optional: true
description: IXP connections associated with this Internet Exchange
order_weight: 1500
- name: local_as
peer: RoutingAutonomousSystem
kind: Attribute
cardinality: one
optional: true
order_weight: 1300
- name: import_policies
peer: RoutingPolicyBGP
label: Import Routing Policies
kind: Generic
cardinality: many
optional: true
identifier: ixp__import_bgppolicies
description: Import routing policies applied to every session on this internet
exchange point
order_weight: 1600
- name: export_policies
peer: RoutingPolicyBGP
label: Export Routing Policies
kind: Generic
cardinality: many
optional: true
identifier: ixp__export_bgppolicies
description: Export routing policies applied to every session on this internet
exchange point
order_weight: 1650
- name: bgp_communities
peer: RoutingBGPCommunity
label: BGP Communities
kind: Generic
cardinality: many
optional: true
description: BGP communities associated with this internet exchange point
order_weight: 1700
- name: tags
peer: BuiltinTag
kind: Attribute
cardinality: many
optional: true
order_weight: 2000
- name: IXPConnection
namespace: Peering
description: A connection to an Internet Exchange Point (IXP)
label: IXP Connection
icon: mdi:lan-connect
include_in_menu: true
menu_placement: PeeringIXP
human_friendly_id:
- name__value
order_by:
- name__value
display_label: name__value
uniqueness_constraints:
- - name__value
attributes:
- name: name
kind: Text
unique: true
optional: false
description: Name of the IXP Connection
order_weight: 1000
- name: description
kind: Text
optional: true
description: Description of the IXP Connection
order_weight: 1100
- name: peeringdb_netixlan
kind: Number
label: PeeringDB Netixlan
optional: true
description: PeeringDB ID for the IXP connection
order_weight: 1150
- name: status
kind: Dropdown
default_value: enabled
choices:
- name: enabled
label: Enabled
description: The system is fully operational and functioning as expected.
color: '#00d25b'
- name: pre_maintenance
label: Pre-Maintenance
description: Preparation stage before performing maintenance tasks.
color: '#f4a261'
- name: maintenance
label: Maintenance
description: Currently undergoing maintenance tasks.
color: '#e9c46a'
- name: post_maintenance
label: Post-Maintenance
description: Final checks and verifications after maintenance tasks.
color: '#f0e5de'
- name: disabled
label: Disabled
description: The system is not operational and cannot be used.
color: '#b0bec5'
optional: true
order_weight: 1200
- name: vlan
kind: Number
optional: true
description: VLAN ID for the connection
order_weight: 1300
- name: mac_address
kind: MacAddress
label: MAC Address
optional: true
description: MAC address associated with the connection
order_weight: 1350
relationships:
- name: ipv6_address
peer: IpamIPAddress
label: IPv6 Address
kind: Attribute
cardinality: one
identifier: ixpconn__ipv6_address
optional: true
description: IPv6 address assigned to the connection
order_weight: 1400
- name: ipv4_address
peer: IpamIPAddress
label: IPv4 Address
kind: Attribute
cardinality: one
identifier: ixpconn__ipv4_address
optional: true
description: IPv4 address assigned to the connection
order_weight: 1375
- name: internet_exchange_point
peer: PeeringIXP
label: IXP
kind: Parent
cardinality: one
optional: false
description: The Internet Exchange Point this connection is part of
order_weight: 900
- name: router
peer: DcimDevice
kind: Attribute
cardinality: one
optional: true
description: The router this IXP connection is connected to
order_weight: 1500
- name: bgp_sessions
peer: RoutingBGPSession
label: BGP Sessions
kind: Component
cardinality: many
optional: true
on_delete: no-action
identifier: ixpconn__bgpsessions
description: BGP sessions established over this IXP connection
order_weight: 1550
- name: tags
peer: BuiltinTag
kind: Attribute
cardinality: many
optional: true
order_weight: 2000
extensions:
nodes:
- kind: RoutingBGPSession
relationships:
- name: ixp_connection
peer: PeeringIXPConnection
label: IXP Connection
kind: Attribute
cardinality: one
optional: true
identifier: ixpconn__bgpsessions
description: The IXP connection this BGP session is established over
order_weight: 1800