3.2.21. tracker

Note

requires a Product License.

Track IP addresses.

vsr running config# tracker

logging

Tracker logging configuration.

vsr running config# tracker logging

enabled

Global trackers logging configurations.

vsr running config# tracker logging
vsr running logging# enabled true|false
Default value
true

icmp

Common icmp-tracker logging configuration.

vsr running config# tracker logging icmp

debug-echo

Enable/disable debug message for icmp tracker ‘echo’ messages. This set routing logging level to debug.

vsr running config# tracker logging icmp
vsr running icmp# debug-echo true|false
Default value
false

bfd

Configure a BFD tracker session.

vsr running config# tracker bfd <bfd>

<bfd>

An tracker name.

type

Session type.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># type TYPE

TYPE values

Description

single-hop

Single-hop session.

multi-hop

Multi-hop session.

Default value
single-hop

source (pushed)

Local IP address.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># source SOURCE

SOURCE values

Description

<ipv4-address>

An IPv4 address.

<ipv6-address>

An IPv6 address.

address (mandatory) (pushed)

IP address of the peer.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># address ADDRESS

ADDRESS values

Description

<ipv4-address>

An IPv4 address.

<ipv6-address>

An IPv6 address.

interface (pushed)

Interface to use to contact peer.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># interface INTERFACE

INTERFACE

An interface name.

vrf (mandatory) (pushed)

VRF name.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># vrf VRF

VRF values

Description

main

The main vrf.

<string>

The vrf name.

l3vrf (pushed)

L3VRF name.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># l3vrf <string>

echo-mode

Use echo packets to detect failures.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># echo-mode true|false

detection-multiplier

Local session detection multiplier.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># detection-multiplier <1-255>
Default value
3

desired-transmission-interval

unit: microseconds

Minimum desired control packet transmission interval.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># desired-transmission-interval <10000-4294967295>
Default value
300000

required-receive-interval

unit: microseconds

Minimum required control packet receive interval (use disable to not receive any control packet).

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># required-receive-interval REQUIRED-RECEIVE-INTERVAL

REQUIRED-RECEIVE-INTERVAL values

Description

<10000-4294967295>

No description.

disable

Ths system will not receive any periodic BFD control packets.

Default value
300000

desired-echo-transmission-interval

unit: microseconds

Minimum desired control packet transmission interval.

vsr running config# tracker bfd <bfd>
vsr running bfd <bfd># desired-echo-transmission-interval <10000-4294967295>

discriminator (state only)

Local session identifier.

vsr> show state tracker bfd <bfd> discriminator

state (state only) (pushed)

Local session state.

vsr> show state tracker bfd <bfd> state

diagnostic (state only) (pushed)

Local session diagnostic.

vsr> show state tracker bfd <bfd> diagnostic

last-down-time (state only)

Time and date of the last time session was down (in seconds).

vsr> show state tracker bfd <bfd> last-down-time

last-up-time (state only)

Time and date of the last time session was up (in seconds).

vsr> show state tracker bfd <bfd> last-up-time

session-down-count (state only)

Amount of time the session went down.

vsr> show state tracker bfd <bfd> session-down-count

session-up-count (state only)

Amount of time the session went up.

vsr> show state tracker bfd <bfd> session-up-count

control-packet-input-count (state only)

Amount of control packets received.

vsr> show state tracker bfd <bfd> control-packet-input-count

control-packet-output-count (state only)

Amount of control packets sent.

vsr> show state tracker bfd <bfd> control-packet-output-count

echo-packet-input-count (state only)

Amount of echo packets received.

vsr> show state tracker bfd <bfd> echo-packet-input-count

echo-packet-output-count (state only)

Amount of echo packets sent.

vsr> show state tracker bfd <bfd> echo-packet-output-count

zebra-notification-count (state only)

Amount of zebra notifications.

vsr> show state tracker bfd <bfd> zebra-notification-count

remote (state only)

BFD remote operational state data.

discriminator (state only)

Remote session identifier.

vsr> show state tracker bfd <bfd> remote discriminator

diagnostic (state only) (pushed)

Local session diagnostic.

vsr> show state tracker bfd <bfd> remote diagnostic

multiplier (state only)

Remote session detection multiplier.

vsr> show state tracker bfd <bfd> remote multiplier

negociated (state only)

BFD negociated operational state data.

transmission-interval (state only)

unit: microseconds

Negotiated transmit interval.

vsr> show state tracker bfd <bfd> negociated transmission-interval

receive-interval (state only)

unit: microseconds

Negotiated receive interval.

vsr> show state tracker bfd <bfd> negociated receive-interval

echo-transmission-interval (state only)

unit: microseconds

Negotiated echo transmit interval.

vsr> show state tracker bfd <bfd> negociated echo-transmission-interval

icmp

Note

requires a Product License.

List of tracked addresses using ICMP echo requests.

vsr running config# tracker
vsr running tracker# icmp <icmp> address ADDRESS vrf VRF source SOURCE interface INTERFACE \
... dhcp-interface DHCP-INTERFACE gateway GATEWAY period <100-65535> threshold <1-255> \
... total <1-255> packet-size <1-65535> packet-tos <1-255> timeout <100-65535>

<icmp>

