Skip to main content

Routing PIM

This schema extension contains all you need to model the PIM Protocol.

Details

Nodes

PIM

  • Label: PIM
  • Description: Protocol Independent Multicast (PIM) instance on a Virtual Router.
  • Namespace: Routing
  • Icon: mdi:network-outline
  • Display Labels: description__value
  • Uniqueness Constraints:
    • device, vrf
  • Human Friendly ID: device__name__value, vrf__name__value
  • Inherit From: RoutingProtocol

Attributes

namedescriptionkindoptionaldefault_valuechoices
dr_priorityDesignated Router priority.NumberTrue1
import_policiesTextTrue
export_policiesTextTrue

Relationships

namepeeroptionalcardinalitykind
rp_addressIpamIPAddressTrueoneAttribute
pim_interfacesRoutingPIMInterfaceTruemanyComponent

PIMInterface

  • Label: PIM Interface
  • Description: Interface configuration for PIM.
  • Namespace: Routing
  • Icon: mdi:ethernet
  • Display Labels: description__value
  • Uniqueness Constraints:
    • pim, interface
  • Human Friendly ID: description__value

Attributes

namedescriptionkindoptionaldefault_valuechoices
descriptionDescription of the OSPF interface.TextFalse
pim_modePIM mode used for multicast routing on this interface.Dropdownsparse, dense, bidirectional
hello_intervalInterval for PIM hello messages (in seconds).NumberTrue30
dr_priorityDesignated Router priority on the interface.NumberTrue1

Relationships

namepeeroptionalcardinalitykind
pimRoutingPIMFalseoneParent
interfaceInterfaceLayer3FalseoneAttribute

Code

version: '1.0'
nodes:
- name: PIM
namespace: Routing
description: Protocol Independent Multicast (PIM) instance on a Virtual Router.
label: PIM
icon: mdi:network-outline
include_in_menu: false
inherit_from:
- RoutingProtocol
order_by:
- vrf__name__value
- device__name__value
uniqueness_constraints:
- - device
- vrf
human_friendly_id:
- device__name__value
- vrf__name__value
display_labels:
- description__value
attributes:
- name: dr_priority
kind: Number
optional: true
default_value: 1
description: Designated Router priority.
order_weight: 1250
- name: import_policies
kind: Text
optional: true
order_weight: 1300
- name: export_policies
kind: Text
optional: true
order_weight: 1350
relationships:
- name: rp_address
peer: IpamIPAddress
optional: true
description: Rendezvous Point (RP) address for PIM.
cardinality: one
kind: Attribute
- name: pim_interfaces
label: PIM Interfaces
peer: RoutingPIMInterface
identifier: pim__piminterfaces
optional: true
cardinality: many
kind: Component
- name: PIMInterface
namespace: Routing
description: Interface configuration for PIM.
label: PIM Interface
icon: mdi:ethernet
include_in_menu: false
order_by:
- description__value
display_labels:
- description__value
uniqueness_constraints:
- - pim
- interface
human_friendly_id:
- description__value
attributes:
- name: description
kind: Text
optional: false
unique: true
description: Description of the OSPF interface.
order_weight: 1100
- name: pim_mode
kind: Dropdown
choices:
- name: sparse
label: Sparse Mode
description: Sparse Mode for efficient multicast forwarding.
color: '#E6E6FA'
- name: dense
label: Dense Mode
description: Dense Mode for heavy multicast traffic.
color: '#E6E6FA'
- name: bidirectional
label: Bidirectional Mode
description: Bidirectional PIM for efficient traffic forwarding.
color: '#E6E6FA'
description: PIM mode used for multicast routing on this interface.
order_weight: 1150
- name: hello_interval
kind: Number
optional: true
default_value: 30
description: Interval for PIM hello messages (in seconds).
order_weight: 1300
- name: dr_priority
kind: Number
optional: true
default_value: 1
description: Designated Router priority on the interface.
order_weight: 1250
relationships:
- name: pim
label: PIM
peer: RoutingPIM
identifier: pim__piminterfaces
optional: false
cardinality: one
kind: Parent
- name: interface
peer: InterfaceLayer3
optional: false
cardinality: one
kind: Attribute
order_weight: 1200