Home

Welcome to the vpp wiki!

Guides

• How to connect to VPP API via socket
• How to retrieve stats from VPP

Troubleshooting

• ...

How to connect to VPP API via socket

Add following section to your VPP config file (by default at /etc/vpp/startup.conf):

socksvr {
	# default will create socket at `/run/vpp-api.sock`
	default
}

Use socket-name to change the socket location:

socksvr {
	# socket-name can be used to change socket location
	socket-name /run/myvpp.sock
}

How to retrieve stats from VPP

Add following section to your VPP config file (by default at /etc/vpp/startup.conf):

statseg {
	# default will create socket at `/run/vpp/stats.sock`
	default
}

Use socket-name to change the stats socket location:

statseg {
	# socket-name can be used to change the default socket location
	socket-name /run/myvpp.sock
}

Additional options available in statseg config section:

statseg {
	# per-node-counters enables (default is `off`) counters for nodes (stats with prefix `/sys/node/`)
	per-node-counters on
    # size sets the size of the memory mapped stats segment (default is ~32MB)
    size <n>[G|M|K]
}