Interface RouteShowOptions

Route show options.

Hierarchy

  • RouteShowOptions

Properties

cached?: true
cloned?: true

List cloned routes i.e. routes which were dynamically forked from other routes because some route attribute (f.e. MTU) was updated.

Actually, it is equivalent to table cache.

dev?: string

The name of the device.

dsfield?: number
exact?: string

See

to

from?: string

The same syntax as for to, but it binds the source address range rather than destinations. Note that the from option only works with cloned routes.

match?: string

See

to

proto?: number | RoutingTableProtocols
protocol?: number | RoutingTableProtocols

Only list routes of this protocol.

realm?: number

Only list routes with this/these realms.

realms?: string
root?: string

See

to

scope?: number | AddressScopes

The scope of the area where this address is valid. The available scopes are listed in file /etc/iproute2/rt_scopes.

src?: string

Only list routes with preferred source addresses selected by PREFIX.

table?: number | RouteRoutingTables

Show the routes from this table(s). The default setting is to show table main. TABLEID may either be the ID of a real table or one of the special values RouteRoutingTables .

to?: string

Only select routes from the given range of destinations. SELECTOR consists of an optional modifier (root, match or exact) and a prefix.

root PREFIX selects routes with prefixes not shorter than PREFIX. F.e. root 0/0 selects the entire routing table.

match PREFIX selects routes with prefixes not longer than PREFIX. F.e. match 10.0/16 selects 10.0/16, 10/8 and 0/0, but it does not select 10.1/16 and 10.0.0/24.

And exact PREFIX (or just PREFIX) selects routes with this exact prefix.

If neither of these options are present, ip assumes root 0/0 i.e. it lists the entire table.

Special values: all and default.

tos?: number

Only select routes with the given TOS.

type?: RouteTypes

The type of this rule.

via?: string

Only list routes going via the nexthop routers selected by PREFIX.

vrf?: string

Show the routes for the table associated with the vrf name.

Generated using TypeDoc