OSPF version2

module ospf {
  yang-version 1.1;
  namespace "http://example.com/ospf";
  prefix ospf;

  import ietf-inet-types { prefix inet; }
  import tailf-ncs { prefix ncs; }

  description "An OSPF configuration service for Cisco IOS-XR devices.";

  revision 2025-08-14 {
    description "Refactored to use common process-id and area-id per service.";
  }
  revision 2025-08-01 {
    description "Made area-id mandatory and reworked interface input to type + name.";
  }

  list ospf-service {
    key name;
    uses ncs:service-data;
    ncs:servicepoint "ospf-servicepoint";

    leaf name {
      type string;
    }

    leaf process-id {
      type uint16 { range "1..65535"; }
      mandatory true;
    }

    list area {
      key "area-id";
      leaf area-id {
        type uint32;
      }

      list endpoint {
        key device;

        leaf device {
          type leafref {
            path "/ncs:devices/ncs:device/ncs:name";
          }
        }

        leaf router-id {
          type inet:ipv4-address;
          description "Optional device-specific router-id for this area context.";
        }

        list interface {
          key "interface-type interface-name";
          description "Interfaces on this device to enable for this OSPF area.";

          leaf interface-type {
            type enumeration {
              enum "GigabitEthernet";
              enum "TenGigE";
              enum "HundredGigE";
              enum "Loopback";
            }
            mandatory true;
          }

          leaf interface-name {
            type string;
            mandatory true;
          }

          leaf is-passive {
            type boolean;
            mandatory true;
          }
        }
      }
    }
  }
}

# -*- mode: python; python-indent: 4 -*-
import ncs
from ncs.application import Service, Application

class ServiceCallbacks(Service):
    @Service.create
    def cb_create(self, tctx, root, service, proplist):
        self.log.info(f"OSPF Service create called for: {service.name}")
        template = ncs.template.Template(service)

        common_process_id = service.process_id
        
        applied_devices = set()

        for area_item in service.area:
            area_id = area_item.area_id
            
            for endpoint_item in area_item.endpoint:
                device_name = endpoint_item.device

                if device_name not in applied_devices:
                    self.log.info(f"Applying OSPF base config for device: {device_name}")
                    base_vars = ncs.template.Variables()
                    base_vars.add('device', device_name)
                    base_vars.add('process_id', common_process_id)
                    
                    if endpoint_item.router_id:
                        base_vars.add('router_id', endpoint_item.router_id)
                    else:
                        base_vars.add('router_id', '')
                    template.apply('ospf-base-template', base_vars)
                    applied_devices.add(device_name)

                for interface_item in endpoint_item.interface:
                    full_interface_name = f"{interface_item.interface_type}{interface_item.interface_name}"
                    self.log.info(f"Configuring interface: {full_interface_name} on device {device_name} in area {area_id}")

                    interface_vars = ncs.template.Variables()
                    interface_vars.add('device', device_name)
                    interface_vars.add('process_id', common_process_id)
                    interface_vars.add('area_id', area_id)
                    interface_vars.add('interface_name', full_interface_name) 

                    if interface_item.is_passive:
                        interface_vars.add('is_passive', 'true')
                    else:
                        interface_vars.add('is_passive', '')
    
                    template.apply('ospf-area-interface-template', interface_vars)

class Ospf(Application):
    def setup(self):
        self.log.info('OSPF Application RUNNING')
        self.register_service('ospf-servicepoint', ServiceCallbacks)

    def teardown(self):
        self.log.info('OSPF Application FINISHED')

<config xmlns="http://tail-f.com/ns/config/1.0"
                 xmlns:cisco-ios-xr="http://tail-f.com/ned/cisco-ios-xr">
  <devices xmlns="http://tail-f.com/ns/ncs">
    <device>
      <name>{$device}</name>
      <config>
        <router xmlns="http://tail-f.com/ned/cisco-ios-xr">
          <ospf>
            <name>{$process_id}</name>
            <?if {$router_id}?>
              <router-id>{$router_id}</router-id>
            <?end?>
          </ospf>
        </router>
      </config>
    </device>
  </devices>
</config>

<config xmlns="http://tail-f.com/ns/config/1.0">
  <devices xmlns="http://tail-f.com/ns/ncs">
    <device>
      <name>{$device}</name>
      <config>
        <router xmlns="http://tail-f.com/ned/cisco-ios-xr">
          <ospf>
            <name>{$process_id}</name>
            <area>
              <id>{$area_id}</id>
              <interface>
                <name>{$interface_name}</name>
                <?if {$is_passive}?>
                  <passive>
                    <mode>enable</mode>
                  </passive>
                <?end?>
              </interface>
            </area>
          </ospf>
        </router>
      </config>
    </device>
  </devices>
</config>