Switch OSPF Routing Configuration

Dashboard Location: Switching > Configure > OSPF Routing

Dynamic Routing Protocol Management

Switch OSPF (Open Shortest Path First) routing configuration in Meraki networks provides administrators with the capability to implement dynamic routing protocols for intelligent path selection, network convergence, and scalable multi-area network topologies. This functionality enables automatic route discovery, load balancing across multiple paths, network redundancy, and simplified network management through link-state routing protocols. OSPF routing is essential for large-scale network deployments, multi-site connectivity, advanced traffic engineering, and maintaining optimal network performance through dynamic route computation.

Diagram

Classes

switch (meraki.domains.organizations.networks)

Name	Type	Constraint	Mandatory	Default Value
routing_ospf	Class	`[routing_ospf]`	No

routing_ospf (meraki.domains.organizations.networks.switch)

Name	Type	Constraint	Mandatory
enabled	Boolean	`true`, `false`	No
hello_timer_in_seconds	Integer	min: `1`, max: `65535`	No
dead_timer_in_seconds	Integer	min: `1`, max: `65535`	No
areas	List	`[areas]`	No
v3	Class	`[v3]`	No
md5_authentication_key	Class	`[md5_authentication_key]`	No
md5_authentication	Boolean	`true`, `false`	No

areas (meraki.domains.organizations.networks.switch.routing_ospf)

Name	Type	Constraint	Mandatory
area_id	Any	String[min: `1`, max: `13`] or IP or Integer[min: `1`, max: `4294967295`]	Yes
area_name	String	min: `1`, max: `127`	Yes
area_type	Choice	`normal`, `nssa`, `stub`	Yes

v3 (meraki.domains.organizations.networks.switch.routing_ospf)

Name	Type	Constraint	Mandatory
enabled	Boolean	`true`, `false`	No
hello_timer_in_seconds	Integer	min: `1`, max: `65535`	No
dead_timer_in_seconds	Integer	min: `1`, max: `65535`	No
areas	List	`[areas]`	No

md5_authentication_key (meraki.domains.organizations.networks.switch.routing_ospf)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `1234`	No
passphrase	String	min: `1`, max: `127`	No

areas (meraki.domains.organizations.networks.switch.routing_ospf.v3)

Name	Type	Constraint	Mandatory
area_id	Any	String[min: `1`, max: `13`] or IP or Integer[min: `1`, max: `4294967295`]	Yes
area_name	String	min: `1`, max: `127`	Yes
area_type	Choice	`normal`, `nssa`, `stub`	Yes

Examples

Example-1: The example below demonstrates switch OSPF routing configuration using tested YAML configuration from pipeline fixtures.

meraki:
  domains:
    - name: "!env domain"
      administrator:
        name: "!env org_admin"
      organizations:
        - name: "!env org"
          networks:
            - name: "!env network_name"
              product_types:
                - appliance
                - switch
                - wireless
                - camera
                - sensor
                - cellularGateway
              switch:
                routing_ospf:
                  enabled: true
                  hello_timer_in_seconds: 10
                  dead_timer_in_seconds: 30
                  areas:
                    - area_id: "0"
                      area_name: BACKBONE
                      area_type: normal
                    - area_id: "20"
                      area_name: branch1
                      area_type: normal
                  v3:
                    enabled: false
                    hello_timer_in_seconds: 30
                    dead_timer_in_seconds: 60
                  md5_authentication: true
                  md5_authentication_key:
                    id: 1
                    passphrase: "!env ospf_auth_key"

Configuration Parameters

Parameter	Type	Required	Description
`routing_ospf`	Object	No	OSPF routing configuration
`routing_ospf.enabled`	Boolean	Yes	Enable/disable OSPF routing
`routing_ospf.hello_timer_in_seconds`	Integer	Yes	Hello packet interval (1-255 seconds)
`routing_ospf.dead_timer_in_seconds`	Integer	Yes	Dead interval timer (1-65535 seconds)
`routing_ospf.areas`	Array	Yes	OSPF area definitions
`routing_ospf.areas[n].area_id`	String	Yes	OSPF area ID (0-4294967295 or dotted decimal)
`routing_ospf.areas[n].area_name`	String	Yes	Descriptive name for the area
`routing_ospf.areas[n].area_type`	String	Yes	Area type: “normal”, “stub”, “nssa”
`routing_ospf.v3`	Object	No	OSPFv3 (IPv6) configuration
`routing_ospf.v3.enabled`	Boolean	Yes	Enable/disable OSPFv3
`routing_ospf.v3.hello_timer_in_seconds`	Integer	Yes	OSPFv3 hello interval (1-255 seconds)
`routing_ospf.v3.dead_timer_in_seconds`	Integer	Yes	OSPFv3 dead interval (1-65535 seconds)
`routing_ospf.md5_authentication`	Boolean	No	Enable MD5 authentication
`routing_ospf.md5_authentication_key`	Object	Conditional	Authentication key (required if authentication enabled)
`routing_ospf.md5_authentication_key.id`	Integer	Yes	Key ID (1-255)
`routing_ospf.md5_authentication_key.passphrase`	String	Yes	Authentication passphrase