Skip to main content
FieldTypeDescriptionValue(s)
namestringName of this end of the veth pair.

This is a literal kernel interface name. Link aliases are not supported here because
the interface is created by this document rather than selected from existing physical links.
peerVethPeerConfigConfiguration for the peer end of the veth pair.
upboolBring the link up or down.

If not specified, the link will be brought up.
mtuuint32Configure LinkMTU (Maximum Transmission Unit) for the link.

If not specified, the system default LinkMTU will be used (usually 1500).
addressesAddressConfigConfigure addresses to be statically assigned to the link.
routesRouteConfigConfigure routes to be statically created via the link.
multicastboolSet the multicast capability of the link.

peer

VethPeerConfig is the configuration for the peer end of a veth pair.
FieldTypeDescriptionValue(s)
namestringName of the peer end of the veth pair.

This is a literal kernel interface name. Link aliases are not supported here because
the interface is created by this document rather than selected from existing physical links.

Both endpoints are created in the host network namespace. This name can be listed in a
VRFConfig document’s links field to attach the peer endpoint to that VRF.
upboolBring the link up or down.

If not specified, the link will be brought up.
mtuuint32Configure LinkMTU (Maximum Transmission Unit) for the link.

If not specified, the system default LinkMTU will be used (usually 1500).
addressesAddressConfigConfigure addresses to be statically assigned to the link.
routesRouteConfigConfigure routes to be statically created via the link.
multicastboolSet the multicast capability of the link.

addresses[]

AddressConfig represents a network address configuration.
FieldTypeDescriptionValue(s)
addressPrefixIP address to be assigned to the link.

This field must include the network prefix length (e.g. /24 for IPv4, /64 for IPv6).
routePriorityuint32Configure the route priority (metric) for routes created for this address.

If not specified, the system default route priority will be used.

routes[]

RouteConfig represents a network route configuration.
FieldTypeDescriptionValue(s)
destinationPrefixThe route’s destination as an address prefix.

If not specified, a default route will be created for the address family of the gateway.
gatewayAddrThe route’s gateway (if empty, creates link scope route).
sourceAddrThe route’s source address (optional).
metricuint32The optional metric for the route.
mtuuint32The optional MTU for the route.
tableRoutingTableThe routing table to use for the route.

If not specified, the main routing table will be used.

addresses[]

AddressConfig represents a network address configuration.
FieldTypeDescriptionValue(s)
addressPrefixIP address to be assigned to the link.

This field must include the network prefix length (e.g. /24 for IPv4, /64 for IPv6).
routePriorityuint32Configure the route priority (metric) for routes created for this address.

If not specified, the system default route priority will be used.

routes[]

RouteConfig represents a network route configuration.
FieldTypeDescriptionValue(s)
destinationPrefixThe route’s destination as an address prefix.

If not specified, a default route will be created for the address family of the gateway.
gatewayAddrThe route’s gateway (if empty, creates link scope route).
sourceAddrThe route’s source address (optional).
metricuint32The optional metric for the route.
mtuuint32The optional MTU for the route.
tableRoutingTableThe routing table to use for the route.

If not specified, the main routing table will be used.