GRCLI-INTERFACE(1)

πŸ’– GRCLI-INTERFACE πŸ’– (section 1, the interfaces page)

okay bestie, so this is grcli-interface from the General Commands Manual β€” it's the page all about interfaces in the grcli world. you want tunnels? bridges? vlans? ports? vrf? bond? all of it lives here. sit down, get a snack, we're doing the whole thing πŸ“


✨ NAME ✨

grcli-interface β€” Interfaces. that's it, that's the whole name, no notes πŸ’…


🌸 SYNOPSIS 🌸

every single one of these is a thing you can literally type. i'm not skipping a single one, no cap.

interface add vxlan NAME vni VNI local LOCAL [[mac MAC] [dst_port
DST_PORT] (up|down) [promisc (on|off)] [neigh_snoop (on|off)] [mtu MTU]
([vrf VRF]|[domain DOMAIN]) [description DESCR] [encap_vrf ENCAP_VRF]]

πŸ¦‹ Create a new VXLAN tunnel interface.

interface add bridge NAME [[promisc (on|off)] [neigh_snoop (on|off)]
[mtu MTU] ([vrf VRF]|[domain DOMAIN]) [description DESCR] [ageing_time
AGE] [mac MAC] [flood (on|off)] [learn (on|off)] [neigh_suppress
(on|off)] (up|down)]

πŸ¦‹ Create a new bridge interface.

interface add ipip NAME local LOCAL remote REMOTE [[promisc (on|off)]
[neigh_snoop (on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN])
[description DESCR] (up|down)]

πŸ¦‹ Create a new IPIP tunnel interface.

interface add vlan NAME parent PARENT vlan_id VLAN [[promisc (on|off)]
[neigh_snoop (on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN])
[description DESCR] [mac MAC] (up|down)]

πŸ¦‹ Create a new VLAN sub interface.

interface add port NAME devargs DEVARGS [[promisc (on|off)] [neigh_snoop
(on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN]) [description DESCR] [mac
MAC] [rxqs N_RXQ] [qsize Q_SIZE] (up|down)]

πŸ¦‹ Create a new port.

interface add vrf NAME [[fib4-tbl8 FIB4_TBL8] [rib6-routes RIB6_ROUTES]
[fib6-tbl8 FIB6_TBL8] [mac MAC] [description DESCR] [rib4-routes
RIB4_ROUTES]]

πŸ¦‹ Create a new VRF.

interface add bond NAME mode (active-backup|lacp) [[promisc (on|off)]
[neigh_snoop (on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN])
[description DESCR] [balance (rss|l2|l3+l4)] [mac MAC] (up|down)]

πŸ¦‹ Create a new bond interface.

interface set vxlan NAME [vni VNI] [local LOCAL] [encap_vrf ENCAP_VRF]
[mac MAC] [dst_port DST_PORT] (up|down) [promisc (on|off)] [neigh_snoop
(on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN]) [description DESCR]
[name NEW_NAME]

πŸ¦‹ Modify VXLAN parameters.

interface set bridge NAME (up|down) [promisc (on|off)] [neigh_snoop
(on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN]) [description DESCR]
[ageing_time AGE] [mac MAC] [flood (on|off)] [learn (on|off)]
[neigh_suppress (on|off)] [name NEW_NAME]

πŸ¦‹ Modify bridge parameters.

interface set ipip NAME [local LOCAL] [remote REMOTE] (up|down) [promisc
(on|off)] [neigh_snoop (on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN])
[description DESCR] [name NEW_NAME]

πŸ¦‹ Modify ipip parameters.

interface set vlan NAME [parent PARENT] [vlan_id VLAN] (up|down)
[promisc (on|off)] [neigh_snoop (on|off)] [mtu MTU] ([vrf VRF]|[domain
DOMAIN]) [description DESCR] [mac MAC] [name NEW_NAME]

πŸ¦‹ Modify VLAN parameters.

interface set port NAME (up|down) [promisc (on|off)] [neigh_snoop
(on|off)] [mtu MTU] ([vrf VRF]|[domain DOMAIN]) [description DESCR] [mac
MAC] [rxqs N_RXQ] [qsize Q_SIZE] [name NEW_NAME]

πŸ¦‹ Modify port parameters.

interface set vrf NAME [rib4-routes RIB4_ROUTES] [fib4-tbl8 FIB4_TBL8]
[rib6-routes RIB6_ROUTES] [fib6-tbl8 FIB6_TBL8] [mac MAC] [description
DESCR] [name NEW_NAME]

πŸ¦‹ Reconfigure a VRF.

interface set bond NAME [primary PRIMARY] [mode (active-backup|lacp)]
(up|down) [promisc (on|off)] [neigh_snoop (on|off)] [mtu MTU] ([vrf
VRF]|[domain DOMAIN]) [description DESCR] [balance (rss|l2|l3+l4)] [mac
MAC] [name NEW_NAME]

πŸ¦‹ Modify bond parameters.

interface config set [flush-routes-on-iface-down (on|off)] [skip-route-
events-on-iface-down (on|off)]

πŸ¦‹ Change the interface subsystem configuration.

interface config show

πŸ¦‹ Show the interface subsystem configuration.

interface del NAME

πŸ¦‹ Delete an existing interface.

interface stats

πŸ¦‹ Show interface counters.

interface rates

πŸ¦‹ Show interface counter rates.

interface show ([name NAME]|[type TYPE])

πŸ¦‹ Show interface details.


πŸŽ€ OPTIONS πŸŽ€

these are the little fill-in-the-blank words from up there. every one of them, in order, fr fr:

  • NAME β€” only show this interface. one (1) interface. yours. πŸ’…
  • VNI β€” the VXLAN Network Identifier, and it has to be in the range 1-16777215. respect the range bestie.
  • LOCAL β€” the local tunnel endpoint address.
  • MAC β€” set the bond MAC address.
  • DST_PORT β€” the UDP destination port. default is 4789, in case you were wondering (you were).
  • MTU β€” Maximum transmission unit size.
  • VRF β€” L3 addressing/routing domain name.
  • DOMAIN β€” link domain interface.
  • DESCR β€” interface description. put a cute little note in there 🌸
  • ENCAP_VRF β€” L3 routing domain name for encap addresses.
  • AGE β€” expiration time for learned MAC addresses. yes, MAC addresses get aged out. it's giving skincare routine.
  • REMOTE β€” remote tunnel endpoint address.
  • PARENT β€” parent port interface.
  • VLAN β€” VLAN ID.
  • DEVARGS β€” DPDK device args.
  • N_RXQ β€” number of Rx queues.
  • Q_SIZE β€” Rx/Tx queues size.
  • FIB4_TBL8 β€” IPv4 TBL8 groups.
  • RIB6_ROUTES β€” max IPv6 routes.
  • FIB6_TBL8 β€” IPv6 TBL8 groups.
  • RIB4_ROUTES β€” max IPv4 routes.
  • NEW_NAME β€” new interface name. rebranding era ✨
  • PRIMARY β€” primary member.
  • TYPE β€” only show this type of interface.

🫢 SEE ALSO 🫢

go read those too, they're iconic, iykyk πŸ‘‘


πŸ› REPORTING BUGS πŸ›

found a bug? don't be shy, don't suffer in silence. report bugs to the grout project issue tracker at <https://github.com/DPDK/grout/issues>. they wanna hear it, fr.


and that's the whole page bestie πŸ’– this one came out of the General Commands Manual, dated 2026-10-01, and it's the GRCLI-INTERFACE(1) page β€” now go forth and configure some interfaces, you absolute main character πŸŒˆβ­πŸ’œ

πŸ“¦ where this page comes from