plcm-network-route.xsd Documentation

Definitions for data structures representing a network route and a routing table used in policy based routing rules.

Imported Namespaces

Target Namespace

Elements

hop  Hop

Defines the first hop of the route.

next-hop  NextHop

Defines the next hop of the route.

plcm-network-route  PlcmNetworkRoute

Represents a network route in the network routing tables or a static route persisted in a route file for an interface. Static routes are associated with an interface and are stored as a route configuration script, for example: /etc/sysconfig/network-scripts/route-eth0 In general, a plcm-network-route consists of a target address prefix (CIDR) and a hop that specifies the device through which traffic should be routed. In this general case, the hop should not specify a via address. To create a default route, specify the via address and device name in the hop, with no target address preix.

plcm-route-table  PlcmRouteTable

Defines a table used in the kernel to organize routes using policy based routing rules.

plcm-network-route-list  PlcmNetworkRouteList

Represents a list of plcm-network-route elements.


Complex Types

PlcmNetworkRouteList Fields

NameTypeDescriptionAttributes
plcmNetworkRouteList List of plcm-network-routeSee Definition of plcm-network-route

PlcmRouteTable Fields

NameTypeDescriptionAttributes
routesList of PlcmNetworkRoute
table-idxs:int Integer ID between 0 and 255, with the following values defined by the kernel: 0 unspec 253 default 254 main 255 local

PlcmNetworkRoute Fields

NameTypeDescriptionAttributes
next-hopNextHop
hopHop
advmssxs:int The advertised Maximal Segment Size
cwndxs:int The clamp for congestion window.
hop-limitxs:long Restricts the number of hops
metricxs:int The preference value of the route.
mtuxs:int The MTU along the path to destination. If modifier lock is not used, MTU may be updated by the kernel due to Path MTU Discovery.
lock-mtuxs:boolean With respect to MTU, if the modifier lock is used then no path MTU discovery will be performed and all the packets will be sent without the DF bit set for the IPv4 case or fragmented to the MTU for the IPv6 case.
protocolPlcmNetworkRouteProtocol Route protocol
route-typePlcmNetworkRouteType Type of network route
rttxs:int The initial RTT (Round Trip Time) estimate. Actually, in Linux 2.2 and 2.0 it is not RTT but the initial TCP retransmission timeout. The kernel forgets it as soon as it receives the first valid ACK from peer.
rtt-unitPlcmRttUnit Unit of measure for RTT
rtt-varxs:int The initial RTT variance estimate.
rtt-var-unitPlcmRttUnit Unit of measure for RTT variance.
table-idxs:string Number (or name) of the routing table in which the route exists or to which the route should be added
tosPlcmNetworkTypeOfService Type of service
target-addressPlcmInetAddressPrefix The target address (route prefix) for the route, i.e. the destination of the route
src-addressPlcmInetAddress The source address to prefer using when sending to the destinations covered by route prefix (target-address). This address must be defined on a local machine interface.
scopePlcmNetworkAddressScope The scope of the route.
equalizexs:boolean Allow packet by packet randomization on multipath routes. Without this modifier route will be frozen to one selected nexthop, so that load splitting will occur only on per-flow base. Equalize works only if the appropriate kernel configuration option is chosen or if the kernel is patched.

NextHop Fields

NameTypeDescriptionAttributes
via-addressPlcmInetAddress The address of nexthop router. Actually, the sense of this field depends on route type. For normal unicast routes it is either true nexthop router or, if it is a direct route installed in BSD compatibility mode, it can be a local address of the interface. For NAT routes it is the first address of block of translated IP destinations.
device-namexs:string The output device name, e.g. eth0.
weightxs:int The weight of this element of a multi-path route reflecting its relative bandwidth or quality.
flagPlcmNetworkRouteHopFlag Adjusts the characteristics of the routing behavior for this hop

Hop Fields

NameTypeDescriptionAttributes
via-addressPlcmInetAddress The address of nexthop router. Actually, the sense of this field depends on route type. For normal unicast routes it is either true nexthop router or, if it is a direct route installed in BSD compatibility mode, it can be a local address of the interface. For NAT routes it is the first address of block of translated IP destinations.
device-namexs:string The output device name, e.g. eth0.
weightxs:int The weight of this element of a multi-path route reflecting its relative bandwidth or quality.
flagPlcmNetworkRouteHopFlag Adjusts the characteristics of the routing behavior for this hop