module dell-base-neighbor {

    yang-version 1;

    namespace
      "http://www.dellemc.com/networking/os10/dell-base-neighbor";

    prefix base-neighbor;

    import dell-base-common {
      prefix base-cmn;
    }
    import ietf-interfaces {
      prefix if;
    }
    import dell-base-routing {
      prefix base-route;
    }

    organization "Dell EMC";

    contact "http://www.dell.com/support";

    description
      "This model contains a collection of attributes and RPCs used for
        managing the switch neighbors.

        Copyright (c) 2015-2019 by Dell EMC, All rights reserved.";

    revision "2018-08-17" {
      description
        "Fixing pyang IETF errors and adding documentation to the model.";
      reference
        "Network Platform Abstraction";

    }

    revision "2018-07-03" {
      description
        "This revision replaces the interface name with list of interface names in the neighbor flush RPC.";
      reference
        "Network Platform Abstraction";

    }

    revision "2018-01-31" {
      description
        "This revision adds the IP prefix in the neighbor flush RPC.";
      reference
        "Network Platform Abstraction";

    }

    revision "2017-10-16" {
      description
        "This revision adds the auto neighbor refresh configuration.";
      reference
        "Network Platform Abstraction";

    }

    revision "2017-10-09" {
      description
        "This revision adds the vrf-name in the flush RPC.";
      reference
        "Network Platform Abstraction";

    }

    revision "2017-03-13" {
      description
        "Clear neighbor functionality";
      reference
        "Network Platform Abstraction";

    }

    revision "2016-11-03" {
      description "Initial revision.";
      reference
        "Network Platform Abstraction";

    }


    augment /base-route:obj/base-route:nbr {
      description
        "Extending the neighbor object with Dell proprietary attributes";
      leaf phy_ifindex {
        type base-cmn:logical-ifindex;
        description
          "Incase of VLAN IP routing, this holds the physical interface through which the MAC is learnt.";
      }
    }

    augment /if:interfaces-state/if:interface {
      description
        "Extending the interface object with Dell proprietary attributes";
      leaf if-index {
        type base-cmn:logical-ifindex;
        description
          "Flush the neighbor entries configured/learnt on this interface";
      }
    }

    rpc flush {
      description
        "Flush the Neighbor entries for given input per Interface or AF or neighbor address/prefix";
      input {
        leaf vrf-id {
          type uint32;
          default '0';
          status obsolete;
          description "VRF ID";
        }

        leaf vrf-name {
          type string;
          mandatory true;
          description "VRF device name";
        }

        leaf af {
          type base-cmn:af-type;
          default "inet";
          description
            "Address Family of the Neighbor entries to be cleared";
        }

        leaf-list ifname {
          type string;
          description
            "Flush the Neighbor entries configured/learnt on list of interfaces.";
        }

        leaf ip {
          type base-cmn:ip-address;
          description
            "Neighbor address/prefix to be flushed.
               Prefix & prefix-len are specified to flush all neighbors in that subnet.";
        }

        leaf prefix-len {
          type uint32;
          description
            "Prefix length of neighbors in the subnet to be flushed.";
        }
      }
    }  // rpc flush

    list auto-nbr-refresh {
      key "vrf-name af";
      description
        "This controls whether or not the auto neighbor refresh is enabled
            for the neighbor.";
      leaf vrf-name {
        type string;
        description "VRF device name";
      }

      leaf af {
        type base-cmn:af-type;
        description "Address Family";
      }

      leaf enable {
        type boolean;
        default 'true';
        description
          "This is set to true to enable auto neighbor refresh upon neighbor
                age-out and false otherwise.";
      }

      leaf hw-mac-learn-enable {
        type boolean;
        default 'true';
        description
          "This is set to true to enable auto neighbor refresh
                when the associated MAC is not learnt in the HW and false otherwise.";
      }
    }  // list auto-nbr-refresh
  }  // module dell-base-neighbor