Skip to content
Network as Code

Service Object Tracker Feature

Configure Service Object Tracker for interface, SIG or route.

Diagram

Section titled “Diagram”
Diagram

Classes

Section titled “Classes”

sdwan

Section titled “sdwan”
NameTypeConstraintMandatoryDefault Value
feature_profilesClassfeature_profilesNo

feature_profiles (sdwan)

Section titled “feature_profiles (sdwan)”
NameTypeConstraintMandatoryDefault Value
service_profilesListservice_profilesNo

service_profiles (sdwan.feature_profiles)

Section titled “service_profiles (sdwan.feature_profiles)”
NameTypeConstraintMandatoryDefault Value
object_trackersListobject_trackersNo

object_trackers (sdwan.feature_profiles.service_profiles)

Section titled “object_trackers (sdwan.feature_profiles.service_profiles)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
idIntegermin: 1, max: 1000No
id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
interface_nameStringRegex: (ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)No
interface_name_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
route_ipIPNo
route_ip_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
route_maskChoice255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.248.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0No
route_mask_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
typeChoiceinterface, sig, routeYes
vpn_idIntegermin: 0, max: 65530No
vpn_id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No

object_trackers (sdwan.feature_profiles.service_profiles)

Section titled “object_trackers (sdwan.feature_profiles.service_profiles)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
idIntegermin: 1, max: 1000No
id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
interface_nameStringRegex: (ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)No
interface_name_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
route_ipIPNo
route_ip_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
route_maskChoice255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0No
route_mask_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No
typeChoiceinterface, sig, routeYes
vpn_idIntegermin: 0, max: 65530No
vpn_id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,128}$No

object_trackers (sdwan.feature_profiles.service_profiles)

Section titled “object_trackers (sdwan.feature_profiles.service_profiles)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
idIntegermin: 1, max: 1000No
id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
interface_nameStringRegex: ^(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)$No
interface_name_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_ipIPNo
route_ip_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_maskChoice255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0No
route_mask_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
typeChoiceinterface, sig, routeYes
vpn_idIntegermin: 0, max: 65530No
vpn_id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

Examples

Section titled “Examples”

Example-1: Automated WAN Route Monitoring for Branch Connectivity

A financial institution operates multiple branch offices connected to the main data center through SD-WAN. To ensure seamless connectivity and proactive failure detection, the IT team needs to track the reachability of key WAN routes. By using object_trackers, the institution can monitor a specific route within a VPN (vpn_id: 10), checking its availability dynamically. If the route to the data center (192.168.100.0/24) becomes unreachable, the SD-WAN system can trigger failover mechanisms, such as switching traffic to a backup path. This setup enhances network resilience by ensuring continuous access to critical banking applications.

This YAML defines an object_tracker within a service profile named BRANCH-WAN-MONITORING. The configuration does the following: Defines a tracker (DC-ROUTE-TRACKER) to monitor the reachability of the 192.168.100.0/24 route, Uses type: route, meaning it specifically tracks network reachability rather than an interface or SIG. Assigns vpn_id: 10, ensuring the monitoring occurs within the correct SD-WAN VPN instance, Uses id: 101, a unique identifier for this tracker within the system.

By implementing this configuration, the financial institution can dynamically track WAN connectivity status and respond to failures by rerouting traffic or triggering alerts, ensuring high availability of critical banking services.

sdwan:
  feature_profiles:
    service_profiles:
      - name: BRANCH-WAN-MONITORING
        description: Object tracker for WAN route monitoring in VPN 10
        object_trackers:
          - name: DC-ROUTE-TRACKER
            description: Monitors reachability of data center route
            id: 101
            type: route
            route_ip: 192.168.100.0
            route_mask: 255.255.255.0
            vpn_id: 10