grcli-interface - Man Page

Interfaces.

Synopsis

interface add vxlan NAME vni VNI local LOCAL [[mac MAC] [dst_port DST_PORT] (up|down) [promisc (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)] [mtu MTU] ([vrf VRF]|[domain DOMAIN]) [description DESCR] [ageing_time AGE] [mac MAC] (flood|no_flood) (learn|no_learn) (up|down)]

Create a new bridge interface.

interface add ipip NAME local LOCAL remote REMOTE [[promisc (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)] [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)] [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] [description DESCR] [rib4-routes RIB4_ROUTES]]

Create a new VRF.

interface add bond NAME mode (active-backup|lacp) [[promisc (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)] [mtu MTU] ([vrf VRF]|[domain DOMAIN]) [description DESCR] [name NEW_NAME]

Modify VXLAN parameters.

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

Modify bridge parameters.

interface set ipip NAME [local LOCAL] [remote REMOTE] (up|down) [promisc (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)] [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)] [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] [description DESCR] [name NEW_NAME]

Reconfigure a VRF.

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

Modify bond parameters.

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

NAME

Show only this interface.

VNI

VXLAN Network Identifier (1-16777215).

LOCAL

Local tunnel endpoint address.

MAC

Set the bond MAC address.

DST_PORT

UDP destination port (default 4789).

MTU

Maximum transmission unit size.

VRF

L3 addressing/routing domain name.

DOMAIN

Link domain interface.

DESCR

Interface description.

ENCAP_VRF

L3 routing domain name for encap addresses.

AGE

Expiration time for learned MAC addresses.

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.

PRIMARY

Primary member.

TYPE

Show only this type of interface.

See Also

grcli(1) grcli-route(1)

Reporting Bugs

Report bugs to the grout project issue tracker at <https://github.com/DPDK/grout/issues>.

Referenced By

grcli(1), grcli-address(1), grcli-affinity(1), grcli-dnat44(1), grcli-fdb(1), grcli-nexthop(1), grcli-ping(1), grcli-router-advert(1), grcli-snat44(1), grcli-trace(1), grcli-traceroute(1).

2026-04-20