Routing OSPF

This schema extension adds OSPF and OSPF Interface nodes to model an OSPF instance per device and VRF and the interfaces it runs on.

Details

• Dependencies:
  • base
  • extensions/routing

Nodes

OSPF

• Label: OSPF
• Description: OSPF (Open Shortest Path First) instance on a Virtual Router.
• Namespace: Routing
• Icon: mdi:network-outline
• Uniqueness Constraints:
  • device, vrf, version__value
• Human Friendly ID: device__name__value, vrf__name__value, version__value
• Inherit From: RoutingProtocol

Attributes

name	description	kind	optional	default_value	choices
reference_bandwidth	Reference bandwidth for OSPF instance (in Mbps).	Number	True	1000
version	Version of the OSPF protocol.	Dropdown	False	ospf	ospf, ospfv3
import_policies		Text	True
export_policies		Text	True

Relationships

name	peer	optional	cardinality	kind
router_id	IpamIPAddress	True	one	Attribute
ospf_interfaces	RoutingOSPFInterface	True	many	Component

OSPFInterface

• Label: OSPF Interface
• Description: Pivot table linking OSPF configuration to an interface.
• Namespace: Routing
• Icon: mdi:ethernet
• Uniqueness Constraints:
  • ospf, interface
• Human Friendly ID: description__value

Attributes

name	description	kind	optional	default_value	choices
description	Description of the OSPF interface.	Text	False
metric	OSPF metric for the interface.	Number	True
mode	Mode of the OSPF interface.	Dropdown	False	normal	normal, passive, peer_to_peer
authentication_key	Shared secret used to authenticate and secure routing messages between neighboring routers.	Password	True
authentication_mode		Dropdown	True		md5, sha1
area	OSPF area associated with the interface.	Text	False

Relationships

name	peer	optional	cardinality	kind
ospf	RoutingOSPF	False	one	Parent
interface	InterfaceLayer3	False	one	Attribute

Code

version: '1.0'
nodes:
- name: OSPF
  namespace: Routing
  description: OSPF (Open Shortest Path First) instance on a Virtual Router.
  label: OSPF
  icon: mdi:network-outline
  include_in_menu: true
  menu_placement: RoutingProtocol
  inherit_from:
  - RoutingProtocol
  human_friendly_id:
  - device__name__value
  - vrf__name__value
  - version__value
  order_by:
  - router_id__address__value
  - vrf__name__value
  - device__name__value
  display_label: description__value
  uniqueness_constraints:
  - - device
    - vrf
    - version__value
  attributes:
  - name: reference_bandwidth
    kind: Number
    default_value: 1000
    optional: true
    description: Reference bandwidth for OSPF instance (in Mbps).
    order_weight: 1350
  - name: version
    kind: Dropdown
    default_value: ospf
    choices:
    - name: ospf
      label: OSPFv2
      description: Open Shortest Path First version 2.
      color: '#E6E6FA'
    - name: ospfv3
      label: OSPFv3
      description: Open Shortest Path First version 3.
      color: '#E6E6FA'
    optional: false
    description: Version of the OSPF protocol.
    order_weight: 1300
  - name: import_policies
    kind: Text
    optional: true
    order_weight: 1450
  - name: export_policies
    kind: Text
    optional: true
    order_weight: 1500
  relationships:
  - name: router_id
    peer: IpamIPAddress
    kind: Attribute
    cardinality: one
    optional: true
    order_weight: 1400
  - name: ospf_interfaces
    peer: RoutingOSPFInterface
    label: OSPF Interfaces
    kind: Component
    cardinality: many
    optional: true
    identifier: ospf__ospfinterfaces
    order_weight: 1550
- name: OSPFInterface
  namespace: Routing
  description: Pivot table linking OSPF configuration to an interface.
  label: OSPF Interface
  icon: mdi:ethernet
  include_in_menu: true
  menu_placement: RoutingOSPF
  human_friendly_id:
  - description__value
  order_by:
  - description__value
  display_label: description__value
  uniqueness_constraints:
  - - ospf
    - interface
  attributes:
  - name: description
    kind: Text
    unique: true
    optional: false
    description: Description of the OSPF interface.
    order_weight: 1100
  - name: metric
    kind: Number
    optional: true
    description: OSPF metric for the interface.
    order_weight: 1400
  - name: mode
    kind: Dropdown
    default_value: normal
    choices:
    - name: normal
      label: Normal
      description: Standard OSPF interface mode.
      color: '#E6E6FA'
    - name: passive
      label: Passive
      description: Interface will not send OSPF hello packets.
      color: '#E6E6FA'
    - name: peer_to_peer
      label: Peer-to-Peer
      description: OSPF peer-to-peer interface mode.
      color: '#E6E6FA'
    optional: false
    description: Mode of the OSPF interface.
    order_weight: 1300
  - name: authentication_key
    kind: Password
    optional: true
    description: Shared secret used to authenticate and secure routing messages between
      neighboring routers.
    order_weight: 1250
  - name: authentication_mode
    kind: Dropdown
    choices:
    - name: md5
      label: MD5
      color: '#E6E6FA'
    - name: sha1
      label: SHA1
      color: '#E6E6FA'
    optional: true
    order_weight: 1225
  - name: area
    kind: Text
    optional: false
    description: OSPF area associated with the interface.
    order_weight: 1200
  relationships:
  - name: ospf
    peer: RoutingOSPF
    label: OSPF
    kind: Parent
    cardinality: one
    optional: false
    identifier: ospf__ospfinterfaces
    order_weight: 900
  - name: interface
    peer: InterfaceLayer3
    kind: Attribute
    cardinality: one
    optional: false
    order_weight: 1500