An tracker name.

address (pushed)

The host to track.

address ADDRESS

ADDRESS values

Description

<ipv4-address>

The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format

<ipv6-address>

The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.

<domain-name>{1,253}

The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. The description clause of schema nodes using the domain-name type MUST describe when and how these names are resolved to IP addresses. Note that the resolution of a domain-name value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence can either be defined explicitly or may depend on the configuration of the resolver. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be A-labels as per RFC 5890.

vrf (mandatory) (pushed)

The vrf in which the ping must be sent. Default is the current netns.

vrf VRF

VRF values

Description

main

The main vrf.

<string>

The vrf name.

source (pushed)

Source address in the ping packet.

source SOURCE

SOURCE values

Description

<ipv4-address>

An IPv4 address.

<ipv6-address>

An IPv6 address.

interface

The interface to bind the tracker to.

interface INTERFACE

INTERFACE

An interface name.

dhcp-interface

The address, gateway and source will be taken from DHCP on this interface unless explicitly specified in the tracker.

dhcp-interface DHCP-INTERFACE

DHCP-INTERFACE

An interface name.

gateway

The gateway to use to send the packet.

gateway GATEWAY

GATEWAY values

Description

<ipv4-address>

The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format

<ipv6-address>

The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.

<domain-name>{1,253}

The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. The description clause of schema nodes using the domain-name type MUST describe when and how these names are resolved to IP addresses. Note that the resolution of a domain-name value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence can either be defined explicitly or may depend on the configuration of the resolver. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be A-labels as per RFC 5890.

period

unit: milliseconds

Time between each ping.

period <100-65535>
Default value
500

threshold

Number of successful pings among <total> to consider peer as reachable.

threshold <1-255>
Default value
1

total

Check the threshold among this number of last pings to consider peer as reachable.

total <1-255>
Default value
1

packet-size

unit: bytes

Packet size.

packet-size <1-65535>
Default value
100

packet-tos

ToS to apply to the packet.

packet-tos <1-255>
Default value
192

timeout (pushed)

unit: milliseconds

Time during which a ping reply is considered as valid. If unset, it timeouts after a ping period.

timeout <100-65535>

state (state only) (pushed)

Status of the last ping.

vsr> show state tracker icmp <icmp> state

diagnostic (state only) (pushed)

Local session diagnostic.

vsr> show state tracker icmp <icmp> diagnostic

icmp-rtt

Note

requires a Product License.

List of tracked addresses for Service Level Agreement using ICMP echo requests.

vsr running config# tracker
vsr running tracker# icmp-rtt <icmp-rtt> address ADDRESS vrf VRF source SOURCE \
... interface INTERFACE gateway GATEWAY period <1000-3600000> count <1-10>

<icmp-rtt>

An tracker name.

address (pushed)

The host to track.

address ADDRESS

ADDRESS values

Description

<ipv4-address>

The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format

<ipv6-address>

The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.

<domain-name>{1,253}

The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. The description clause of schema nodes using the domain-name type MUST describe when and how these names are resolved to IP addresses. Note that the resolution of a domain-name value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence can either be defined explicitly or may depend on the configuration of the resolver. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be A-labels as per RFC 5890.

vrf (mandatory) (pushed)

The vrf in which the ping must be sent. Default is the current netns.

vrf VRF

VRF values

Description

main

The main vrf.

<string>

The vrf name.

source (pushed)

Source address in the ping packet.

source SOURCE

SOURCE values

Description

<ipv4-address>

An IPv4 address.

<ipv6-address>

An IPv6 address.

interface

The interface to bind the tracker to.

interface INTERFACE

INTERFACE

An interface name.

gateway

The gateway to use to send the packet.

gateway GATEWAY

GATEWAY values

Description

<ipv4-address>

The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format

<ipv6-address>

The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.

<domain-name>{1,253}

The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible. Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability. The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation. The description clause of schema nodes using the domain-name type MUST describe when and how these names are resolved to IP addresses. Note that the resolution of a domain-name value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence can either be defined explicitly or may depend on the configuration of the resolver. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be A-labels as per RFC 5890.

period

unit: milliseconds

Time between Round Trip Time (RTT) calculation.

period <1000-3600000>
Default value
3000

count

Number of pings used to calculate Rount Trip Time (RTT).

count <1-10>
Default value
3

timestamp (state only) (pushed)

Timestamp of the start of the last bulk of pings.

vsr> show state tracker icmp-rtt <icmp-rtt> timestamp

min-rtt (state only) (pushed)

unit: microseconds

Lower Round Trip Time (RTT) of the last bulk of pings.

vsr> show state tracker icmp-rtt <icmp-rtt> min-rtt

max-rtt (state only) (pushed)

unit: microseconds

Higher Round Trip Time (RTT) of the last bulk of pings.

vsr> show state tracker icmp-rtt <icmp-rtt> max-rtt

average-rtt (state only) (pushed)

unit: microseconds

Average Round Trip Time (RTT) of the last bulk of pings.

vsr> show state tracker icmp-rtt <icmp-rtt> average-rtt

loss-ratio (state only) (pushed)

Percentage of lost pings.

vsr> show state tracker icmp-rtt <icmp-rtt> loss-ratio