module nokia-bof-conf {

    yang-version 1.1;

    namespace
      "urn:nokia.com:sros:ns:yang:sr:bof-conf";

    prefix bof-conf;

    import nokia-sros-yang-extensions {
      prefix sros-ext;
    }
    import nokia-types-port {
      prefix types-port;
    }
    import nokia-types-router {
      prefix types-router;
    }
    import nokia-types-sros {
      prefix types-sros;
    }

    organization "Nokia";

    contact
      "Nokia SR OS Support
         Web: <http://www.nokia.com>";

    description
      "Nokia YANG Data model to show state data on SR OS based routers.

         Copyright 2016 Nokia. All rights reserved. Reproduction of this document
         is authorized on the condition that the foregoing copyright notice is included.

         This nokia-bof-conf YANG module embodies Nokia's proprietary
         intellectual property. Nokia retains all title and ownership in the
         specification, including any revisions.

         Nokia grants all interested parties a non-exclusive license to use
         and distribute an unmodified copy of this specification in connection with
         management of Nokia products, and without fee, provided this
         copyright notice and license appear on all copies.

         This specification is supplied `as is', and Nokia makes no warranty,
         either express or implied, as to the use, operation, condition, or performance
         of the specification.";

    revision "2024-06-12";
    sros-ext:sros-major-release "rel24";

    container bof {
      description
        "Configure system boot options";
      container auto-boot {
        sros-ext:bof-parameter-effect "boot";
        presence
          "Enable the auto-boot context";
        description
          "Enable the auto-boot context";
        leaf port-mtu {
          sros-ext:bof-parameter-effect "boot";
          type uint32 {
            range "512..9800";
          }
          units "bytes";
          description "Port MTU setting";
        }

        leaf timeout {
          sros-ext:bof-parameter-effect "boot";
          type uint32 {
            range "30..1440";
          }
          units "minutes";
          description "ZTP timeout";
        }

        choice auto-boot-mode {
          default "dhcp";
          container dhcp {
            sros-ext:bof-parameter-effect "boot";
            presence
              "Enable the dhcp context";
            description
              "Enable the dhcp context";
            leaf client-id {
              sros-ext:bof-parameter-effect "boot";
              type union {
                type enumeration {
                  enum
                    "use-chassis-mac-address" {
                    value 0;
                  }
                }
                type types-sros:hex-string {
                  length "3..118";
                }
                type string {
                  length "1..58";
                }
              }
              description "DHCP client ID";
            }

            leaf management-port {
              sros-ext:bof-parameter-effect "boot";
              type boolean;
              default "true";
              description
                "Use auto boot on the management port";
            }

            leaf ipv4 {
              sros-ext:bof-parameter-effect "boot";
              type boolean;
              default "true";
              description
                "Use auto boot with IPv4";
            }

            leaf ipv6 {
              sros-ext:bof-parameter-effect "boot";
              type boolean;
              default "true";
              description
                "Use auto boot with IPv6";
            }

            leaf include-user-class {
              sros-ext:bof-parameter-effect "boot";
              type boolean;
              default "true";
              description
                "Include user class in auto boot provisioning";
            }

            container inband {
              sros-ext:bof-parameter-effect "boot";
              presence
                "Enable the inband context";
              description
                "Enable the inband context";
              choice inband-options {
                default "discovery-mode";
                leaf vlan {
                  sros-ext:bof-parameter-effect "boot";
                  type types-sros:vlan-id;
                  description
                    "In-band VLAN ID";
                }
                leaf vlan-discovery {
                  sros-ext:bof-parameter-effect "boot";
                  type boolean;
                  default "true";
                  description
                    "Use VLAN discovery";
                }
                leaf null-encapsulation {
                  sros-ext:bof-parameter-effect "boot";
                  type boolean;
                  default "true";
                  description
                    "Use null encapsulation";
                }
                leaf disabled {
                  sros-ext:bof-parameter-effect "boot";
                  type boolean;
                  default "true";
                  description
                    "Do not use in-band ports";
                }
              }  // choice inband-options
            }  // container inband
          }  // container dhcp
          container ospf {
            sros-ext:bof-parameter-effect "boot";
            presence
              "Enable the ospf context";
            description
              "Enable the ospf context";
            leaf neid {
              sros-ext:bof-parameter-effect "boot";
              type types-sros:hex-string {
                length "3";
              }
              description
                "Network element ID";
            }

            leaf neip-ipv4 {
              sros-ext:bof-parameter-effect "boot";
              type types-sros:ipv4-unicast-address;
              description
                "Network element IPv4 address";
            }

            leaf neip-ipv6 {
              sros-ext:bof-parameter-effect "boot";
              type types-sros:ipv6-address;
              description
                "Network element IPv6 address";
            }

            leaf mtu {
              sros-ext:bof-parameter-effect "boot";
              type types-router:ip-mtu-ext;
              units "bytes";
              default "1500";
              description "OSPF MTU";
            }

            leaf vendor-id {
              sros-ext:bof-parameter-effect "boot";
              type uint32 {
                range "1..254";
              }
              default "140";
              description "Vendor ID";
            }
          }  // container ospf
        }  // choice auto-boot-mode
      }  // container auto-boot

      container auto-configure {
        description
          "Enter the auto-configure context";
        container ipv4 {
          description
            "Enter the ipv4 context";
          container dhcp {
            sros-ext:bof-parameter-effect "boot";
            presence
              "Enable the dhcp context";
            description
              "Enable the dhcp context";
            leaf client-id {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "boot";
              type union {
                type types-sros:hex-string {
                  length "3..256";
                }
                type string {
                  length "1..127";
                }
              }
              description "DHCP client ID";
            }

            leaf include-user-class {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "boot";
              type boolean;
              description
                "Include user class information";
            }

            leaf timeout {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "boot";
              type uint32 {
                range "1..65535";
              }
              default "30";
              description "DHCP timeout";
            }
          }  // container dhcp
        }  // container ipv4

        container ipv6 {
          description
            "Enter the ipv6 context";
          container dhcp {
            sros-ext:bof-parameter-effect "boot";
            presence
              "Enable the dhcp context";
            description
              "Enable the dhcp context";
            leaf client-type {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "boot";
              type enumeration {
                enum "duid-enterprise" {
                  value 2;
                }
                enum "duid-link-local" {
                  value 3;
                }
              }
              description "DHCP client type";
            }

            leaf client-id {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "boot";
              type union {
                type types-sros:hex-string {
                  length "3..250";
                }
                type string {
                  length "1..124";
                }
              }
              description "DHCP client ID";
            }

            leaf include-user-class {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "boot";
              type boolean;
              description
                "Include user class information";
            }

            leaf timeout {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "boot";
              type uint32 {
                range "1..65535";
              }
              default "30";
              description "DHCP timeout";
            }
          }  // container dhcp
        }  // container ipv6
      }  // container auto-configure

      container configuration {
        description
          "Enter the configuration context";
        leaf primary-location {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:bof-cflash-and-url;
          description
            "Primary configuration location";
        }

        leaf secondary-location {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:bof-cflash-and-url;
          description
            "Secondary configuration location";
        }

        leaf tertiary-location {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:bof-cflash-and-url;
          description
            "Tertiary configuration location";
        }

        leaf encrypt {
          sros-ext:bof-parameter-effect "commit";
          type boolean;
          default "false";
          description
            "Enable encryption of BOF configuration files";
        }

        leaf encryption-key {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:encrypted-leaf {
            length "1..71";
          }
          description
            "Secret key for encryption of configuration files";
        }

        leaf password {
          sros-ext:bof-parameter-effect "boot";
          type types-sros:encrypted-leaf {
            length "1..71";
          }
          description
            "Password for boot-time modification of boot options";
        }
      }  // container configuration

      container console {
        description
          "Enter the console context";
        leaf speed {
          sros-ext:bof-parameter-effect "commit";
          type uint32 {
            range
              "9600|19200|38400|57600|115200";
          }
          units "bps";
          default "115200";
          description "Console port speed";
        }

        leaf wait-time {
          sros-ext:bof-parameter-effect "boot";
          type uint32 {
            range "1..10";
          }
          units "seconds";
          default "3";
          description
            "Wait time for interrupt to change boot parameters";
        }
      }  // container console

      container dns {
        description "Enter the dns context";
        leaf domain {
          sros-ext:bof-parameter-effect "commit";
          type string {
            length "1..178";
          }
          description
            "System DNS domain name for DNS address resolution";
        }

        leaf primary-server {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:ip-address;
          description "Primary DNS server";
        }

        leaf secondary-server {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:ip-address;
          description "Secondary DNS server";
        }

        leaf tertiary-server {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:ip-address;
          description "Tertiary DNS server";
        }
      }  // container dns

      container image {
        description
          "Enter the image context";
        leaf primary-location {
          sros-ext:bof-parameter-effect "boot";
          type types-sros:bof-cflash-and-url;
          description
            "Primary image location";
        }

        leaf secondary-location {
          sros-ext:bof-parameter-effect "boot";
          type types-sros:bof-cflash-and-url;
          description
            "Secondary image location";
        }

        leaf tertiary-location {
          sros-ext:bof-parameter-effect "boot";
          type types-sros:bof-cflash-and-url;
          description
            "Tertiary image location";
        }
      }  // container image

      container li {
        description "Enter the li context";
        leaf local-save {
          sros-ext:bof-parameter-effect "boot";
          type boolean;
          description
            "Save the LI configuration locally";
        }

        leaf separate {
          sros-ext:bof-parameter-effect "boot";
          type boolean;
          description
            "Separate access to the LI information";
        }
      }  // container li

      container license {
        description
          "Enter the license context";
        leaf primary-location {
          sros-ext:bof-parameter-effect "commit";
          type types-sros:bof-cflash-and-url;
          description
            "Primary license file location";
        }
      }  // container license

      list port {
        sros-ext:bof-parameter-effect "commit";
        key "router-name";
        max-elements 1;
        description
          "Enter the port list instance";
        leaf router-name {
          type types-sros:named-item-64 {
            pattern "management" {
              error-message
                "Only management is allowed for this router context";
            }
          }
          description
            "Administrative router name";
        }

        leaf autonegotiate {
          sros-ext:bof-parameter-effect "commit";
          type enumeration {
            enum "false" {
              value 0;
            }
            enum "true" {
              value 1;
            }
          }
          default "true";
          description
            "Auto-negotiate speed and duplex type on Ethernet port";
        }

        leaf duplex {
          sros-ext:bof-parameter-effect "commit";
          type types-port:duplex-mode;
          default "full";
          description
            "Duplex type for the Ethernet port";
        }

        leaf speed {
          sros-ext:bof-parameter-effect "commit";
          type uint32 {
            range "10|100|1000";
          }
          units "megabps";
          default "100";
          description
            "Speed of the Ethernet port";
        }
      }  // list port

      list router {
        sros-ext:bof-parameter-effect "commit";
        key "router-name";
        max-elements 1;
        description
          "Enter the router list instance";
        leaf router-name {
          type types-sros:named-item-64 {
            pattern "management" {
              error-message
                "Only management is allowed for this router context";
            }
          }
          description
            "Administrative router name";
        }

        list interface {
          sros-ext:bof-parameter-effect "commit";
          key "interface-name";
          max-elements 1;
          description
            "Enter the interface list instance";
          leaf interface-name {
            type types-sros:interface-name {
              pattern "management" {
                error-message
                  "Only management is allowed for this router context";
              }
            }
            description
              "Router interface name";
          }

          leaf ip-mtu {
            sros-ext:bof-parameter-effect "commit";
            type types-router:ip-mtu-ext;
            units "bytes";
            description "Interface IP MTU";
          }

          list cpm {
            sros-ext:bof-parameter-effect "commit";
            key "cpm-type";
            description
              "Enter the cpm list instance";
            leaf cpm-type {
              type enumeration {
                enum "active" {
                  value 0;
                }
                enum "standby" {
                  value 1;
                }
                enum "a" {
                  value 2;
                }
                enum "b" {
                  value 3;
                }
                enum "c" {
                  value 4;
                }
                enum "d" {
                  value 5;
                }
              }
              description "CPM type";
            }

            container ipv4 {
              sros-ext:bof-parameter-effect "commit";
              presence
                "Enable the ipv4 context";
              description
                "Enable the ipv4 context";
              leaf ip-address {
                sros-ext:bof-parameter-effect "commit";
                type types-sros:ipv4-unicast-address;
                mandatory true;
                description
                  "IPv4 address assigned to the interface";
              }

              leaf prefix-length {
                sros-ext:bof-parameter-effect "commit";
                type uint32 {
                  range "0..32";
                }
                mandatory true;
                description
                  "IPv4 address prefix length";
              }
            }  // container ipv4

            container ipv6 {
              sros-ext:bof-parameter-effect "commit";
              presence
                "Enable the ipv6 context";
              description
                "Enable the ipv6 context";
              leaf ipv6-address {
                sros-ext:bof-parameter-effect "commit";
                type types-sros:ipv6-address;
                description
                  "IPv6 address assigned to the interface";
              }

              leaf prefix-length {
                sros-ext:bof-parameter-effect "commit";
                type uint32 {
                  range "0..128";
                }
                mandatory true;
                description
                  "IPv6 address prefix length";
              }
            }  // container ipv6
          }  // list cpm
        }  // list interface

        container static-routes {
          description
            "Enter the static-routes context";
          list route {
            sros-ext:bof-parameter-effect "commit";
            key "ip-prefix";
            description
              "Enter the route list instance";
            leaf ip-prefix {
              type types-sros:ip-prefix;
              description
                "IP prefix for the static route";
            }

            leaf next-hop {
              sros-ext:immutable;
              sros-ext:bof-parameter-effect "commit";
              type types-sros:ip-address;
              mandatory true;
              description
                "Next-hop IP address";
            }
          }  // list route
        }  // container static-routes
      }  // list router

      container system {
        description
          "Enter the system context";
        leaf base-mac-address {
          sros-ext:bof-parameter-effect "boot";
          type types-sros:mac-unicast-address;
          description
            "Base system MAC address";
        }

        leaf fips-140-2 {
          sros-ext:bof-parameter-effect "boot";
          type boolean;
          status obsolete;
          description
            "Operate in FIPS 140-2 mode";
        }

        leaf fips-140 {
          sros-ext:bof-parameter-effect "boot";
          type boolean;
          default "false";
          description "Operate in FIPS mode";
        }

        leaf persistent-indices {
          sros-ext:bof-parameter-effect "boot";
          type boolean;
          description
            "Classic and mixed management mode persistent indices";
        }

        leaf profile {
          sros-ext:bof-parameter-effect "boot";
          type enumeration {
            enum "profile-a" {
              value 1;
            }
            enum "profile-b" {
              value 2;
            }
          }
          description
            "System capabilities profile";
        }
      }  // container system
    }  // container bof
  }  // module nokia-bof-conf