Keys Reference#
This section describes the VPP and Linux keys supported by the VPP agent.
The parts of the long form key in <>
must be set with the same value as defined in the model. As examples, look over the structure and sample values used in the etcdctl put
commands used in the VPP and Linux plugins sections. The microservice label is set to vpp1
in the examples.
For convenience, included below are the .proto and model files associated with each key.
References:
VPP Keys#
ACL-based forwarding (ABF)
Key:
/vnf-agent/vpp1/config/vpp/abfs/v2/abf/<index>
Access control lists (ACL)
Key:
/vnf-agent/vpp1/config/vpp/acls/v2/acl/<name>
VPP interfaces
Key:
/vnf-agent/vpp1/config/vpp/v2/interfaces/<name>
VPP interface status
Key:
/vnf-agent/vpp1/vpp/status/v2/interface/<name>
VPP Interface Span
Key:
/vnf-agent/vpp1/config/vpp/v2/span/<interface from>/to/<interface to>
Bridge domains
Key:
/vnf-agent/vpp1/config/vpp/l2/v2/bridge-domain/<name>
Forwarding table (L2FIBs)
Key:
/vnf-agent/vpp1/config/vpp/l2/v2/fib/<bridge_domain>/mac/<phys_address>
L2 x-connect
Key:
/vnf-agent/vpp1/config/vpp/l2/v2/xconnect/<receive-interface>
VPP ARP
Key:
/vnf-agent/vpp1/config/vpp/v2/arp/<interface>/<ip_address>
VPP proxy ARP
Key:
/vnf-agent/vpp1/config/vpp/v2/proxyarp-global/<settings>
VPP routes
Key (dst_network is with mask in format <ip>/<mask>
):
/vnf-agent/vpp1/config/vpp/v2/route/vrf/<vrf_id>/dst/<dst_network>/gw/<next_hop_addr>
Key if the gateway is not set
:
/vnf-agent/vpp1/config/vpp/v2/route/vrf/<vrf_id>/dst/<dst_network>
IP scan neighbor
Key:
/vnf-agent/vpp1/config/vpp/v2/ipscanneigh-global/<settings>
Virtual routing and forwarding (VRF)
Key (protocol is either ‘IPV4’ or ‘IPV6’):
/vnf-agent/vpp1/config/vpp/v2/vrf-table/id/<id>/protocol/<protocol>
L3 x-connect
Key:
/vnf-agent/vpp1/config/vpp/v2/l3xconnect/<interface>/protocol/<protocol>
NAT Global
Key:
/vnf-agent/vpp1/config/vpp/nat/v2/nat44-global/<settings>
DNAT44
Key:
/vnf-agent/vpp1/config/vpp/nat/v2/dnat44/<label>
NAT Pool
Key:
/vnf-agent/vpp1/config/vpp/nat/v2/nat44-pool/<settings>
NAT Interface
Key:
/vnf-agent/vpp1/config/vpp/nat/v2/nat44-interface/<name>
IPSec SPD (Security Policy Database)
Key:
/vnf-agent/vpp1/config/vpp/ipsec/v2/spd/<index>
IPSec SA (Security Association)
Key:
/vnf-agent/vpp1/config/vpp/ipsec/v2/sa/<index>
IPsec SP (Security Policy)
Key:
/vnf-agent/vpp1/config/vpp/ipsec/v2/sp/spd/<spd_index>/sa/<sa_index>/<inbound> or <outbound>/local-addresses/<local_addr_start>-<local_addr_stop>/remote-addresses/<remote_addr_start>-<remote_addr_stop>/
IPsec tunnel protection
Key:
/vnf-agent/vpp1/config/vpp/ipsec/v2/tun-protect/<interface>
Punt to host stack
Key (l3_protocol and l4_protocol are enum values, not indexes such as IPv4, IPv6 and TCP):
/vnf-agent/vpp1/config/vpp/v2/tohost/l3/<l3_protocol>/l4/<l4_protocol>/port/<port>
Key (punt to host exceptions)
/vnf-agent/vpp1/config/vpp/v2/exception/<reason>
IP redirect
Key (l3_protocol is an enum value, not an index such as IPv4 and IPv6):
/vnf-agent/vpp1/config/vpp/v2/ipredirect/l3/<l3_protocol>/tx/<tx_interface>
DHCP Proxy
Key:
/vnf-agent/vpp1/config/vpp/v2/dhcp-proxy/<source IP address>
STN
Key:
/vnf-agent/vpp1/config/vpp/stn/v2/rule/<interface>/ip/<ip_address>
SRv6
Key - Global Configuration:
/vnf-agent/<agent-label>/config/vpp/srv6/v2/srv6-global
Key - Local SID:
/vnf-agent/<agent-label>/config/vpp/srv6/v2/localsid/<SID>
Key - Policy:
/vnf-agent/<agent-label>/config/vpp/srv6/v2/policy/<bsid>
Key - Steering:
/vnf-agent/<agent-label>/config/vpp/srv6/v2/steering/<name>
Linux Keys#
Linux interfaces
Key:
/vnf-agent/vpp1/config/linux/interfaces/v2/interface/<name>
Linux ARP
Key:
/vnf-agent/vpp1/config/linux/l3/v2/arp/<interface>/<ip_address>
Linux IP tables
Key:
/vnf-agent/vpp1/config/linux/iptables/v2/rulechain/<name>
Linux routes
Key (dst_network uses mask in format of <ip>/<mask>
):
/vnf-agent/vpp1/config/linux/l3/v2/route/<dst_network>/<outgoing_interface>