l3.proto

syntax = "proto3";

package l3;

/* Static routes */
message StaticRoutes {
    message Route {
        enum RouteType {
            INTRA_VRF = 0;                   /* Forwarding is being done in the specified vrf_id only, or according to
                                                the specified outgoing interface. */
            INTER_VRF = 1;                   /* Forwarding is being done by lookup into a different VRF,
                                                specified as via_vrf_id field. In case of these routes, the outgoing
                                                interface should not be specified. The next hop IP address
                                                does not have to be specified either, in that case VPP does full
                                                recursive lookup in the via_vrf_id VRF. */
            DROP = 2;                        /* Drops the network communication designated for specific IP address */
        }
        RouteType type = 10;
        uint32 vrf_id = 1;                   /* VRF identifier, field required for remote client. This value should be
                                                consistent with VRF ID in static route key. If it is not, value from
                                                key will be preffered and this field will be overriden.  */
        string description = 2;              /* optional description */
        string dst_ip_addr = 3;              /* ip address + prefix in format <address>/<prefix> */
        string next_hop_addr = 4;            /* next hop address */
        string outgoing_interface = 5;       /* outgoing interface name */
        uint32 weight = 6;                   /* weight (used for unequal cost load balncing) */
        uint32 preference = 7;               /* The preference of the path. Lowest preference is preferred.  */
                                             /* Only paths with the best preference contribute to forwarding. */
                                             /* (a poor man's primary and backup) */
        uint32 via_vrf_id = 8;               /* Specifies VRF ID for the next hop lookup / recursive lookup */
    }
    repeated Route routes = 1;                /* list of IP static routes */
}

/* IP ARP entries */
message ArpTable {
    message ArpEntry {
        string interface = 1;                          /* interface to which this APR entry applies */
        string ip_address = 2;                         /* IP address */
        string phys_address = 3;                       /* MAC address matching to the IP */
        bool static = 4;                               /* TRUE if this is a static ARP entry */
    }
    repeated ArpEntry arp_entries = 1;    /* list of ARP entries */
}

/* Proxy ARP ranges */
message ProxyArpRanges {
    message RangeList {
        string label = 1;                                /* unique proxy ARP range config identifier */
        message Range {
            string first_ip = 1;                        /* first (starting) IP address of the proxy ARP range */
            string last_ip = 2;                         /* last (ending) IP address of the proxy ARP range  */
        }
        repeated Range ranges = 2;
    }
    repeated RangeList range_lists = 1;                    /* list of proxy arp ranges */
}

/* Proxy ARP interfaces */
message ProxyArpInterfaces {
    message InterfaceList {
        string label = 1;                                /* unique proxy ARP interface config conigurator identifier */
        message Interface {
            string name = 1;                       /* name of the interface proxy arp is enabled for */
        }
        repeated Interface interfaces = 2;
    }
    repeated InterfaceList interface_lists = 1;           /* list of proxy ARP-enabled interfaces */
}

/* STN (Steal The NIC) feature table */
message STNTable {
    message STNTableEntry {
        string ip_address = 1;                          /* destination IP address of a packet that will be punted to specified interface in case it hasn't bee processed by VPP */
        string interface = 2;                           /* interface where the packets will be punted */
    }
    repeated STNTableEntry stn_entries = 1;     /* list of STN entries */
}

/* Enables/disables IP neighbor scanning */
message IPScanNeighbor {
    enum Mode {                                         /* IP scan neighbor mode. Disabled by default, it can be enabled
                                                           for IPv4 or IPv6 separately, or for both of them*/
        DISABLED = 0;
        IPv4 = 1;
        IPv6 = 2;
        BOTH = 3;
    }
    Mode mode = 1;

    uint32 scan_interval = 2;
    uint32 max_proc_time = 3;
    uint32 max_update = 4;
    uint32 scan_int_delay = 5;
    uint32 stale_threshold = 6;
}