Reference
This page is an overview of all keys supported for the vpp-agent.
Parts of the key in <>
must be set with the same value as in a model. The microservice label is set to vpp1
in every mentioned key, but if different value is used, it needs to be replaced in the key as well.
Link in key title redirects to the associated proto definition.
VPP keys
Key:
/vnf-agent/vpp1/config/vpp/abfs/v2/abf/<index>
Key:
/vnf-agent/vpp1/config/vpp/acls/v2/acl/<name>
Key:
/vnf-agent/vpp1/config/vpp/v2/interfaces/<name>
VPP interface status (read only):
Key:
/vnf-agent/vpp1/vpp/status/v2/interface/<name>
Key:
/vnf-agent/vpp1/config/vpp/l2/v2/bridge-domain/<name>
Key:
/vnf-agent/vpp1/config/vpp/l2/v2/fib/<bridge_domain>/mac/<phys_address>
Key:
/vnf-agent/vpp1/config/vpp/l2/v2/xconnect/<receive-interface>
Key:
/vnf-agent/vpp1/config/vpp/v2/arp/<interface>/<ip_address>
Key (single for the entire proxy-arp configuration):
/vnf-agent/vpp1/config/vpp/v2/proxyarp-global/settings
Key (dst_network is with mask in format
/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>
Key (single for the entire ip-scan-neighbor configuration):
/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>
Key (single for the NAT global configuration):
/vnf-agent/vpp1/config/vpp/nat/v2/nat44-global/settings
Key:
/vnf-agent/vpp1/config/vpp/nat/v2/dnat44/<label>
IPSec security policy database:
Key:
/vnf-agent/vpp1/config/vpp/ipsec/v2/spd/<index>
Key:
/vnf-agent/vpp1/config/vpp/ipsec/v2/sa/<index>
Key (l3_protocol and l4_protocol are enum values, not indexes (like IPv4, IPv6, TCP, etc.)):
/vnf-agent/vpp1/config/vpp/v2/tohost/l3/<l3_protocol>/l4/<l4_protocol>/port/<port>
Key (l3_protocol is an enum value, not index (like IPv4, IPv6 etc.)):
/vnf-agent/vpp1/config/vpp/v2/ipredirect/l3/<l3_protocol>/tx/<tx_interface>
Key:
/vnf-agent/vpp1/config/vpp/stn/v2/rule/<interface>/ip/<ip_address>
Linux keys
Key:
/vnf-agent/vpp1/config/linux/interfaces/v2/interface/<name>
Key:
/vnf-agent/vpp1/config/linux/l3/v2/arp/<interface>/<ip_address>
Key:
/vnf-agent/vpp1/config/linux/iptables/v2/rulechain/<name>
Key (dst_network is with mask in format <ip>/<mask>
):
/vnf-agent/vpp1/config/linux/l3/v2/route/<dst_network>/<outgoing_interface>