Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Only Readable Properties


PropertyTypeDescription
Numeric properties
dst-len
Destination prefix length
bgp-path-len
The current length of the BGP AS-PATH
bgp-input-local-as
AS number of the local peer to which the prefix was sent
bgp-input-remote-as
AS number of the remote peer from which the prefix was received
bgp-output-local-as
AS number of the peer that will advertise the prefix
bgp-output-remote-as
AS number of the peer to which the prefix will be advertised
ospf-metric
Current OSPF metric
ospf-tag
Current OSPF tag
rip-metric
Current RIP metric
rip-tag
Current RIP tag
Flag properties
active
indicates whether the route is active
bgp-atomic-aggregate

bgp-communities-empty
indicates if the BGP Communities attribute is empty
bgp-ext-communities-empty
indicates if the BGP Extended Communities attribute is empty
bgp-large-communities-empty
indicates if the BGP Large Communities attribute is empty
bgp-network
Indicates if the prefix is originated from BGP networks
ospf-dn
Indicates if the OSPF route has DN bit set.
Prefix properties
dst
Destination
ospf-fwd
Current OSPF forwarding address
bgp-input-local-addr
The IP address of the local peer to which the prefix was sent
bgp-input-remote-addr
The IP address of the remote peer from which the prefix was received
bgp-output-local-addr
The IP address of the peer that will advertise the prefix
bgp-output-remote-addr
The IP address of the peer to which the prefix will be advertised
Other Properties
afiipv4 | ipv6 | l2vpn | l2vpn-cisco | vpnv4 | vpnv6The address family of the route.
bgp-as-pathnumeric_regexpAS path matching, read more>>
bgp-as-path-slow-legacystring_regexpDeprecated. Extremely slow old style AS path matching. This parameter should be used only as a temporary matcher while migrating from an old ROS v6 config. Read more>>
chainchain_name
ospf-typeext1 | ext2 | inter | intra | nssa1 | nssa2

Type of the OSPF route:

  • ext1 - external (Type 5 LSA) with type1 metric
  • ext2 - external (Type 5 LSA) with type2 metric
  • inter - inter-area-route (Type 3 LSA)
  • intra - intra-area-route (Type 4 LSA)
  • nssa1 - Type 7 LSA with type1 metric
  • nssa2 - Type 7 LSA with type1 metric
protocolbgp | connected | dhcp | fantasy | modem | ospf | rip | static | vpnProtocol type from which the route was imported.
rpkiinvalid | unknown | validRPKI validation status of the prefix
rtabrouting_table_nameName of the routing table the route was imported from
vrfvrf_nameName of the VRF the route was imported from


Writeable Properties


PropertyTypeDescription
Numeric properties
distance
route distance
scope

scope-target
target scope
bgp-weight
BGP WEIGHT attribute
bgp-med
BGP MED attribute local to the router. 
bgp-out-med
BGP MED attribute to be sent to a remote peer. Should be used in the output chain
bgp-local-pref
BGP LOCALPREF attribute
bgp-igp-metric
BGP IGP METRIC
bgp-path-peer-prepend

Prepend last received remote peers ASN. If the prefix is originated from the router, then this parameter will not do anything on the router's output, because ASN does not exist yet.


If used as a matcher in BGP input, it is possible to filter prefixes exceeding a certain number of prepends. For example, if remote peer prepends its ASN 5 times, but we want to allow max 4 times prepended ASN, then we can use: "if (bgp-path-peer-prepend > 4) {reject}"


This parameter also overrides any prepends received from the remote peer, for example, if the remote peer prepended its AS 3 times, we can remove this prepend by setting "bgp-path-peer-prepend 1" in BGP input

bgp-path-prepend
Prepend routers ASN, should be used in BGP output.
ospf-ext-metric
OSPF External route metric
ospf-ext-tag
OSPF external route tag
rip-ext-metric
RIP External route metric
rip-ext-tag
RIP External route tag
Flag properties
ospf-ext-dn
DN bit for external OSPF routes
blackhole

use-te-nexthop

Other properties
gwipv4/6 address
gw-interfaceinterface_name
gw-checknone|arp|icmp|bfd|bfd-mh
pref-srcipv4/6 address
bgp-originigp|egp|incomplete
ospf-ext-fwdipv4/6 address
ospf-ext-typetype1|type2
commentstring
bgp-communitesinline_community_set | set_name
bgp-ext-communities

bgp-large-communities

...