module ietf-ipv6-unicast-routing {

    yang-version 1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing";

    prefix v6ur;

    import ietf-routing {
      prefix rt;
    }
    import ietf-inet-types {
      prefix inet;
    }
    import ietf-interfaces {
      prefix if;
    }
    import ietf-ip {
      prefix ip;
    }

    organization
      "IETF NETMOD (NETCONF Data Modeling Language) Working Group";

    contact
      "WG Web:   <http://tools.ietf.org/wg/netmod/>
        WG List:  <mailto:netmod@ietf.org>

        WG Chair: Thomas Nadeau
                  <mailto:tnadeau@lucidvision.com>

        WG Chair: Juergen Schoenwaelder
                  <mailto:j.schoenwaelder@jacobs-university.de>

        Editor:   Ladislav Lhotka
                  <mailto:lhotka@nic.cz>";

    description
      "This YANG module augments the 'ietf-routing' module with basic
        configuration and state data for IPv6 unicast routing.

        Copyright (c) 2014 IETF Trust and the persons identified as
        authors of the code. All rights reserved.

        Redistribution and use in source and binary forms, with or
        without modification, is permitted pursuant to, and subject to
        the license terms contained in, the Simplified BSD License set
        forth in Section 4.c of the IETF Trust's Legal Provisions
        Relating to IETF Documents
        (http://trustee.ietf.org/license-info).

        The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
        NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
        'OPTIONAL' in the module text are to be interpreted as described
        in RFC 2119 (http://tools.ietf.org/html/rfc2119).

        This version of this YANG module is part of RFC XXXX
        (http://tools.ietf.org/html/rfcXXXX); see the RFC itself for
        full legal notices.";

    revision "2015-05-25" {
      description "Initial revision.";
      reference
        "RFC XXXX: A YANG Data Model for Routing Management";

    }


    identity ipv6-unicast {
      base rt:ipv6;
      description
        "This identity represents the IPv6 unicast address family.";
    }

    augment /if:interfaces/if:interface/ip:ipv6 {
      description
        "Augment interface configuration with IPv6-specific parameters
          of router interfaces.";
      container ipv6-router-advertisements {
        description
          "Configuration of IPv6 Router Advertisements.";
        leaf send-advertisements {
          type boolean;
          default "false";
          description
            "A flag indicating whether or not the router sends periodic
              Router Advertisements and responds to Router
              Solicitations.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvSendAdvertisements.";

        }

        leaf max-rtr-adv-interval {
          type uint16 {
            range "4..1800";
          }
          units "seconds";
          default "600";
          description
            "The maximum time allowed between sending unsolicited
              multicast Router Advertisements from the interface.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            MaxRtrAdvInterval.";

        }

        leaf min-rtr-adv-interval {
          type uint16 {
            range "3..1350";
          }
          units "seconds";
          must
            ". <= 0.75 * ../max-rtr-adv-interval" {
            description
              "The value MUST NOT be greater than 75 % of
                'max-rtr-adv-interval'.";
          }
          description
            "The minimum time allowed between sending unsolicited
              multicast Router Advertisements from the interface.

              The default value to be used operationally if this leaf is
              not configured is determined as follows:

              - if max-rtr-adv-interval >= 9 seconds, the default value
                is 0.33 * max-rtr-adv-interval;

              - otherwise it is 0.75 * max-rtr-adv-interval.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            MinRtrAdvInterval.";

        }

        leaf managed-flag {
          type boolean;
          default "false";
          description
            "The value to be placed in the 'Managed address
              configuration' flag field in the Router Advertisement.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvManagedFlag.";

        }

        leaf other-config-flag {
          type boolean;
          default "false";
          description
            "The value to be placed in the 'Other configuration' flag
              field in the Router Advertisement.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvOtherConfigFlag.";

        }

        leaf link-mtu {
          type uint32;
          default "0";
          description
            "The value to be placed in MTU options sent by the router.
              A value of zero indicates that no MTU options are sent.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvLinkMTU.";

        }

        leaf reachable-time {
          type uint32 {
            range "0..3600000";
          }
          units "milliseconds";
          default "0";
          description
            "The value to be placed in the Reachable Time field in the
              Router Advertisement messages sent by the router. A value
              of zero means unspecified (by this router).";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvReachableTime.";

        }

        leaf retrans-timer {
          type uint32;
          units "milliseconds";
          default "0";
          description
            "The value to be placed in the Retrans Timer field in the
              Router Advertisement messages sent by the router. A value
              of zero means unspecified (by this router).";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvRetransTimer.";

        }

        leaf cur-hop-limit {
          type uint8;
          description
            "The value to be placed in the Cur Hop Limit field in the
              Router Advertisement messages sent by the router. A value
              of zero means unspecified (by this router).

              If this parameter is not configured, the device SHOULD use
              the value specified in IANA Assigned Numbers that was in
              effect at the time of implementation.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvCurHopLimit.
            IANA: IP Parameters,
            http://www.iana.org/assignments/ip-parameters";

        }

        leaf default-lifetime {
          type uint16 {
            range "0..9000";
          }
          units "seconds";
          description
            "The value to be placed in the Router Lifetime field of
              Router Advertisements sent from the interface, in seconds.
              It MUST be either zero or between max-rtr-adv-interval and
              9000 seconds. A value of zero indicates that the router is
              not to be used as a default router. These limits may be
              overridden by specific documents that describe how IPv6
              operates over different link layers.

              If this parameter is not configured, the device SHOULD use
              a value of 3 * max-rtr-adv-interval.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvDefaultLifeTime.";

        }

        container prefix-list {
          description
            "Configuration of prefixes to be placed in Prefix
              Information options in Router Advertisement messages sent
              from the interface.

              Prefixes that are advertised by default but do not have
              their entries in the child 'prefix' list are advertised
              with the default values of all parameters.

              The link-local prefix SHOULD NOT be included in the list
              of advertised prefixes.";
          reference
            "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
            AdvPrefixList.";

          list prefix {
            key "prefix-spec";
            description
              "Configuration of an advertised prefix entry.";
            leaf prefix-spec {
              type inet:ipv6-prefix;
              description
                "IPv6 address prefix.";
            }

            choice control-adv-prefixes {
              default "advertise";
              description
                "The prefix either may be explicitly removed from the
                  set of advertised prefixes, or parameters with which
                  it is advertised may be specified (default case).";
              leaf no-advertise {
                type empty;
                description
                  "The prefix will not be advertised.

                    This can be used for removing the prefix from the
                    default set of advertised prefixes.";
              }

              case advertise {
                leaf valid-lifetime {
                  type uint32;
                  units "seconds";
                  default "2592000";
                  description
                    "The value to be placed in the Valid Lifetime in
                      the Prefix Information option. The designated
                      value of all 1's (0xffffffff) represents
                      infinity.";
                  reference
                    "RFC 4861: Neighbor Discovery for IP version 6
                    (IPv6) - AdvValidLifetime.";

                }

                leaf on-link-flag {
                  type boolean;
                  default "true";
                  description
                    "The value to be placed in the on-link flag
                      ('L-bit') field in the Prefix Information
                      option.";
                  reference
                    "RFC 4861: Neighbor Discovery for IP version 6
                    (IPv6) - AdvOnLinkFlag.";

                }

                leaf preferred-lifetime {
                  type uint32;
                  units "seconds";
                  must
                    ". <= ../valid-lifetime" {
                    description
                      "This value MUST NOT be greater than
                        valid-lifetime.";
                  }
                  default "604800";
                  description
                    "The value to be placed in the Preferred Lifetime
                      in the Prefix Information option. The designated
                      value of all 1's (0xffffffff) represents
                      infinity.";
                  reference
                    "RFC 4861: Neighbor Discovery for IP version 6
                    (IPv6) - AdvPreferredLifetime.";

                }

                leaf autonomous-flag {
                  type boolean;
                  default "true";
                  description
                    "The value to be placed in the Autonomous Flag
                      field in the Prefix Information option.";
                  reference
                    "RFC 4861: Neighbor Discovery for IP version 6
                    (IPv6) - AdvAutonomousFlag.";

                }
              }  // case advertise
            }  // choice control-adv-prefixes
          }  // list prefix
        }  // container prefix-list
      }  // container ipv6-router-advertisements
    }

    augment /rt:routing/rt:routing-instance/rt:routing-protocols/rt:routing-protocol/rt:static-routes {
      description
        "This augment defines the configuration of the 'static'
          pseudo-protocol with data specific to IPv6 unicast.";
      container ipv6 {
        description
          "Configuration of a 'static' pseudo-protocol instance
            consists of a list of routes.";
        list route {
          key "destination-prefix";
          ordered-by user;
          description
            "A user-ordered list of static routes.";
          leaf destination-prefix {
            type inet:ipv6-prefix;
            mandatory true;
            description
              "IPv6 destination prefix.";
          }

          leaf description {
            type string;
            description
              "Textual description of the route.";
          }

          container next-hop {
            description
              "Configuration of next-hop.";
            uses rt:next-hop-content {
              augment next-hop-options {
                description
                  "Add next-hop address case.";
                leaf next-hop-address {
                  type inet:ipv6-address;
                  description
                    "IPv6 address of the next-hop.";
                }
              }
            }
          }  // container next-hop
        }  // list route
      }  // container ipv6
    }

    augment /rt:fib-route/rt:input/rt:destination-address {
      when
        "rt:address-family='v6ur:ipv6-unicast'" {
        description
          "This augment is valid only for IPv6 unicast.";
      }
      description
        "This leaf augments the 'rt:destination-address' parameter of
          the 'rt:fib-route' operation.";
      leaf address {
        type inet:ipv6-address;
        description
          "IPv6 destination address.";
      }
    }

    augment /rt:fib-route/rt:output/rt:route {
      when
        "rt:address-family='v6ur:ipv6-unicast'" {
        description
          "This augment is valid only for IPv6 unicast.";
      }
      description
        "This leaf augments the reply to the 'rt:fib-route'
          operation.";
      leaf destination-prefix {
        type inet:ipv6-prefix;
        description
          "IPv6 destination prefix.";
      }
    }

    augment /rt:fib-route/rt:output/rt:route/rt:next-hop/rt:next-hop-options/rt:simple-next-hop {
      when
        "../rt:address-family='v6ur:ipv6-unicast'" {
        description
          "This augment is valid only for IPv6 unicast.";
      }
      description
        "This leaf augments the 'simple-next-hop' case in the reply to
          the 'rt:fib-route' operation.";
      leaf next-hop-address {
        type inet:ipv6-address;
        description
          "IPv6 address of the next-hop.";
      }
    }
  }  // module ietf-ipv6-unicast-routing