Defines the first hop of the route.
Defines the next hop of the route.
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.
Defines a table used in the kernel to organize routes using policy based routing rules.
Represents a list of plcm-network-route elements.
| Name | Type | Description | Attributes |
|---|---|---|---|
| plcmNetworkRouteList | Array of PlcmNetworkRoute | See Definition of PlcmNetworkRoute |
| Name | Type | Description | Attributes |
|---|---|---|---|
| routes | Array of PlcmNetworkRoute | ||
| tableId | int | Integer ID between 0 and 255, with the following values defined by the kernel: 0 unspec 253 default 254 main 255 local |
| Name | Type | Description | Attributes |
|---|---|---|---|
| nextHop | NextHop | ||
| hop | Hop | ||
| advmss | int | The advertised Maximal Segment Size | |
| cwnd | int | The clamp for congestion window. | |
| hopLimit | long | Restricts the number of hops | |
| metric | int | The preference value of the route. | |
| mtu | 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. | |
| lockMtu | 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. | |
| protocol | PlcmNetworkRouteProtocol | Route protocol | |
| routeType | PlcmNetworkRouteType | Type of network route | |
| rtt | 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. | |
| rttUnit | PlcmRttUnit | Unit of measure for RTT | |
| rttVar | int | The initial RTT variance estimate. | |
| rttVarUnit | PlcmRttUnit | Unit of measure for RTT variance. | |
| tableId | string | Number (or name) of the routing table in which the route exists or to which the route should be added | |
| tos | PlcmNetworkTypeOfService | Type of service | |
| targetAddress | PlcmInetAddressPrefix | The target address (route prefix) for the route, i.e. the destination of the route | |
| srcAddress | PlcmInetAddress | 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. | |
| scope | PlcmNetworkAddressScope | The scope of the route. | |
| equalize | 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. |
| Name | Type | Description | Attributes |
|---|---|---|---|
| viaAddress | PlcmInetAddress | 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. | |
| deviceName | string | The output device name, e.g. eth0. | |
| weight | int | The weight of this element of a multi-path route reflecting its relative bandwidth or quality. | |
| flag | PlcmNetworkRouteHopFlag | Adjusts the characteristics of the routing behavior for this hop |
| Name | Type | Description | Attributes |
|---|---|---|---|
| viaAddress | PlcmInetAddress | 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. | |
| deviceName | string | The output device name, e.g. eth0. | |
| weight | int | The weight of this element of a multi-path route reflecting its relative bandwidth or quality. | |
| flag | PlcmNetworkRouteHopFlag | Adjusts the characteristics of the routing behavior for this hop |