resturl

Documentation

Index

• Constants

Constants

const (
	// Version is a path for retrieving information about version of Agent.
	Version = "/info/version"

	// JSONSchema is a path for retrieving JSON Schema for VPP-Agent configuration (dynamically created
	// container of all registered configuration models).
	JSONSchema = "/info/configuration/jsonschema"
)

Info

const (
	// Configuration is a path for handling(GET,PUT) all VPP-Agent NB configuration
	Configuration = "/configuration"

	// Validate is a path for validating NB yaml configuration for VPP-Agent (the same all-in-one dynamically
	// created yaml configuration as used in agentctl configuration get/update)
	Validate = "/configuration/validate"
)

Configuration

const (

	// LinuxInterface is a linux interface rest path
	LinuxInterface = "/dump/linux/v2/interfaces"

	// LinuxRoutes is the rest linux route path
	LinuxRoutes = "/dump/linux/v2/routes"
	// LinuxArps is the rest linux ARPs path
	LinuxArps = "/dump/linux/v2/arps"
)

Linux Dumps

const (
	// REST ACL IP prefix
	ACLIP = "/dump/vpp/v2/acl/ip"
	// REST ACL MACIP prefix
	ACLMACIP = "/dump/vpp/v2/acl/macip"
)

VPP ACL

const (
	// Interface is rest interface path
	Interface = "/dump/vpp/v2/interfaces"

	// Loopback is path for loopback interface
	Loopback = "/dump/vpp/v2/interfaces/loopback"
	// Ethernet is path for physical interface
	Ethernet = "/dump/vpp/v2/interfaces/ethernet"
	// Memif is path for memif interface
	Memif = "/dump/vpp/v2/interfaces/memif"
	// Tap is path for tap interface
	Tap = "/dump/vpp/v2/interfaces/tap"
	// AfPacket is path for af-packet interface
	AfPacket = "/dump/vpp/v2/interfaces/afpacket"
	// VxLan is path for vxlan interface
	VxLan = "/dump/vpp/v2/interfaces/vxlan"
)

VPP Interfaces

const (
	// NatGlobal is a REST path of a global NAT config
	NatGlobal = "/dump/vpp/v2/nat/global"
	// NatDNat is a REST path of a DNAT configurations
	NatDNat = "/dump/vpp/v2/nat/dnat"
	// NatInterfaces is a REST path of NAT interfaces config
	NatInterfaces = "/dump/vpp/v2/nat/interfaces"
	// NatAddressPools is a REST path of NAT address pools config
	NatAddressPools = "/dump/vpp/v2/nat/pools"
)

VPP NAT

const (
	// restBd is rest bridge domain path
	Bd = "/dump/vpp/v2/bd"
	// restFib is rest FIB path
	Fib = "/dump/vpp/v2/fib"
	// restXc is rest cross-connect path
	Xc = "/dump/vpp/v2/xc"
)

L2 plugin

const (
	// Routes is rest static route path
	Routes = "/dump/vpp/v2/routes"
	// Arps is rest ARPs path
	Arps = "/dump/vpp/v2/arps"
	// PArpIfs is rest proxy ARP interfaces path
	PArpIfs = "/dump/vpp/v2/proxyarp/interfaces"
	// PArpRngs is rest proxy ARP ranges path
	PArpRngs = "/dump/vpp/v2/proxyarp/ranges"
	// IPScanNeigh is rest IP scan neighbor setup path
	IPScanNeigh = "/dump/vpp/v2/ipscanneigh"
	// Vrrps is rest vrrp entries path
	Vrrps = "/dump/vpp/v2/vrrps"
)

VPP L3 plugin

const (
	// SPDs is rest IPSec security policy database path
	SPDs = "/dump/vpp/v2/ipsec/spds"
	// SPs is rest IPSec security policy path
	SPs = "/dump/vpp/v2/ipsec/sps"
	// SAs is rest IPSec security association path
	SAs = "/dump/vpp/v2/ipsec/sas"
)

VPP IPSec plugin

const (
	// Telemetry reads various types of metrics data from the VPP
	Telemetry  = "/vpp/telemetry"
	TMemory    = "/vpp/telemetry/memory"
	TRuntime   = "/vpp/telemetry/runtime"
	TNodeCount = "/vpp/telemetry/nodecount"
)

Telemetry

const (
	// Configurator stats
	ConfiguratorStats = "/stats/configurator"
	// Linux interface stats
	LinuxInterfaceStats = "/stats/linux/interfaces"
)

Stats

const (
	// REST ABF
	ABF = "/dump/vpp/v2/abf"
)

VPP ABF

const (
	Peers = "/dump/vpp/v2/wireguard/peers"
)

VPP Wireguard plugin

const (
	// PuntSocket is rest punt registered socket path
	PuntSocket = "/dump/vpp/v2/punt/sockets"
)