3.2.2. show¶
show vrfs¶
vsr> show vrfs
Show VRFs on the machine.
Output Data¶
vrf VRFVRF name.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
show audit-trails¶
vsr> show audit-trails [user <string>] [since <YYYY-MM-DD>[ <HH:MM:SS>]] [until <YYYY-MM-DD>[ <HH:MM:SS>]] \
... [type TYPE]
Show audit trail informations.
Input Parameters¶
user <string>Display only this user trails.
since <YYYY-MM-DD>[ <HH:MM:SS>]Show trails since that time.
until <YYYY-MM-DD>[ <HH:MM:SS>]Show trails until that time.
type TYPEShow trails until that time.
TYPEvaluesDescription
commitShow only commit records.
rpcShow only rpc records.
sessionShow only session records.
Output Data¶
trailTrails registered.
date <string>Trail date.
user <string>User name.
error-message <string>Error message.
commitCommit trail.
id IDThe commit identifier (set to unknown for trails created before the VSR 3.10 that does not support fixed commit identifier).
IDvaluesDescription
<uint32>No description.
<string>No description.
resource <string>Impacted resources.
rpcRPC trail.
resource <string>Impacted resource.
sessionSession trail.
end-time <string>Session end time.
show commands¶
vsr> show commands
Show all available nc-cli commands with the corresponding yang path.
Output Data¶
commandThe list of nc-cli commands.
path <string>The RPC path.
nc-cli-command <string>The corresponding nc-cli command name.
protected true|falseTrue if the RPC is protected.
show interface¶
Note
This command is composed of 2 subcommands. Each command is a distinct netconf RPC that share the same syntax in the CLI but different input and output schemas that forces them to be separated.
show-interface¶
vsr> show interface [vrf <string>] [l3vrf <string>] [type <identityref>] LEVEL [name <string>]
Show interface information.
Input Parameters¶
vrf <string>VRF to look into.
l3vrf <string>L3vrf to look into.
type <identityref>Interface type.
LEVEL(mandatory)The level of information requested.
LEVELvaluesDescription
statisticsDisplay statistics.
detailsDisplay more details.
upDisplay UP interfaces only.
hardware-statisticsDisplay hardware statistics. Implies physical type.
hardware-featuresDisplay hardware features. Implies physical type.
hardware-informationDisplay hardware information. Implies physical type.
hardware-driver-informationDisplay hardware driver information. Implies physical type.
name <string>Display only one interface by this name.
show-interface-brief¶
vsr> show interface [vrf VRF] [l3vrf L3VRF] [type <identityref>] [name NAME]
Show interface brief information.
Input Parameters¶
vrf VRFVRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFL3vrf to look into.
L3VRFThe l3vrf name.
type <identityref>Interface type.
name NAMEDisplay only one interface by this name.
NAMEAn interface name.
Output Data¶
interfaceThe list of interfaces matching the input filter.
name <string>The name of the interface.
state STATEThe state of the interface.
STATEvaluesDescription
upThe interface is up.
downThe interface is down.
l3vrf <string>The l3vrf where the interface is located.
ipv4-address <string>The IPv4 addresses configured on the interface.
ipv6-address <string>The IPv6 addresses configured on the interface.
description <string>The interface description.
show interface throughput¶
vsr> show interface throughput [vrf <string>] [type <identityref>] [name <string>] [count <1-65535>] \
... [raw]
Show interface throughput every second.
Input Parameters¶
vrf <string>VRF to look into.
type <identityref>Select all interfaces of this type.
name <string>Select this specific interface (may be specified multiple times).
count <1-65535>Stop after the given number of seconds. By default, the throughput is displayed every second until the command is interrupted with
ctrl-c.rawShow the exact number of packets/bits received/transmitted every second instead of human readable values.
show ipv4-routes¶
vsr> show ipv4-routes [vrf VRF] [l3vrf L3VRF] [protocol <identityref>] [table <1-4294967295>] \
... [to TO]
Show IPv4 routing table.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the l3vrf.
L3VRFThe l3vrf name.
protocol <identityref>Filter routes by protocol.
table <1-4294967295>Non-main Kernel Routing Table.
to TOFind the route entry used to reach an IP address or an exact network.
TOvaluesDescription
<A.B.C.D>An IPv4 address.
<A.B.C.D/M>An IPv4 prefix: address and CIDR mask.
Output Data¶
routeList of IPv4 routes matching the request.
destination DESTINATIONRoute destination.
DESTINATIONAn IPv4 prefix: address and CIDR mask.
protocol PROTOCOLRoute protocol.
PROTOCOLvaluesDescription
bgpBorder Gateway Protocol (BGP).
localLocal routes.
connectedConnected routes (directly attached subnet or host).
kernelKernel routes.
isisIntermediate system to intermediate system (ISIS).
ospfOpen Shortest Path First (OSPFv2).
ripRouting Information Protocol (RIP).
staticStatically configured routes.
<string>No description.
l3vrf <string>L3vrf for this route.
table <uint32>Table where this route is located.
distance <uint8>Distance value for this route.
metric <uint32>Route metric.
tag <1-4294967295>Route tag.
selected true|falseRoute is the selected or preferred route for the prefix.
installed true|falseRoute is installed in the FIB.
installation-failed true|falseRoute installation in the FIB has failed.
queued true|falseTrue if the route has a pending FIB operation that has not completed.
uptime <string>Route uptime.
next-hopNext-hops for this route.
interface INTERFACEInterface used for this next-hop.
INTERFACEAn interface name.
address ADDRESSAddress used for this next-hop.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
source SOURCESource address used for this next-hop.
SOURCEAn IPv4 address.
blackhole BLACKHOLEBlackhole next-hop.
BLACKHOLEvaluesDescription
droppedSilently discard packets when matched.
rejectedEmit an ICMP unreachable when matched.
admin-prohibitedEmit an ICMP admin-prohibited when matched.
directly-connected true|falseTrue if the nexthop is directly connected.
on-link true|falseTrue if the nexthop is reachable locally.
backup true|falseTrue if the nexthop is a backup nexthop.
link-down true|falseTrue if the nexthop is reachable via an interface that is in down state.
weight <uint8>Weight to be used for this nexthop when ECMP is enabled.
active true|falseTrue if the nexthop is active.
duplicate true|falseTrue if the nexthop is a duplicate of another nexthop.
recursive true|falseTrue if the nexthop is resolved via another gateway.
unreachable true|falseTrue if the nexthop is not reachable.
installed true|falseTrue if the nexthop is installed in the FIB.
mpls-label MPLS-LABELLabel(s) for this route as key names or as ids (0 to 1048575).
MPLS-LABELvaluesDescription
<uint32>No description.
ipv4-explicit-nullMPLS IPv4 explicit NULL label (value: 0).
router-alertMPLS router alert label (value: 1).
ipv6-explicit-nullMPLS IPv6 explicit NULL label (value: 2).
implicit-nullMPLS implicit NULL label (value: 3).
eliMPLS ELI (Entropy Label Indicator) (value: 7).
galMPLS GAL (Generic Association Label) (value: 13).
oam-alertMPLS OAM (Operations, Administration, and Maintenance) alert label (value: 14).
extensionMPLS extension label (value: 15).
segment-routing-ipv6Segment routing next-hop.
segment-id SEGMENT-IDList of segments, each segment representing a specific source-routed path to send traffic, from the headend to the endpoint of the corresponding segment routing policy.
SEGMENT-IDAn IPv6 address.
action ACTIONAction realized when the packets are sent through this next-hop.
ACTIONvaluesDescription
<string>No description.
End.TEndpoint with specific IPv6 table lookup.
End.B6.EncapEndpoint with decapsulation and L2 cross-connect e.g., L2VPN use case.
End.DX2Endpoint with decapsulation and L2 cross-connect.
End.DT4Endpoint with decapsulation and specific IPv4 table lookup e.g., IPv4-L3VPN (equivalent to per-VRF VPN label).
End.DT6Endpoint with decapsulation and specific IPv6 table lookup e.g., IPv6-L3VPN (equivalent to per-VRF VPN label.
End.DT46Endpoint with decapsulation and specific IP table lookup e.g., IP-L3VPN (equivalent to per-VRF VPN label).
contextThe action optional context.
ipv6-nexthop IPV6-NEXTHOPThe IPv6 nexthop associated to the action.
IPV6-NEXTHOPAn IPv6 address.
ipv4-nexthop IPV4-NEXTHOPThe IPv4 nexthop associated to the action.
IPV4-NEXTHOPAn IPv4 address.
table-id <1-4294967295>The ID of the routing table associated to the action.
nexthop-l3vrf NEXTHOP-L3VRFL3vrf in which the nexthop will be found.
NEXTHOP-L3VRFvaluesDescription
<l3vrf-name>The l3vrf name.
defaultThe default l3vrf.
show ipv4-routes summary¶
vsr> show ipv4-routes summary [vrf VRF] [l3vrf L3VRF]
Show IPv4 routing table summary.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the l3vrf.
L3VRFThe l3vrf name.
Output Data¶
totalThe total number of routes.
routes-in-rib <uint32>The total number of routes in the Routing Information Database (RIB).
routes-in-fib <uint32>The total number of routes in the Forwarding Information Database (FIB).
routeThe number of routes per protocol.
protocol <string>The route protocol.
routes-in-rib <uint32>The number of routes in the Routing Information Database (RIB) for this protocol.
routes-in-fib <uint32>The number of routes in the Forwarding Information Database (FIB) for this protocol.
show ipv6-routes¶
vsr> show ipv6-routes [vrf VRF] [l3vrf L3VRF] [protocol <identityref>] [table <1-4294967295>] \
... [to TO]
Show IPv6 routing table.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the l3vrf.
L3VRFThe l3vrf name.
protocol <identityref>Filter routes by protocol.
table <1-4294967295>Non-main Kernel Routing Table.
to TOFind the route entry used to reach an IPv6 address or an exact network.
TOvaluesDescription
<X:X::X:X>An IPv6 address.
<X:X::X:X/M>An IPv6 prefix: address and CIDR mask.
Output Data¶
routeList of IPv6 routes matching the request.
destination DESTINATIONRoute destination.
DESTINATIONAn IPv6 prefix: address and CIDR mask.
protocol PROTOCOLRoute protocol.
PROTOCOLvaluesDescription
6peIPv6 Provider Edge routes.
srteSegment routing Traffic engineering routes.
bgpBorder Gateway Protocol (BGP).
localLocal routes.
connectedConnected routes (directly attached subnet or host).
kernelKernel routes.
isisIntermediate system to intermediate system (ISIS).
ospf6Open Shortest Path First (IPv6) (OSPFv3).
ripngRouting Information Protocol next-generation (IPv6) (RIPng).
staticStatically configured routes.
<string>No description.
l3vrf <string>L3vrf for this route.
table <uint32>Table where this route is located.
distance <uint8>Distance value for this route.
metric <uint32>Route metric.
tag <1-4294967295>Route tag.
selected true|falseRoute is the selected or preferred route for the prefix.
installed true|falseRoute is installed in the FIB.
installation-failed true|falseRoute installation in the FIB has failed.
queued true|falseTrue if the route has a pending FIB operation that has not completed.
uptime <string>Route uptime.
next-hopNext-hops for this route.
interface INTERFACEInterface used for this next-hop.
INTERFACEAn interface name.
address ADDRESSAddress used for this next-hop.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
source SOURCESource address used for this next-hop.
SOURCEAn IPv6 address.
blackhole BLACKHOLEBlackhole next-hop.
BLACKHOLEvaluesDescription
droppedSilently discard packets when matched.
rejectedEmit an ICMP unreachable when matched.
admin-prohibitedEmit an ICMP admin-prohibited when matched.
directly-connected true|falseTrue if the nexthop is directly connected.
on-link true|falseTrue if the nexthop is reachable locally.
backup true|falseTrue if the nexthop is a backup nexthop.
link-down true|falseTrue if the nexthop is reachable via an interface that is in down state.
weight <uint8>Weight to be used for this nexthop when ECMP is enabled.
active true|falseTrue if the nexthop is active.
duplicate true|falseTrue if the nexthop is a duplicate of another nexthop.
recursive true|falseTrue if the nexthop is resolved via another gateway.
unreachable true|falseTrue if the nexthop is not reachable.
installed true|falseTrue if the nexthop is installed in the FIB.
mpls-label MPLS-LABELLabel(s) for this route as key names or as ids (0 to 1048575).
MPLS-LABELvaluesDescription
<uint32>No description.
ipv4-explicit-nullMPLS IPv4 explicit NULL label (value: 0).
router-alertMPLS router alert label (value: 1).
ipv6-explicit-nullMPLS IPv6 explicit NULL label (value: 2).
implicit-nullMPLS implicit NULL label (value: 3).
eliMPLS ELI (Entropy Label Indicator) (value: 7).
galMPLS GAL (Generic Association Label) (value: 13).
oam-alertMPLS OAM (Operations, Administration, and Maintenance) alert label (value: 14).
extensionMPLS extension label (value: 15).
segment-routing-ipv6Segment routing next-hop.
segment-id SEGMENT-IDList of segments, each segment representing a specific source-routed path to send traffic, from the headend to the endpoint of the corresponding segment routing policy.
SEGMENT-IDAn IPv6 address.
action ACTIONAction realized when the packets are sent through this next-hop.
ACTIONvaluesDescription
<string>No description.
End.TEndpoint with specific IPv6 table lookup.
End.B6.EncapEndpoint with decapsulation and L2 cross-connect e.g., L2VPN use case.
End.DX2Endpoint with decapsulation and L2 cross-connect.
End.DT4Endpoint with decapsulation and specific IPv4 table lookup e.g., IPv4-L3VPN (equivalent to per-VRF VPN label).
End.DT6Endpoint with decapsulation and specific IPv6 table lookup e.g., IPv6-L3VPN (equivalent to per-VRF VPN label.
End.DT46Endpoint with decapsulation and specific IP table lookup e.g., IP-L3VPN (equivalent to per-VRF VPN label).
contextThe action optional context.
ipv6-nexthop IPV6-NEXTHOPThe IPv6 nexthop associated to the action.
IPV6-NEXTHOPAn IPv6 address.
ipv4-nexthop IPV4-NEXTHOPThe IPv4 nexthop associated to the action.
IPV4-NEXTHOPAn IPv4 address.
table-id <1-4294967295>The ID of the routing table associated to the action.
nexthop-l3vrf NEXTHOP-L3VRFL3vrf in which the nexthop will be found.
NEXTHOP-L3VRFvaluesDescription
<l3vrf-name>The l3vrf name.
defaultThe default l3vrf.
show ipv6-routes summary¶
vsr> show ipv6-routes summary [vrf VRF] [l3vrf L3VRF]
Show IPv6 routing table summary.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the l3vrf.
L3VRFThe l3vrf name.
Output Data¶
totalThe total number of routes.
routes-in-rib <uint32>The total number of routes in the Routing Information Database (RIB).
routes-in-fib <uint32>The total number of routes in the Forwarding Information Database (FIB).
routeThe number of routes per protocol.
protocol <string>The route protocol.
routes-in-rib <uint32>The number of routes in the Routing Information Database (RIB) for this protocol.
routes-in-fib <uint32>The number of routes in the Forwarding Information Database (FIB) for this protocol.
show mpls fec table¶
vsr> show mpls fec table [vrf <string>] [entry ENTRY]
Show MPLS FEC table information.
Input Parameters¶
vrf <string>The VRF to look into.
entry ENTRYThe entry to display.
ENTRYvaluesDescription
<A.B.C.D/M>An IPv4 prefix: address and CIDR mask.
<X:X::X:X/M>An IPv6 prefix: address and CIDR mask.
show mpls table¶
vsr> show mpls table [vrf <string>] [<16-1048575>]
Show MPLS table information.
Input Parameters¶
vrf <string>Specify the VRF.
<16-1048575>LSP to display information about.
show disk¶
vsr> show disk
Show Linux system disk usage.
Output Data¶
disk-usageThe disk information per device.
name <string>The disk name.
label <string>The disk label.
total <uint64>[KMGT]The disk total size.
partitionThe partition information per disk.
name <string>The partition name.
label <string>The partition label.
fstype <string>The partition filesystem type.
total <uint64>[KMGT]The partition total size.
available <uint64>[KMGT]The partition free size.
show numa statistics¶
vsr> show numa statistics
Shows per-NUMA-node memory statistics for processes and the operating system.
Output Data¶
statisticsList of current NUMA-nodes and their statistics.
node <string>Numa node unique identifier.
numa-hit <uint64>Number of pages successfully allocated to this node as intended.
numa-miss <uint64>Number of pages allocated on this node despite the process preferring some different node.
numa-foreign <uint64>Number of pages intended for this node but actually allocated on some different node.
interleave-hit <uint64>Number of interleave policy pages successfully allocated to this node.
local-node <uint64>Number of pages successfully allocated on this node by a process on this node.
other-node <uint64>Number of pages allocated on this node by a process on another node.
show processes¶
vsr> show processes
Shows the list of processes in the system.
Output Data¶
processThe list of monitored processes on the system.
name <string>The name of the process.
pid <uint64>The pid of the process.
fds <uint32>The number of file descriptors opened by this process.
memory <uint64>The memory used by this process.
busy <decimal64>The busy percentage for this process.
voluntary-context-switches <uint64>The number of voluntary context switches.
involuntary-context-switches <uint64>The number of involuntary context switches.
show soft-interrupts¶
vsr> show soft-interrupts
Show soft interrupts statistics per CPU.
Output Data¶
statisticsThe list of soft interrupts statistics per CPU.
cpu <string>The CPU number.
hi <uint64>Number of high priority tasklets.
timer <uint64>Number of timer interrupts.
net-tx <uint64>Number of interrupts for transmitting packets to network cards.
net-rx <uint64>Number of interrupts for receiving packets from network cards.
irq-poll <uint64>Number of polling interrupts.
block <uint64>Number of block-device I/O interrupts.
tasklet <uint64>Number of regular tasklets interrupts.
high-resolution-timer <uint64>Number of high resolution timer interrupts.
sched <uint64>Number of scheduling interrupts.
rcu <uint64>Number of read-copy-update interrupts.
show hardware¶
vsr> show hardware [type TYPE]
Shows machine hardware informations.
Input Parameters¶
type TYPEHardware types used in lshw -class <type>.
TYPEvaluesDescription
cpuCPU type.
memoryMemory type.
networkNetwork type.
diskDisk type.
Output Data¶
system-serial <string>System serial number if present on the machine.
cpu-unitList of all CPU units on the machine.
model-name <string>CPU model name.
vendor-name <string>CPU vendor name.
frequency <uint64>CPU frequency.
serial <string>CPU serial number.
cores <uint32>Number of cores on this CPU.
threads <uint32>Number of threads on this CPU.
capabilities <string>Comma separated list of this CPU capabilities.
memory-unitList of all memory units on the machine.
storage-size <uint64>Memory unit storage size in bytes.
description <string>Memory unit description.
model-name <string>Memory unit model name.
vendor-name <string>Memory unit vendor name.
serial <string>Memory unit serial number.
network-unitList of all network interface units on the machine.
description <string>Network interface description.
model-name <string>Network interface model name.
vendor-name <string>Network interface vendor name.
mac-address MAC-ADDRESSNetwork interface mac address.
MAC-ADDRESSAn IEEE 802 unicast MAC address i.e. the second digit is an even number. Moreover the mac address must not be 00:00:00:00:00:00.
speed <uint64>Network interface speed.
driver <string>Network interface driver.
firmware <string>Network interface firmware.
port <string>Network interface port.
disk-unitList of all memory units on the machine.
storage-size <uint64>Disk storage size in bytes.
description <string>Disk description.
model-name <string>Disk model name.
vendor-name <string>Disk vendor name.
serial <string>Disk serial number.
show power¶
vsr> show power
Show metrics related to power consumption. The data is only available when directly running on an Intel server.
Output Data¶
globalGlobal power metrics.
cpu-power <decimal64>Total CPU(s) consumption.
per-cpuPer CPU power metrics.
cpu <string>The CPU number.
busy <uint8>The busy percentage, i.e. when the processor is not in an hardware sleep state.
idle <uint8>The busy percentage, i.e. when the processor is in an hardware sleep state.
frequency <uint32>The current cpu frequency.
show bgp¶
Note
requires a Product License.
Note
This command is composed of 4 subcommands. Each command is a distinct netconf RPC that share the same syntax in the CLI but different input and output schemas that forces them to be separated.
show-bgp¶
vsr> show bgp nexthop-cache [nexthop NEXTHOP] pbr ipset [set <string>] iptable \
... [chain <string>] [vrf <string>] [l3vrf <string>] [l3vrfs] summary \
... [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] [neighbors] \
... neighbor [id ID] unnumbered-neighbor [interface INTERFACE] community-list \
... large-community-list extcommunity-list as-path-access-list [name <string>] \
... [route-map <string>] ipv4 [cidr-only] [statistics] summary [STATE] \
... [neighbor NEIGHBOR] [remote-as REMOTE-AS] community-list [name <string>] \
... [exact-match] community [VALUE] [exact-match] large-community-list \
... [name <string>] [exact-match] large-community [VALUE] [exact-match] \
... [route-map <string>] flowspec ip [VALUE] [bestpath] [multipath] \
... prefix [value VALUE] [bestpath] [multipath] [longer-prefixes] \
... [detail] [cidr-only] [statistics] summary [STATE] [neighbor NEIGHBOR] \
... [remote-as REMOTE-AS] community-list [name <string>] [exact-match] \
... community [VALUE] [exact-match] large-community-list [name <string>] \
... [exact-match] large-community [VALUE] [exact-match] [route-map <string>] \
... unicast neighbor [id ID] [prefix-counts] received [prefix-filter] \
... [dampened-routes] [flap-statistics] [filtered-routes] [received-routes] \
... [cidr-only] [statistics] summary [STATE] [neighbor NEIGHBOR] \
... [remote-as REMOTE-AS] community-list [name <string>] [exact-match] \
... community [VALUE] [exact-match] large-community-list [name <string>] \
... [exact-match] large-community [VALUE] [exact-match] [route-map <string>] \
... unnumbered-neighbor [interface INTERFACE] [filtered-routes] [received-routes] \
... multicast neighbor [id ID] [prefix-counts] [advertised-routes] \
... [dampened-routes] [flap-statistics] [filtered-routes] [received-routes] \
... [cidr-only] [statistics] summary [STATE] [neighbor NEIGHBOR] \
... [remote-as REMOTE-AS] community-list [name <string>] [exact-match] \
... community [VALUE] [exact-match] large-community-list [name <string>] \
... [exact-match] large-community [VALUE] [exact-match] [route-map <string>] \
... labeled-unicast neighbor [id ID] [dampened-routes] [flap-statistics] \
... [filtered-routes] [received-routes] [cidr-only] [statistics] \
... summary [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] community-list \
... [name <string>] [exact-match] community [VALUE] [exact-match] \
... large-community-list [name <string>] [exact-match] large-community \
... [VALUE] [exact-match] [route-map <string>] vpn [route-distinguisher ROUTE-DISTINGUISHER] \
... neighbor [id ID] [routes] [prefix-counts] [advertised-routes] \
... [dampened-routes] [flap-statistics] [filtered-routes] [received-routes] \
... ip [VALUE] [bestpath] [multipath] prefix [value VALUE] [bestpath] \
... [multipath] [longer-prefixes] [cidr-only] [statistics] summary \
... [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] community-list \
... [name <string>] [exact-match] community [VALUE] [exact-match] \
... large-community-list [name <string>] [exact-match] large-community \
... [VALUE] [exact-match] [route-map <string>] neighbor [id ID] [prefix-counts] \
... received [prefix-filter] [dampened-routes] [flap-statistics] \
... [filtered-routes] [received-routes] [neighbors] ipv6 [cidr-only] \
... [statistics] summary [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] \
... community-list [name <string>] [exact-match] community [VALUE] \
... [exact-match] large-community-list [name <string>] [exact-match] \
... large-community [VALUE] [exact-match] [route-map <string>] flowspec \
... ip [value VALUE] [bestpath] [multipath] prefix [VALUE] [bestpath] \
... [multipath] [longer-prefixes] [detail] [cidr-only] [statistics] \
... summary [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] community-list \
... [name <string>] [exact-match] community [VALUE] [exact-match] \
... large-community-list [name <string>] [exact-match] large-community \
... [VALUE] [exact-match] [route-map <string>] unicast neighbor [id ID] \
... [prefix-counts] received [prefix-filter] [dampened-routes] [flap-statistics] \
... [filtered-routes] [received-routes] [cidr-only] [statistics] \
... summary [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] community-list \
... [name <string>] [exact-match] community [VALUE] [exact-match] \
... large-community-list [name <string>] [exact-match] large-community \
... [VALUE] [exact-match] [route-map <string>] unnumbered-neighbor \
... [interface INTERFACE] [filtered-routes] [received-routes] multicast \
... neighbor [id ID] [prefix-counts] [advertised-routes] [dampened-routes] \
... [flap-statistics] [filtered-routes] [received-routes] [cidr-only] \
... [statistics] summary [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] \
... community-list [name <string>] [exact-match] community [VALUE] \
... [exact-match] large-community-list [name <string>] [exact-match] \
... large-community [VALUE] [exact-match] [route-map <string>] labeled-unicast \
... neighbor [id ID] [dampened-routes] [flap-statistics] [filtered-routes] \
... [received-routes] [cidr-only] [statistics] summary [STATE] [neighbor NEIGHBOR] \
... [remote-as REMOTE-AS] community-list [name <string>] [exact-match] \
... community [VALUE] [exact-match] large-community-list [name <string>] \
... [exact-match] large-community [VALUE] [exact-match] [route-map <string>] \
... vpn neighbor [id ID] [routes] [prefix-counts] [advertised-routes] \
... [dampened-routes] [flap-statistics] [filtered-routes] [received-routes] \
... ip [value VALUE] [bestpath] [multipath] prefix [VALUE] [bestpath] \
... [multipath] [longer-prefixes] [cidr-only] [statistics] summary \
... [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] community-list \
... [name <string>] [exact-match] community [VALUE] [exact-match] \
... large-community-list [name <string>] [exact-match] large-community \
... [VALUE] [exact-match] [route-map <string>] neighbor [id ID] [prefix-counts] \
... received [prefix-filter] [dampened-routes] [flap-statistics] \
... [filtered-routes] [received-routes] [neighbors] l2vpn evpn [vnis] \
... [vni VNI] [NET] summary [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS] \
... [overlay] [tags] neighbor NEIGHBOR [advertised-routes] [routes] \
... [route-distinguisher ROUTE-DISTINGUISHER] route [type TYPE] [detail] \
... l3vpn label-exported-nexthop-cache [detail] label-incoming-nexthop-cache \
... [detail] link-state non-vpn neighbor [id ID] [filtered-routes] \
... [received-routes] [advertised-routes] [detail-routes] summary \
... [STATE] [neighbor NEIGHBOR] [remote-as REMOTE-AS]
Show BGP information.
Input Parameters¶
nexthop-cacheDisplay the BGP nexthop cache information. This cache lists the BGP nexthops from the incoming BGP updates, and indicates how to reach those nexthops.
nexthop NEXTHOPDisplay the detailed information for the given BGP nexthop entry from the BGP nexthop cache. The Paths that use that nexthop are displayed.
NEXTHOPvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
pbrDisplay information about PBR configured by BGP.
ipsetDisplay information about PBR IPSETs configured by BGP.
set <string>Display information about this set.
iptableDisplay information about PBR IPTables chainsa configured by BGP.
chain <string>Display information about this chain.
vrf <string>Specify the VRF.
l3vrf <string>Specify the L3VRF.
l3vrfsShow BGP VRFs.
summaryDisplay summary of BGP neighbor(s) status, this includes the whole bgp context.
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
neighborsDisplay information about all BGP neighbors.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
unnumbered-neighborDisplay information about BGP unnumbered neighbor.
interface INTERFACEReferenced interface name.
INTERFACEAn interface name.
community-listDisplay information about BGP community lists (standard and expanded).
large-community-listDisplay information about BGP large community lists (standard and expanded).
extcommunity-listDisplay information about BGP extcommunity lists (standard and expanded).
as-path-access-listDisplay information about AS-path access lists.
name <string>Display information about a certain AS-Path access list.
route-map <string>Display information about this route map.
ipv4Display information about BGP IPv4.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
flowspecDisplay information for flowspec address family.
ipDisplay this address in the BGP routing table.
VALUEDisplay this address in the BGP routing table.
VALUEAn IPv4 address.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
prefixDisplay this network in the BGP routing table.
value VALUEDisplay this prefix in the BGP routing table.
VALUEAn IPv4 prefix: address and CIDR mask.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
longer-prefixesDisplay route and more specific routes.
detailDisplay detailed information on flowspec entries.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
unicastDisplay information for unicast address family.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
prefix-countsDisplay detailed prefix count information.
receivedDisplay information received from a BGP neighbor.
prefix-filterDisplay the prefixlist filter.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
unnumbered-neighborDisplay information about BGP unnumbered neighbor.
interface INTERFACEUnnumbered neighbor interface name.
INTERFACEAn interface name.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
multicastDisplay information for multicast address family.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
prefix-countsDisplay detailed prefix count information.
advertised-routesDisplay the routes advertised to a BGP neighbor.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
labeled-unicastDisplay information for labeled unicast address family.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
vpnDisplay information for VPN address family.
route-distinguisher ROUTE-DISTINGUISHERDisplay information for a route distinguisher.
ROUTE-DISTINGUISHERvaluesDescription
<uint32:uint16>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<1-65535.0-65535:uint16>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<uint16:uint32>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<0.1-65535:uint32>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<ipv4-address:uint16>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
routesDisplay routes learned from neighbor.
prefix-countsDisplay detailed prefix count information.
advertised-routesDisplay the routes advertised to a BGP neighbor.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
ipDisplay this address in the BGP routing table.
VALUEDisplay this address in the BGP routing table.
VALUEAn IPv4 address.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
prefixDisplay this network in the BGP routing table.
value VALUEDisplay this prefix in the BGP routing table.
VALUEAn IPv4 prefix: address and CIDR mask.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
longer-prefixesDisplay route and more specific routes.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
prefix-countsDisplay detailed prefix count information.
receivedDisplay information received from a BGP neighbor.
prefix-filterDisplay the prefixlist filter.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
neighborsDisplay information about all BGP neighbors.
ipv6Display information about BGP IPv6.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
flowspecDisplay information for flowspec address family.
ipDisplay this address in the BGP routing table.
value VALUEDisplay this address in the BGP routing table.
VALUEAn IPv6 address.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
prefixDisplay this network in the BGP routing table.
VALUEDisplay this prefix in the BGP routing table.
VALUEAn IPv6 prefix: address and CIDR mask.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
longer-prefixesDisplay route and more specific routes.
detailDisplay detailed information on flowspec entries.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
unicastDisplay information for unicast address family.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
prefix-countsDisplay detailed prefix count information.
receivedDisplay information received from a BGP neighbor.
prefix-filterDisplay the prefixlist filter.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
unnumbered-neighborDisplay information about BGP unnumbered neighbor.
interface INTERFACEUnnumbered neighbor interface name.
INTERFACEAn interface name.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
multicastDisplay information for multicast address family.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
prefix-countsDisplay detailed prefix count information.
advertised-routesDisplay the routes advertised to a BGP neighbor.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
labeled-unicastDisplay information for labeled unicast address family.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
vpnDisplay information for VPN address family.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
routesDisplay routes learned from neighbor.
prefix-countsDisplay detailed prefix count information.
advertised-routesDisplay the routes advertised to a BGP neighbor.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
ipDisplay this address in the BGP routing table.
value VALUEDisplay this address in the BGP routing table.
VALUEAn IPv6 address.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
prefixDisplay this network in the BGP routing table.
VALUEDisplay this prefix in the BGP routing table.
VALUEAn IPv6 prefix: address and CIDR mask.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
longer-prefixesDisplay route and more specific routes.
cidr-onlyDisplay only routes with non-natural netmask.
statisticsDisplay BGP RIB advertisement statistics.
summaryDisplay summary of BGP IPv4/IPv6 neighbors status. Can be filtered by subsequent address family (SAFI).
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
community-listDisplay routes matching the community-list.
name <string>BGP community list name.
exact-matchExact match of the communities.
communityDisplay routes matching the communities.
VALUEBGP community value.
VALUEvaluesDescription
local-ASLocal AS.
no-advertiseDo not advertise.
no-exportDo not export.
internetInternet. This is a special community. When used in a community-list, it functions as a wildcard, meaning it will match any specified community. When it is assigned to a prefix, the 0:0 community is added. The 0:0 community is not recognized by IANA and is mainly used to maintain backward compatibility with certain vendors, such as Cisco.
graceful-shutdownGraceful-shutdown.
accept-ownAccept-own.
route-filter-translated-v4Route-filter-translated-v4.
route-filter-v4Route-filter-v4.
route-filter-translated-v6Route-filter-translated-v6.
route-filter-v6Route-filter-v6.
llgr-staleLlgr-stale.
no-llgrNo-llgr.
accept-own-nexthopAccept-own-nexthop.
blackholeBlackhole.
no-peerNo-peer.
<string>Community attribute.
exact-matchExact match of the communities.
large-community-listDisplay routes matching the large-community-list.
name <string>BGP large community list name.
exact-matchExact match of the large communities.
large-communityDisplay routes matching the large communities.
VALUEBGP large community value.
VALUELarge community attribute.
exact-matchExact match of the large communities.
route-map <string>Display information about this route map.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
prefix-countsDisplay detailed prefix count information.
receivedDisplay information received from a BGP neighbor.
prefix-filterDisplay the prefixlist filter.
dampened-routesDisplay the dampened routes received from neighbor.
flap-statisticsDisplay the flap statistics of the routes learned from neighbor.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
neighborsDisplay information about all BGP neighbors.
l2vpnDisplay Layer 2 Virtual Private Network information.
evpnDisplay Ethernet Virtual Private Network information.
vnisDisplay all VNIs information.
vni VNIDisplay VNI information.
VNIType definition representing VXLAN Segment ID / VXLAN Network Identifier value.
NETNetwork in the BGP routing table to display.
NETvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
summaryDisplay the summary of l2vpn BGP neighbors status.
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
overlayDisplay BGP Overlay Information for prefixes.
tagsDisplay BGP tags for prefixes.
neighborDetailed information on TCP and BGP neighbor connections.
NEIGHBOR(mandatory)Neighbor to display information about.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
advertised-routesDisplay the routes advertised to a BGP neighbor.
routesDisplay routes learned from neighbor.
route-distinguisher ROUTE-DISTINGUISHERDisplay information for a route distinguisher.
ROUTE-DISTINGUISHERvaluesDescription
<uint32:uint16>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<1-65535.0-65535:uint16>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<uint16:uint32>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<0.1-65535:uint32>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
<ipv4-address:uint16>Type definition for extended community attributes. Possible formats: <4b AS>:<2b value>, <2b AS>:<4b value> or <4b IPv4>:<2b value> (see RFC4364 section 4.2). <2b AS> or <4b AS> can be expressed in plain, dot and dot+ format.
routeDetailed information BPG L2VPN EVPN routes.
type TYPESpecify route type.
TYPEvaluesDescription
macipMAC-IP (Type-2) route.
multicastMulticast (Type-3) route.
prefixPrefix (Type-5) route.
detailDisplay detail information.
l3vpnDisplay Layer 3 Virtual Private Network information.
label-exported-nexthop-cacheDisplay label nexthop cache for exported nexthops.
detailDisplay detail information.
label-incoming-nexthop-cacheDisplay label nexthop cache for incoming nexthops.
detailDisplay detail information.
link-stateDisplay link-state information.
non-vpnDisplay link-state non VPN information.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
filtered-routesDisplay the filtered routes received from neighbor.
received-routesDisplay the received routes from neighbor.
advertised-routesDisplay the routes advertised to a BGP neighbor.
detail-routesDisplay link state routes with details.
summaryDisplay the summary of l2vpn BGP neighbors status.
STATEThe State of BGP neighbor(s).
STATEvaluesDescription
establishedSummary of BGP established neighbor(s).
failedSummary of BGP failed neighbor(s).
neighbor NEIGHBORDisplay information about one BGP neighbor.
NEIGHBORvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-as REMOTE-ASThe Summary of BGP remote-as.
REMOTE-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
externalSummary of BGP external remote-as.
internalSummary of BGP internal remote-as.
show-bgp-ip¶
vsr> show bgp ipv4 [details] [unicast] [multicast] [labeled-unicast] neighbor \
... [id ID] advertised-routes [details] ipv6 [details] [unicast] \
... [multicast] [labeled-unicast] neighbor [id ID] advertised-routes \
... [details] [vrf VRF] [l3vrf L3VRF]
Show BGP IPv4/6 route, path and nexthop information.
Input Parameters¶
ipv4Display IPv4 information.
detailsDisplay detailed information.
unicastShow unicast routes.
multicastShow multicast routes.
labeled-unicastShow labeled unicast routes.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<ifname>{1,15}An interface name.
advertised-routesDisplay the routes advertised to a BGP neighbor.
detailsDisplay detailed information.
ipv6Display IPv6 information.
detailsDisplay detailed information.
unicastShow unicast routes.
multicastShow multicast routes.
labeled-unicastShow labeled unicast routes.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<ifname>{1,15}An interface name.
advertised-routesDisplay the routes advertised to a BGP neighbor.
detailsDisplay detailed information.
vrf VRFSpecify the VRF in which to show the BGP routes.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the L3VRF.
L3VRFThe l3vrf name.
Output Data¶
l3vrfThe l3vrf details.
id <uint32>The l3vrf identifier.
name <string>The l3vrf name.
table-version <uint32>The BGP table version counter, representing each time the BGP routing table is updated.
router-id ROUTER-IDThe router identifier.
ROUTER-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
default-local-preference <uint32>The default local preference value used by AS to select a preferred path; higher values indicate preferred path.
local-as LOCAL-ASThe local autonomous system number.
LOCAL-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
routeThe BGP routing table.
prefix PREFIXThe network ip prefix of the BGP route.
PREFIXvaluesDescription
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
version <uint32>The version of the route.
local-label <uint32>The local label of the route.
route-distinguisher <string>The route distinguisher.
advertised-toThe neighbors to which the route is advertised.
link LINKThe link used to advertise the route.
LINKvaluesDescription
<ifname>{1,15}An interface name.
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<string>No description.
host-name <string>The host-name of the neighbor.
pathThe paths of this route.
as-path-segmentThe AS path segments.
type TYPEThe type of the AS path segment.
TYPEvaluesDescription
invalidThe AS path is invalid.
setThe AS path is a set.
sequenceThe AS path is a sequence.
confederation-sequenceThe AS path is a confederation sequence.
confederation-setThe AS path is a confederation set.
<string>No description.
sequence SEQUENCEThe AS path segment list.
SEQUENCEvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<string>No description.
metric <uint32>The metric of the route.
local-preference <uint32>The local preference of the route.
weight <uint32>The weight of the route.
flags FLAGSThe flags of the route.
FLAGSvaluesDescription
is-validThe route is valid.
is-removedThe route is removed.
is-staleThe route is stale.
is-suppressedThe route is suppressed.
is-historyThe route is withdrawn but kept as historical in a dampening context.
is-dampedThe route is damped.
is-multipathThe route is multipath.
is-sourcedThe route is locally sourced.
is-localThe route is local.
is-bestpathThe route is the bestpath.
is-registered-for-labelThe route is registered for label.
is-aggregatedThe route is aggregated.
is-atomic-aggregatedThe route is atomic aggregated.
origin ORIGINThe origin of the route.
ORIGINvaluesDescription
igpThe origin is IGP.
egpThe origin is EGP.
incompleteThe origin is incomplete.
<string>No description.
nexthop-detailsThe next hop details.
announce-itself true|falseIndicates if the router announces itself as the next hop for routes sent to BGP peers.
l3vrfThe next hop l3vrf details.
name NAMEThe next hop l3vrf name.
NAMEvaluesDescription
mainThe main vrf.
<string>The vrf name.
id <uint32>The next hop l3vrf identifier.
bestpath-selection-reason BESTPATH-SELECTION-REASONThe path selection reason.
BESTPATH-SELECTION-REASONvaluesDescription
nothing-to-selectNo paths were available or eligible for BGP best path selection.
first-path-receivedThe first path received was selected, typically due to limited options.
evpn-sticky-macSelected based on EVPN Sticky MAC address to maintain consistent forwarding.
evpn-sequence-numberPreference given to paths with the highest EVPN sequence number for route consistency.
evpn-lower-ipChoose the path with the lowest IP address in EVPN for deterministic tie-breaking.
evpn-local-es-pathPath selected due to being local to the Ethernet Segment (ES) in EVPN.
evpn-non-proxyNon-proxy paths in EVPN were preferred over proxy paths for direct reachability.
weightSelected based on the highest BGP weight, typically a local preference mechanism.
local-preferenceChoose the path with the highest local preference within the AS.
local-routePreference given to locally originated routes over externally received ones.
confederation-based-as-pathChoose the path with the shortest AS path within the BGP confederation boundaries.
as-pathPreference based on the shortest AS path length for external paths.
originPath selected based on BGP origin type; IGP > EGP > Incomplete.
medChoose the path with the lowest Multi-Exit Discriminator (MED) for external route prioritization.
peer-typePreference given to paths based on BGP peer type (e.g., internal over external).
confederation-peer-typePath selection influenced by peer type within a BGP confederation.
igp-metricSelected path with the lowest IGP metric to the next-hop.
older-pathPreference given to the older path to maintain stability in routing.
router-idPath chosen based on the lowest originating router identifier as a tie-breaker.
cluster-lengthChoose the path with the shortest BGP cluster list length for route reflectors.
path-stalenessPreference given to the freshest (non-stale) BGP path.
locally-configured-routeLocally configured static routes were prioritized over dynamically learned ones.
neighbor-ipPath selected based on the lowest BGP neighbor IP address as a tie-breaker.
nothing-left-to-compareFinal selection occurred when no other criteria differentiated the paths.
<string>The reason why this BGP path has been selected over another one.
community COMMUNITYThe BGP communities of the route.
COMMUNITYvaluesDescription
internetAdvertise the prefix to all BGP neighbors (INTERNET).
graceful-shutdownGracefully shutdown paths that a router might use when its peer is about to be intentionally shut down (GRACEFUL_SHUTDOWN).
accept-ownThe router may accept a route whose origin matches the receiving speaker (ACCEPT_OWN).
route-filter-ipv4Route Targets are attached as-is for VPNv4 route filtering (ROUTE_FILTER_V4).
route-filter-ipv6Route Targets are attached as-is for VPNv6 route filtering (ROUTE_FILTER_V6).
route-filter-translated-ipv4Translated Route Targets are attached for VPNv4 route filtering (ROUTE_FILTER_TRANSLATED_V4).
route-filter-translated-ipv6Translated Route Targets are attached for VPNv6 route filtering (ROUTE_FILTER_TRANSLATED_V6).
long-lived-graceful-restart-staleThe route retained for a longer period of time (LLGR_STALE).
no-long-lived-graceful-restartThe BGP speaker will not treat this route according to the LLGR procedure (NO_LLGR).
accept-own-nexthopThe router may accept a route whose nexthop matches the receiving speaker (ACCEPT_OWN_NEXTHOP).
blackholeThe router can discard any traffic sent towards this prefix (BLACKHOLE).
no-exportPrevents the route from being advertised outside the local AS, it remains within the AS and is not shared with external peers (NO_EXPORT).
no-advertiseRestricts the route from being advertised to any peers, internal or external (NO_ADVERTISE).
local-asEnsures the route is shared only within confederation sub-AS but not with external AS (LOCAL_AS).
no-peerThe route is not advertised to any peer (NO_PEER).
<string>No description.
large-community <string>The large BGP communities of the route.
extended-community <string>The extended BGP communities of the route.
nexthopThe next hops of the route.
address ADDRESSThe address of the next hop.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
host-name <string>The host-name of the next hop.
address-family ADDRESS-FAMILYThe address family of the next hop.
ADDRESS-FAMILYvaluesDescription
ipv4IPv4.
ipv6IPv6.
<string>No description.
metric <uint32>The metric of the next hop.
flags FLAGSThe flags of the next hop.
FLAGSvaluesDescription
is-accessibleThe next hop is accessible.
is-usedThe next hop is used.
is-import-check-enabledThe import check is enabled.
scope SCOPEThe scope of the next hop.
SCOPEvaluesDescription
globalAn ipv6 global address.
link-localAn ipv6 link-local address.
<string>No description.
peerThe peer of the route.
id IDThe peer identifier.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
router-id ROUTER-IDThe peer router identifier.
ROUTER-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
host-name <string>The peer host-name.
interface <string>The interface used to communicate with the peer.
domain-name <string>The peer domain name.
type TYPEThe peer type.
TYPEvaluesDescription
internalInternal.
confederation-internalConfederation internal.
externalExternal.
confederation-externalConfederation external.
<string>No description.
rpki-state RPKI-STATEThe RPKI state.
RPKI-STATEvaluesDescription
not-foundThe RPKI is not found.
not-usedThe RPKI is not used.
validThe RPKI is valid.
invalidThe RPKI is invalid.
<string>No description.
originator-id ORIGINATOR-IDThe router identifier of the router that created the BGP update.
ORIGINATOR-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
tag <uint32>The tag of the route.
imported-from IMPORTED-FROMThe IP address from which the route was imported.
IMPORTED-FROMvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<string>No description.
remote-label <uint32>The remote label of this path.
remote-sid REMOTE-SIDThe remote segment identifier of this path.
REMOTE-SIDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
cluster CLUSTERThe cluster list.
CLUSTERvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
aggregatorThe aggregator information.
as ASThe aggregator AS.
ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
id IDThe aggregator identifier.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
received-from RECEIVED-FROMWhether the route is received from a route reflector or route server client.
RECEIVED-FROMvaluesDescription
reflector-clientThe route is received from a route reflector client.
server-clientThe route is received from a route server client.
<string>No description.
dampening-flag DAMPENING-FLAGThe dampening information.
DAMPENING-FLAGvaluesDescription
have-historyThe route have a dampening history.
is-suppressedThe route is suppressed.
<string>No description.
last-update LAST-UPDATEThe last update of the route.
LAST-UPDATEThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
show-bgp-ip-network¶
vsr> show bgp ipv4 [unicast] [multicast] [labeled-unicast] prefix [value VALUE] \
... [bestpath] [multipath] [longer-prefixes] ip [VALUE] [bestpath] \
... [multipath] ipv6 [unicast] [multicast] [labeled-unicast] prefix \
... [VALUE] [bestpath] [multipath] [longer-prefixes] ip [value VALUE] \
... [bestpath] [multipath] [vrf VRF] [l3vrf L3VRF]
Show BGP IPv4/6 single route, paths and nexthop information.
Input Parameters¶
ipv4Display IPv4 information.
unicastShow unicast routes.
multicastShow multicast routes.
labeled-unicastShow labeled unicast routes.
prefixDisplay this network in the BGP routing table.
value VALUEDisplay this prefix in the BGP routing table.
VALUEAn IPv4 prefix: address and CIDR mask.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
longer-prefixesDisplay route and more specific routes.
ipDisplay this address in the BGP routing table.
VALUEDisplay this address in the BGP routing table.
VALUEAn IPv4 address.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
ipv6Display IPv6 information.
unicastShow unicast routes.
multicastShow multicast routes.
labeled-unicastShow labeled unicast routes.
prefixDisplay this network in the BGP routing table.
VALUEDisplay this prefix in the BGP routing table.
VALUEAn IPv6 prefix: address and CIDR mask.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
longer-prefixesDisplay route and more specific routes.
ipDisplay this address in the BGP routing table.
value VALUEDisplay this address in the BGP routing table.
VALUEAn IPv6 address.
bestpathDisplay only the best path.
multipathDisplay only multipaths.
vrf VRFSpecify the VRF in which to show the BGP routes.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the L3VRF.
L3VRFThe l3vrf name.
Output Data¶
prefix PREFIXThe network ip prefix of the BGP route.
PREFIXvaluesDescription
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
version <uint32>The version of the route.
local-label <uint32>The local label of the route.
route-distinguisher <string>The route distinguisher.
advertised-toThe neighbors to which the route is advertised.
link LINKThe link used to advertise the route.
LINKvaluesDescription
<ifname>{1,15}An interface name.
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<string>No description.
host-name <string>The host-name of the neighbor.
pathThe paths of this route.
as-path-segmentThe AS path segments.
type TYPEThe type of the AS path segment.
TYPEvaluesDescription
invalidThe AS path is invalid.
setThe AS path is a set.
sequenceThe AS path is a sequence.
confederation-sequenceThe AS path is a confederation sequence.
confederation-setThe AS path is a confederation set.
<string>No description.
sequence SEQUENCEThe AS path segment list.
SEQUENCEvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<string>No description.
metric <uint32>The metric of the route.
local-preference <uint32>The local preference of the route.
weight <uint32>The weight of the route.
flags FLAGSThe flags of the route.
FLAGSvaluesDescription
is-validThe route is valid.
is-removedThe route is removed.
is-staleThe route is stale.
is-suppressedThe route is suppressed.
is-historyThe route is withdrawn but kept as historical in a dampening context.
is-dampedThe route is damped.
is-multipathThe route is multipath.
is-sourcedThe route is locally sourced.
is-localThe route is local.
is-bestpathThe route is the bestpath.
is-registered-for-labelThe route is registered for label.
is-aggregatedThe route is aggregated.
is-atomic-aggregatedThe route is atomic aggregated.
origin ORIGINThe origin of the route.
ORIGINvaluesDescription
igpThe origin is IGP.
egpThe origin is EGP.
incompleteThe origin is incomplete.
<string>No description.
nexthop-detailsThe next hop details.
announce-itself true|falseIndicates if the router announces itself as the next hop for routes sent to BGP peers.
l3vrfThe next hop l3vrf details.
name NAMEThe next hop l3vrf name.
NAMEvaluesDescription
mainThe main vrf.
<string>The vrf name.
id <uint32>The next hop l3vrf identifier.
bestpath-selection-reason BESTPATH-SELECTION-REASONThe path selection reason.
BESTPATH-SELECTION-REASONvaluesDescription
nothing-to-selectNo paths were available or eligible for BGP best path selection.
first-path-receivedThe first path received was selected, typically due to limited options.
evpn-sticky-macSelected based on EVPN Sticky MAC address to maintain consistent forwarding.
evpn-sequence-numberPreference given to paths with the highest EVPN sequence number for route consistency.
evpn-lower-ipChoose the path with the lowest IP address in EVPN for deterministic tie-breaking.
evpn-local-es-pathPath selected due to being local to the Ethernet Segment (ES) in EVPN.
evpn-non-proxyNon-proxy paths in EVPN were preferred over proxy paths for direct reachability.
weightSelected based on the highest BGP weight, typically a local preference mechanism.
local-preferenceChoose the path with the highest local preference within the AS.
local-routePreference given to locally originated routes over externally received ones.
confederation-based-as-pathChoose the path with the shortest AS path within the BGP confederation boundaries.
as-pathPreference based on the shortest AS path length for external paths.
originPath selected based on BGP origin type; IGP > EGP > Incomplete.
medChoose the path with the lowest Multi-Exit Discriminator (MED) for external route prioritization.
peer-typePreference given to paths based on BGP peer type (e.g., internal over external).
confederation-peer-typePath selection influenced by peer type within a BGP confederation.
igp-metricSelected path with the lowest IGP metric to the next-hop.
older-pathPreference given to the older path to maintain stability in routing.
router-idPath chosen based on the lowest originating router identifier as a tie-breaker.
cluster-lengthChoose the path with the shortest BGP cluster list length for route reflectors.
path-stalenessPreference given to the freshest (non-stale) BGP path.
locally-configured-routeLocally configured static routes were prioritized over dynamically learned ones.
neighbor-ipPath selected based on the lowest BGP neighbor IP address as a tie-breaker.
nothing-left-to-compareFinal selection occurred when no other criteria differentiated the paths.
<string>The reason why this BGP path has been selected over another one.
community COMMUNITYThe BGP communities of the route.
COMMUNITYvaluesDescription
internetAdvertise the prefix to all BGP neighbors (INTERNET).
graceful-shutdownGracefully shutdown paths that a router might use when its peer is about to be intentionally shut down (GRACEFUL_SHUTDOWN).
accept-ownThe router may accept a route whose origin matches the receiving speaker (ACCEPT_OWN).
route-filter-ipv4Route Targets are attached as-is for VPNv4 route filtering (ROUTE_FILTER_V4).
route-filter-ipv6Route Targets are attached as-is for VPNv6 route filtering (ROUTE_FILTER_V6).
route-filter-translated-ipv4Translated Route Targets are attached for VPNv4 route filtering (ROUTE_FILTER_TRANSLATED_V4).
route-filter-translated-ipv6Translated Route Targets are attached for VPNv6 route filtering (ROUTE_FILTER_TRANSLATED_V6).
long-lived-graceful-restart-staleThe route retained for a longer period of time (LLGR_STALE).
no-long-lived-graceful-restartThe BGP speaker will not treat this route according to the LLGR procedure (NO_LLGR).
accept-own-nexthopThe router may accept a route whose nexthop matches the receiving speaker (ACCEPT_OWN_NEXTHOP).
blackholeThe router can discard any traffic sent towards this prefix (BLACKHOLE).
no-exportPrevents the route from being advertised outside the local AS, it remains within the AS and is not shared with external peers (NO_EXPORT).
no-advertiseRestricts the route from being advertised to any peers, internal or external (NO_ADVERTISE).
local-asEnsures the route is shared only within confederation sub-AS but not with external AS (LOCAL_AS).
no-peerThe route is not advertised to any peer (NO_PEER).
<string>No description.
large-community <string>The large BGP communities of the route.
extended-community <string>The extended BGP communities of the route.
nexthopThe next hops of the route.
address ADDRESSThe address of the next hop.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
host-name <string>The host-name of the next hop.
address-family ADDRESS-FAMILYThe address family of the next hop.
ADDRESS-FAMILYvaluesDescription
ipv4IPv4.
ipv6IPv6.
<string>No description.
metric <uint32>The metric of the next hop.
flags FLAGSThe flags of the next hop.
FLAGSvaluesDescription
is-accessibleThe next hop is accessible.
is-usedThe next hop is used.
is-import-check-enabledThe import check is enabled.
scope SCOPEThe scope of the next hop.
SCOPEvaluesDescription
globalAn ipv6 global address.
link-localAn ipv6 link-local address.
<string>No description.
peerThe peer of the route.
id IDThe peer identifier.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
router-id ROUTER-IDThe peer router identifier.
ROUTER-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
host-name <string>The peer host-name.
interface <string>The interface used to communicate with the peer.
domain-name <string>The peer domain name.
type TYPEThe peer type.
TYPEvaluesDescription
internalInternal.
confederation-internalConfederation internal.
externalExternal.
confederation-externalConfederation external.
<string>No description.
rpki-state RPKI-STATEThe RPKI state.
RPKI-STATEvaluesDescription
not-foundThe RPKI is not found.
not-usedThe RPKI is not used.
validThe RPKI is valid.
invalidThe RPKI is invalid.
<string>No description.
originator-id ORIGINATOR-IDThe router identifier of the router that created the BGP update.
ORIGINATOR-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
tag <uint32>The tag of the route.
imported-from IMPORTED-FROMThe IP address from which the route was imported.
IMPORTED-FROMvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<string>No description.
remote-label <uint32>The remote label of this path.
remote-sid REMOTE-SIDThe remote segment identifier of this path.
REMOTE-SIDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
cluster CLUSTERThe cluster list.
CLUSTERvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
aggregatorThe aggregator information.
as ASThe aggregator AS.
ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
id IDThe aggregator identifier.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
received-from RECEIVED-FROMWhether the route is received from a route reflector or route server client.
RECEIVED-FROMvaluesDescription
reflector-clientThe route is received from a route reflector client.
server-clientThe route is received from a route server client.
<string>No description.
dampening-flag DAMPENING-FLAGThe dampening information.
DAMPENING-FLAGvaluesDescription
have-historyThe route have a dampening history.
is-suppressedThe route is suppressed.
<string>No description.
last-update LAST-UPDATEThe last update of the route.
LAST-UPDATEThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
show-bgp-ip-neighbor-routes¶
vsr> show bgp ipv4 neighbor [id ID] routes [unicast] [multicast] [labeled-unicast] \
... ipv6 neighbor [id ID] routes [unicast] [multicast] [labeled-unicast] \
... [vrf VRF] [l3vrf L3VRF]
Show BGP IPv6 neighbor route information.
Input Parameters¶
ipv4Display IPv4 information.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<ifname>{1,15}An interface name.
routes(mandatory)Display routes learned from neighbor.
unicastShow unicast routes.
multicastShow multicast routes.
labeled-unicastShow labeled unicast routes.
ipv6Display IPv6 information.
neighborDisplay information about one BGP neighbor.
id IDDisplay information about one BGP neighbor.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<ifname>{1,15}An interface name.
routes(mandatory)Display routes learned from neighbor.
unicastShow unicast routes.
multicastShow multicast routes.
labeled-unicastShow labeled unicast routes.
vrf VRFSpecify the VRF in which to show the BGP routes.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the L3VRF.
L3VRFThe l3vrf name.
Output Data¶
routeThe BGP routing table.
l3vrfThe l3vrf details.
id <uint32>The l3vrf identifier.
name <string>The l3vrf name.
table-version <uint32>The BGP table version counter, representing each time the BGP routing table is updated.
router-id ROUTER-IDThe router identifier.
ROUTER-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
default-local-preference <uint32>The default local preference value used by AS to select a preferred path; higher values indicate preferred path.
local-as LOCAL-ASThe local autonomous system number.
LOCAL-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
as-path-segmentThe AS path segments.
type TYPEThe type of the AS path segment.
TYPEvaluesDescription
invalidThe AS path is invalid.
setThe AS path is a set.
sequenceThe AS path is a sequence.
confederation-sequenceThe AS path is a confederation sequence.
confederation-setThe AS path is a confederation set.
<string>No description.
sequence SEQUENCEThe AS path segment list.
SEQUENCEvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<string>No description.
metric <uint32>The metric of the route.
local-preference <uint32>The local preference of the route.
weight <uint32>The weight of the route.
flags FLAGSThe flags of the route.
FLAGSvaluesDescription
is-validThe route is valid.
is-removedThe route is removed.
is-staleThe route is stale.
is-suppressedThe route is suppressed.
is-historyThe route is withdrawn but kept as historical in a dampening context.
is-dampedThe route is damped.
is-multipathThe route is multipath.
is-sourcedThe route is locally sourced.
is-localThe route is local.
is-bestpathThe route is the bestpath.
is-registered-for-labelThe route is registered for label.
is-aggregatedThe route is aggregated.
is-atomic-aggregatedThe route is atomic aggregated.
origin ORIGINThe origin of the route.
ORIGINvaluesDescription
igpThe origin is IGP.
egpThe origin is EGP.
incompleteThe origin is incomplete.
<string>No description.
nexthop-detailsThe next hop details.
announce-itself true|falseIndicates if the router announces itself as the next hop for routes sent to BGP peers.
l3vrfThe next hop l3vrf details.
name NAMEThe next hop l3vrf name.
NAMEvaluesDescription
mainThe main vrf.
<string>The vrf name.
id <uint32>The next hop l3vrf identifier.
bestpath-selection-reason BESTPATH-SELECTION-REASONThe path selection reason.
BESTPATH-SELECTION-REASONvaluesDescription
nothing-to-selectNo paths were available or eligible for BGP best path selection.
first-path-receivedThe first path received was selected, typically due to limited options.
evpn-sticky-macSelected based on EVPN Sticky MAC address to maintain consistent forwarding.
evpn-sequence-numberPreference given to paths with the highest EVPN sequence number for route consistency.
evpn-lower-ipChoose the path with the lowest IP address in EVPN for deterministic tie-breaking.
evpn-local-es-pathPath selected due to being local to the Ethernet Segment (ES) in EVPN.
evpn-non-proxyNon-proxy paths in EVPN were preferred over proxy paths for direct reachability.
weightSelected based on the highest BGP weight, typically a local preference mechanism.
local-preferenceChoose the path with the highest local preference within the AS.
local-routePreference given to locally originated routes over externally received ones.
confederation-based-as-pathChoose the path with the shortest AS path within the BGP confederation boundaries.
as-pathPreference based on the shortest AS path length for external paths.
originPath selected based on BGP origin type; IGP > EGP > Incomplete.
medChoose the path with the lowest Multi-Exit Discriminator (MED) for external route prioritization.
peer-typePreference given to paths based on BGP peer type (e.g., internal over external).
confederation-peer-typePath selection influenced by peer type within a BGP confederation.
igp-metricSelected path with the lowest IGP metric to the next-hop.
older-pathPreference given to the older path to maintain stability in routing.
router-idPath chosen based on the lowest originating router identifier as a tie-breaker.
cluster-lengthChoose the path with the shortest BGP cluster list length for route reflectors.
path-stalenessPreference given to the freshest (non-stale) BGP path.
locally-configured-routeLocally configured static routes were prioritized over dynamically learned ones.
neighbor-ipPath selected based on the lowest BGP neighbor IP address as a tie-breaker.
nothing-left-to-compareFinal selection occurred when no other criteria differentiated the paths.
<string>The reason why this BGP path has been selected over another one.
community COMMUNITYThe BGP communities of the route.
COMMUNITYvaluesDescription
internetAdvertise the prefix to all BGP neighbors (INTERNET).
graceful-shutdownGracefully shutdown paths that a router might use when its peer is about to be intentionally shut down (GRACEFUL_SHUTDOWN).
accept-ownThe router may accept a route whose origin matches the receiving speaker (ACCEPT_OWN).
route-filter-ipv4Route Targets are attached as-is for VPNv4 route filtering (ROUTE_FILTER_V4).
route-filter-ipv6Route Targets are attached as-is for VPNv6 route filtering (ROUTE_FILTER_V6).
route-filter-translated-ipv4Translated Route Targets are attached for VPNv4 route filtering (ROUTE_FILTER_TRANSLATED_V4).
route-filter-translated-ipv6Translated Route Targets are attached for VPNv6 route filtering (ROUTE_FILTER_TRANSLATED_V6).
long-lived-graceful-restart-staleThe route retained for a longer period of time (LLGR_STALE).
no-long-lived-graceful-restartThe BGP speaker will not treat this route according to the LLGR procedure (NO_LLGR).
accept-own-nexthopThe router may accept a route whose nexthop matches the receiving speaker (ACCEPT_OWN_NEXTHOP).
blackholeThe router can discard any traffic sent towards this prefix (BLACKHOLE).
no-exportPrevents the route from being advertised outside the local AS, it remains within the AS and is not shared with external peers (NO_EXPORT).
no-advertiseRestricts the route from being advertised to any peers, internal or external (NO_ADVERTISE).
local-asEnsures the route is shared only within confederation sub-AS but not with external AS (LOCAL_AS).
no-peerThe route is not advertised to any peer (NO_PEER).
<string>No description.
large-community <string>The large BGP communities of the route.
extended-community <string>The extended BGP communities of the route.
nexthopThe next hops of the route.
address ADDRESSThe address of the next hop.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
host-name <string>The host-name of the next hop.
address-family ADDRESS-FAMILYThe address family of the next hop.
ADDRESS-FAMILYvaluesDescription
ipv4IPv4.
ipv6IPv6.
<string>No description.
metric <uint32>The metric of the next hop.
flags FLAGSThe flags of the next hop.
FLAGSvaluesDescription
is-accessibleThe next hop is accessible.
is-usedThe next hop is used.
is-import-check-enabledThe import check is enabled.
scope SCOPEThe scope of the next hop.
SCOPEvaluesDescription
globalAn ipv6 global address.
link-localAn ipv6 link-local address.
<string>No description.
peerThe peer of the route.
id IDThe peer identifier.
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
router-id ROUTER-IDThe peer router identifier.
ROUTER-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
host-name <string>The peer host-name.
interface <string>The interface used to communicate with the peer.
domain-name <string>The peer domain name.
type TYPEThe peer type.
TYPEvaluesDescription
internalInternal.
confederation-internalConfederation internal.
externalExternal.
confederation-externalConfederation external.
<string>No description.
rpki-state RPKI-STATEThe RPKI state.
RPKI-STATEvaluesDescription
not-foundThe RPKI is not found.
not-usedThe RPKI is not used.
validThe RPKI is valid.
invalidThe RPKI is invalid.
<string>No description.
network NETWORKThe network prefix ip of the BGP route.
NETWORKvaluesDescription
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
prefix PREFIXThe network ip prefix (without the prefix-length) of the BGP route.
PREFIXvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
prefix-length <uint32>The network ip prefix length of the BGP route.
version <uint32>The version of the route.
l3vrfThe l3vrf details.
id <uint32>The l3vrf identifier.
name <string>The l3vrf name.
table-version <uint32>The BGP table version counter, representing each time the BGP routing table is updated.
router-id ROUTER-IDThe router identifier.
ROUTER-IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
default-local-preference <uint32>The default local preference value used by AS to select a preferred path; higher values indicate preferred path.
local-as LOCAL-ASThe local autonomous system number.
LOCAL-ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
show bgp segment-routing ipv6¶
vsr> show bgp segment-routing ipv6 [vrf <string>]
Show BGP segment routing IPv6 information.
Input Parameters¶
vrf <string>Specify the VRF.
show bgp bmp¶
vsr> show bgp bmp [vrf <string>]
Show BGP BMP information.
Input Parameters¶
vrf <string>VRF to look into.
Output Data¶
bmpBGP BMP operational state.
route-mirroringBGP BMP route mirroring information.
pending-bytes <uint32>Number of penting bytes.
pending-messages <uint32>Number of penting messages.
buffer-used <uint32>Number of bytes used in buffer.
targetsTarget group operational state.
name <string>Name of the BMP target group.
connectBGP BMP connection operational state.
host HOSTMonitoring station hostname or address.
HOSTvaluesDescription
<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.
port PORT(mandatory)TCP port number.
PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
source-ip SOURCE-IPSource IP address.
SOURCE-IPvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
state STATEConnection state.
STATEvaluesDescription
upConnection is UP.
retry-waitWait before retry connecting.
connectingConnecting in progress.
resolvingTrying to resolve host name.
unknownUnknown state.
retry-timer <string>Time before reconnect to the client if previous try has failed (if state is RetryWait).
uptime <string>Time since the connection has been established (if state is Up).
monitor-sent <uint32>Number of monitor packets sent.
mirror-sent <uint32>Number of mirroring packets sent.
mirror-lost <uint32>Number of times this peer wasn’t fast enough in consuming the mirror queue.
byte-sent <uint64>Number of bytes sent to the peer.
byte-queue <uint32>Number of bytes in the output buffer.
byte-kernel-queue <uint32>Number of bytes in the kernel output buffer.
show bgp rpki cache-connection¶
vsr> show bgp rpki cache-connection [vrf VRF] [l3vrf <string>]
Show which RPKI cache servers have a connection.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf <string>Specify the L3VRF.
show bgp rpki cache-server¶
vsr> show bgp rpki cache-server [vrf VRF] [l3vrf <string>]
Show RPKI configured cache server.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf <string>Specify the L3VRF.
show bgp rpki prefix-table¶
vsr> show bgp rpki prefix-table [vrf VRF] [l3vrf <string>] [PREFIX] [as AS]
Show validated prefixes which were received from RPKI Cache.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf <string>Specify the L3VRF.
PREFIXLookup by IPv4/IPv6 prefix.
PREFIXvaluesDescription
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
as ASLookup by AS number.
ASvaluesDescription
<1-4294967295>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
<0-65535.0-65535>A numeric identifier for an autonomous system (AS). An AS is a single domain, under common administrative control, which forms a unit of routing policy. Autonomous systems can be assigned a 2-byte identifier, or a 4-byte identifier which may have public or private scope. Private ASNs are assigned from dedicated ranges. Public ASNs are assigned from ranges allocated by IANA to the regional internet registries (RIRs).
show isis¶
vsr> show isis [vrf <string>] [l3vrf <string>] [hostname] fast-reroute summary \
... [level-1] [level-2] [summary] database [detail] neighbor [detail] \
... topology [level-1] [level-2] [flex-algorithm <128-255>] route \
... [level-1] [level-2] [prefix-sid] [backup] [flex-algorithm <128-255>] \
... interface [detail] [NAME] segment-routing node [flex-algorithm <128-255>] \
... te-database [detail] edge [id ID] subnet [id ID] vertex [id <string>] \
... [te-router] [te-interface] [ipv6] flex-algorithm [<128-255>]
Show IS-IS information.
Input Parameters¶
vrf <string>Specify the VRF.
l3vrf <string>Specify the L3VRF.
hostnameHostname information.
fast-rerouteShow information about the number of prefixes having LFA protection, and network-wideo LFA coverage.
summaryShow fast-reroute summary.
level-1Show summary of level 1 IS-IS.
level-2Show summary of level 2 IS-IS.
summaryHostname information.
databaseDatabase summary.
detailDatabase detail.
neighborNeighbors information.
detailNeighbors detail.
topologyTopology information.
level-1Level 1 topology.
level-2Level 2 topology.
flex-algorithm <128-255>Set Flex-Algorithm numeric identifier.
routeRoute information.
level-1Level 1 topology.
level-2Level 2 topology.
prefix-sidShow segment identifier (SID) prefix information.
backupShow backup routes.
flex-algorithm <128-255>Set Flex-Algorithm numeric identifier.
interfaceInterface information.
detailDetailed interface traffic information.
NAMEThe interface name. If not specified, show all interfaces.
NAMEAn interface name.
segment-routingShow segment routing information.
nodeShow detailed information about learned segment routing nodes.
flex-algorithm <128-255>Set Flex-Algorithm numeric identifier.
te-databaseShow information about MPLS-TE database.
detailDetailed information.
edgeMPLS-TE Edge.
id IDMPLS-TE Edge ID (as an IPv4 or IPv6 address).
IDvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
subnetMPLS-TE Subnet.
id IDMPLS-TE Subnet ID (as an IPv4 or IPv6 address).
IDvaluesDescription
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
vertexMPLS-TE Vertex.
id <string>MPLS-TE Vertex ID (as an ISO ID, hostname or “self”).
te-routerShow information about router.
te-interfaceShow information about interface.
ipv6Show information about SRv6.
flex-algorithmShow the IS-IS Flex-Algorithm definition state of the given or all algorithms.
<128-255>Set Flex-Algorithm numeric identifier.
show evpn¶
vsr> show evpn [vrf <string>] [arp-cache] [mac] vni VNI [detail]
Show EVPN information.
Input Parameters¶
vrf <string>Specify the VRF.
arp-cacheShow ARP and ND cache information.
macShow MAC addresses information.
vni VNI(mandatory)Show EVPN information about a specific VNI or all.
VNIvaluesDescription
allShow all VNIs.
<0-16777215>Type definition representing VXLAN Segment ID / VXLAN Network Identifier value.
detailDetail information on each VNI.
show ospf¶
vsr> show ospf [vrf <string>] [l3vrf <string>] [l3vrfs] [route] database [default] \
... [max-age] router [ADDRESS] [advertising-router ADVERTISING-ROUTER] \
... asbr-summary [ADDRESS] [advertising-router ADVERTISING-ROUTER] \
... external [ADDRESS] [advertising-router ADVERTISING-ROUTER] network \
... [ADDRESS] [advertising-router ADVERTISING-ROUTER] nssa-external \
... [ADDRESS] [advertising-router ADVERTISING-ROUTER] opaque-area \
... [ADDRESS] [advertising-router ADVERTISING-ROUTER] opaque-link \
... [ADDRESS] [advertising-router ADVERTISING-ROUTER] opaque-as [ADDRESS] \
... [advertising-router ADVERTISING-ROUTER] summary [ADDRESS] [advertising-router ADVERTISING-ROUTER] \
... interface [traffic] [NAME]
Show OSPF information.
Input Parameters¶
vrf <string>Specify the VRF.
l3vrf <string>Specify the L3VRF.
l3vrfsAvailable VRFs.
routeOSPF routing table.
databaseDatabase summary.
defaultDatabase summary.
max-ageDatabase maximum age.
routerDatabase Router link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
asbr-summaryDatabase ASBR summary link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
externalDatabase External link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
networkDatabase Network link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
nssa-externalDatabase NSSA external link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
opaque-areaDatabase Opaque link state area.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
opaque-linkDatabase Opaque link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
opaque-asDatabase Opaque AS link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
summaryDatabase Summary link states.
ADDRESSThe router address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
self-originateSelf-originated link states.
advertising-router ADVERTISING-ROUTERThe advertising router address.
ADVERTISING-ROUTERAn IPv4 address.
interfaceInterface information.
trafficInterface traffic information.
NAMEThe interface name. If not specified, show all interfaces.
NAMEAn interface name.
show rip¶
vsr> show rip [vrf <string>] [status]
Show RIP information.
Input Parameters¶
vrf <string>Specify the VRF.
statusShow RIP status.
show ospf6¶
vsr> show ospf6 [vrf <string>] route [DESTINATION] database [default] [router] \
... interface [NAME]
Show OSPFv3 information.
Input Parameters¶
vrf <string>Specify the VRF.
routeOSPFv3 routing table.
DESTINATIONThe route destination.
DESTINATIONvaluesDescription
<ipv6-address>An IPv6 address.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
detailDetailed information.
external-1Display Type-1 External routes.
external-2Display Type-2 External routes.
inter-areaDisplay Inter-Area routes.
intra-areaDisplay Intra-Area routes.
summaryRoute table summary.
databaseDatabase summary.
defaultDatabase summary.
routerDatabase Router link states.
interfaceInterface information.
NAMEThe interface name. If not specified, show all interfaces.
NAMEAn interface name.
show ripng¶
vsr> show ripng [status]
Show RIPng information.
Input Parameters¶
statusShow RIPng status.
show mpls ldp¶
vsr> show mpls ldp [vrf <string>] discovery [detail] [interface] [capabilities] \
... neighbor [LSR-ID] [capabilities] [detail] binding [PREFIX] [longer-prefixes] \
... [local-label <0-1048575>] [remote-label <0-1048575>] [neighbor NEIGHBOR] \
... [detail] [ipv4] [ipv6]
Show MPLS LDP information.
Input Parameters¶
vrf <string>Specify the VRF.
discoveryDiscovery Hello Information.
detailShow detailed information.
interfaceInterface information.
capabilitiesDisplay neighbor capability information.
neighborNeighbor information.
LSR-IDOSPF routing table.
LSR-IDAn IPv4 address.
capabilitiesDisplay neighbor capability information.
detailShow detailed information.
bindingLabel Information Base (LIB) information.
PREFIXDestination prefix.
PREFIXvaluesDescription
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
longer-prefixesInclude longer matches.
local-label <0-1048575>Locally assigned label value.
remote-label <0-1048575>Match remotely assigned label values.
neighbor NEIGHBORDisplay labels from LDP neighbor.
NEIGHBORAn IPv4 address.
detailShow detailed information.
ipv4IPv4 Address Family.
ipv6IPv6 Address Family.
show bfd neighbor¶
vsr> show bfd neighbor [vrf VRF] [l3vrf <string>] [address ADDRESS] [TYPE] [source SOURCE] \
... [interface INTERFACE] statistics
Show BFD session counters information.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf <string>Specify the L3VRF.
address ADDRESSThe IP address of the neighbor.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
TYPEShow single or multi hop session.
TYPEvaluesDescription
single-hopShow single-hop session.
multi-hopShow multi-hop session.
source SOURCELocal IP address.
SOURCEvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
anyAccept any source addresses.
interface INTERFACESource interface of the BFD packets. When using multi-hop configurations, the interface is not considered, and a source address should be specified instead.
INTERFACEAn interface name.
statistics(mandatory)Show BFD session counters information.
show path-monitoring¶
vsr> show path-monitoring [vrf VRF] [address ADDRESS] [operational]
Show path monitoring information.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
address ADDRESSIP address of the peer.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
operationalShow session operational information.
show nhrp¶
vsr> show nhrp [vrf <string>] [cache] [nhs] [opennhrp] [shortcut] [default]
Show NHRP IPv4 information.
Input Parameters¶
vrf <string>Specify the VRF.
cacheNHRP forwarding cache information.
nhsNHRP Next hop server information.
opennhrpNHRP opennhrpctl style cache dump.
shortcutNHRP shortcut information.
defaultNHRP default information.
show nhrp6¶
vsr> show nhrp6 [vrf <string>] [cache] [nhs] [opennhrp] [shortcut] [default]
Show NHRP IPv6 information.
Input Parameters¶
vrf <string>Specify the VRF.
cacheNHRP forwarding cache information.
nhsNHRP Next hop server information.
opennhrpNHRP opennhrpctl style cache dump.
shortcutNHRP shortcut information.
defaultNHRP default information.
show pim¶
vsr> show pim [vrf <string>] [detail] [assert] [assert-internal] [assert-metric] \
... [assert-winner-metric] [bsm-database] [bsr] [bsrp-info] [channel] \
... group-type [address ADDRESS] interface [traffic] [NAME] join \
... [source-address SOURCE-ADDRESS] [group-address GROUP-ADDRESS] \
... [join-prune-aggregation] [local-membership] neighbor [name <string>] \
... [nexthop] nexthop-lookup [source-address SOURCE-ADDRESS] [group-address GROUP-ADDRESS] \
... [rp-info] [rpf] [secondary] state [unicast-address UNICAST-ADDRESS] \
... [multicast-address MULTICAST-ADDRESS] statistics [interface-name INTERFACE-NAME] \
... upstream [source-address SOURCE-ADDRESS] [group-address GROUP-ADDRESS] \
... [upstream-join-desired] [upstream-rpf]
Show PIM information.
Input Parameters¶
vrf <string>Specify the VRF.
detailShow detailed output.
assertShow PIM interface assert message.
assert-internalShow PIM interface internal assert state.
assert-metricShow PIM interface assert message metric.
assert-winner-metricShow PIM interface assert winner metric.
bsm-databaseShow PIM cached BSM packets information.
bsrShow BSM (BootStrap Message) router information.
bsrp-infoShow BootStrap Rendezvous Point informations.
channelShow PIM downstream channel info.
group-typeShow multicast group type.
address ADDRESSShow group address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
interfaceShow interface information.
trafficShow protocol packet counters.
NAMESet the interface name. If not specified, show all interfaces.
NAMEAn interface name.
joinShow interface join information.
source-address SOURCE-ADDRESSSet source or group address.
SOURCE-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
group-address GROUP-ADDRESSSet group address.
GROUP-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
join-prune-aggregationShow join prune aggregation list.
local-membershipShow interface local-membership.
neighborShow neighbor information.
name <string>Set name of interface or neighbor.
nexthopShow cached nexthop RPF (Reverse Path Forwarding) information.
nexthop-lookupShow cached nexthop RPF (Reverse Path Forwarding) lookup.
source-address SOURCE-ADDRESSSet source/RP address.
SOURCE-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
group-address GROUP-ADDRESSSet multicast group address.
GROUP-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
rp-infoShow RP information.
rpfShow cached source RPF (Reverse Path Forwarding) information.
secondaryShow neighbor addresses.
stateShow state information.
unicast-address UNICAST-ADDRESSSet unicast or multicast address.
UNICAST-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
multicast-address MULTICAST-ADDRESSSet multicast address.
MULTICAST-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
statisticsShow statistics.
interface-name INTERFACE-NAMESet the interface name. If not specified, show all interfaces.
INTERFACE-NAMEAn interface name.
upstreamShow upstream information.
source-address SOURCE-ADDRESSSet source or group address.
SOURCE-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
group-address GROUP-ADDRESSSet group address.
GROUP-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
upstream-join-desiredShow upstream join-desired.
upstream-rpfShow upstream source RPF.
show pbr¶
vsr> show pbr [family FAMILY] [vrf <string>]
Show policy based routing information.
Input Parameters¶
family FAMILYDisplay the policy based routing rules for this family type.
FAMILYvaluesDescription
ipv4IPV4 rules only.
ipv6IPV6 rules only.
<string>No description.
vrf <string>The VRF in which to show the policy based routing.
Output Data¶
ipv4-ruleIPv4 rule state.
priority <string>Priority of the rule. High number means lower priority.
notInvert the match.
matchConfigure the packet selector.
inbound-interface INBOUND-INTERFACEMatch this incoming interface.
INBOUND-INTERFACEAn interface name.
mark MARKMatch this mark filter.
MARKvaluesDescription
<mark>Firewall mark.
<mark-mask>Firewall mark filter.
source SOURCEMatch this source address or prefix.
SOURCEvaluesDescription
<ipv4-address>An IPv4 address.
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
destination DESTINATIONMatch this destination address or prefix.
DESTINATIONvaluesDescription
<ipv4-address>An IPv4 address.
<ipv4-prefix>An IPv4 prefix: address and CIDR mask.
outbound-interface OUTBOUND-INTERFACEMatch this outgoing interface.
OUTBOUND-INTERFACEAn interface name.
tos <uint32>Match this tos.
l3vrfMatch any l3vrf.
otherMatch a specific attribute.
attr <string>The attribute to match.
value <string>The value to match.
actionConfigure the action for packets matching the selector.
lookup LOOKUPLookup in this table.
LOOKUPvaluesDescription
<uint32>Table type.
localHigh priority control routes for local and broadcast addresses (table 255).
mainNormal routing table, containing all non-policy routes (table 254).
defaultReserved for some post-processing if no previous default rules selected the packet (table 253).
l3vrf-tableLookup in a l3vrf table (table 0 and l3vrf match).
goto <uint32>Jump to the specified priority rule.
other OTHEROther actions.
OTHERvaluesDescription
unknownUnknown action.
blackholeIndicates that the rule requires a silent drop.
prohibitIndicates that the rule requires a ‘Communication is administratively prohibited’ error.
unreachableIndicates that the rule requires a ‘Network is unreachable’ error.
natIndicates that a nat operation is requested.
ipv6-ruleIPv6 rule state.
priority <string>Priority of the rule. High number means lower priority.
notInvert the match.
matchConfigure the packet selector.
inbound-interface INBOUND-INTERFACEMatch this incoming interface.
INBOUND-INTERFACEAn interface name.
mark MARKMatch this mark filter.
MARKvaluesDescription
<mark>Firewall mark.
<mark-mask>Firewall mark filter.
source SOURCEMatch this source address or prefix.
SOURCEvaluesDescription
<ipv6-address>An IPv6 address.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
destination DESTINATIONMatch this destination address or prefix.
DESTINATIONvaluesDescription
<ipv6-address>An IPv6 address.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
outbound-interface OUTBOUND-INTERFACEMatch this outgoing interface.
OUTBOUND-INTERFACEAn interface name.
tos <uint32>Match this tos.
l3vrfMatch any l3vrf.
otherMatch a specific attribute.
attr <string>The attribute to match.
value <string>The value to match.
actionConfigure the action for packets matching the selector.
lookup LOOKUPLookup in this table.
LOOKUPvaluesDescription
<uint32>Table type.
localHigh priority control routes for local and broadcast addresses (table 255).
mainNormal routing table, containing all non-policy routes (table 254).
defaultReserved for some post-processing if no previous default rules selected the packet (table 253).
l3vrf-tableLookup in a l3vrf table (table 0 and l3vrf match).
goto <uint32>Goto to the specified priority rule.
other OTHEROther actions.
OTHERvaluesDescription
unknownUnknown action.
blackholeIndicates that the rule requires a silent drop.
prohibitIndicates that the rule requires a ‘Communication is administratively prohibited’ error.
unreachableIndicates that the rule requires a ‘Network is unreachable’ error.
natIndicates that a nat operation is requested.
show segment-routing te-policies¶
vsr> show segment-routing te-policies [vrf <string>] [installed] [detail]
Show the traffic engineering policies information.
Input Parameters¶
vrf <string>The VRF to look into.
installedShow the installed segment routing policies.
detailShow the detailed information of the segment routing policies.
show segment-routing te-database¶
vsr> show segment-routing te-database [vrf <string>]
Show the traffic engineering database information.
Input Parameters¶
vrf <string>The VRF to look into.
show segment-routing ipv6¶
vsr> show segment-routing ipv6 [vrf <string>] [locator LOCATOR]
Show segment routing IPv6 locators.
Input Parameters¶
vrf <string>VRF to look into.
locator LOCATORName of the locator.
LOCATORName format of an SRv6 locator.
Output Data¶
locatorList of configured SRv6 locators.
status STATUSThe locator status (up or down).
STATUSvaluesDescription
upThe locator status is up.
downThe locator status is down.
chunkSegment routing IPv6 block for this locator.
prefix PREFIXThe chunk prefix.
PREFIXAn IPv6 prefix: address and CIDR mask.
protocol <string>The protocol that uses the chunk.
name NAMEConfigure the name that will identify the locator.
NAMEName format of an SRv6 locator.
prefix PREFIX(mandatory)Configure the locator prefix.
PREFIXAn IPv6 prefix: address and CIDR mask.
block-length <16-64>Configure the locator block length. block-length + node-length must be <= to the prefix length.
node-length <16-64>Configure the SID locator node length. block-length + node-length must be <= to the prefix length.
function-length <0-20>Configure the function length. A function is the other part of the SID defines that is performed locally on the node that is specified by the locator.
uncompressed-modeDefine the way the SRv6 SIDs are allocated in the locator. It defines specific explicit and dynamic ranges for hosting SIDs in the function part of the locator.
enabled true|falseUsing this command will facilitate the way the SRv6 SIDs are used by routing services. The dynamic allocation of SRv6 SIDs will start from index 40. Also it avoids conflicts between dynamic and explicit SID allocation by introducing ranges: values above the 0xFF00 index range are authorised for explicit SRv6 SIDs.
show segment-routing ipv6 sids¶
vsr> show segment-routing ipv6 sids [vrf VRF] [locator LOCATOR] [details]
Display a list of segment routing ipv6 sids and their allocation details.
Input Parameters¶
vrf VRFVRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
locator LOCATORLocator name used to filter sids output that are derived from it.
LOCATORName format of an SRv6 locator.
detailsDisplay detailed information on SID entries.
Output Data¶
allocated-ipv6-sidList of allocated IPv6 SIDs.
ipv6-sid IPV6-SIDThe IPv6 segment identifiers.
IPV6-SIDAn IPv6 address.
behavior <string>The SRv6 behavior to apply to the ipv6-sid.
contextThe SRv6 context that tells how this SID is used.
l3vrf <string>The L3VRF name when used by the SID.
interface <string>The interface name when used by the SID.
color <uint32>The color of the segment-routing policy for which the SID has been allocated.
endpoint ENDPOINTThe endpoint of the segment-routing policy for which the SID has been allocated.
ENDPOINTAn IPv6 address.
protocol <string>The routing service that use that SID.
locator <string>The locator where this SID has been originated.
allocation-type <string>The allocation mode used for this SID: dynamic or explicit.
show segment-routing pcep session¶
vsr> show segment-routing pcep session [vrf VRF] [name <string>]
Show the Segment Routing Path Computation Element Protocol session default information.
Input Parameters¶
vrf VRFVRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
name <string>The name of the PCE server.
Output Data¶
sessions-configured <uint32>Number of PCEP sessions configured.
sessions-connected <uint32>Number of PCEP sessions connected.
sessionList of all PCEP sessions.
name <string>The session name.
address ADDRESSThe session address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
port PORTThe session port.
PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
connection-status CONNECTION-STATUSThe session connection status.
CONNECTION-STATUSvaluesDescription
upThe session is up and running.
disconnectedThe session is disconnected.
initializedThe session is initialized.
connectingThe session is in the middle of connecting.
synchronizingThe session is synchronizing.
operatingThe session is operating.
connection-duration <uint32>The session connection duration in seconds.
pce-negotiated-keepalive <uint16>The time interval for session keep-alive in seconds.
pce-negotiated-dead-timer <uint16>The time duration within which the absence of messages indicates a dead session.
best-multi-pce true|falseThis option tells if the PCE connection is the primary one or a backup connection.
pce-confidence PCE-CONFIDENCEThe confidence in the PCE’s.
PCE-CONFIDENCEvaluesDescription
normalThe PCE’s are reliable.
lowThe PCE’s are not perfectly reliable (failover observed).
show segment-routing pcep session statistics¶
vsr> show segment-routing pcep session statistics [vrf VRF] [name <string>]
Show the Segment Routing Path Computation Element Protocol session statistics.
Input Parameters¶
vrf VRFVRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
name <string>The name of the PCE server.
Output Data¶
sessionList of all PCEP sessions.
name <string>The session name.
received-message-statisticsThe received messages statistics by message type.
open <uint32>The number of OPEN messages.
keepalive <uint32>The number of KEEPALIVE messages.
path-computation-request <uint32>The number of Path Computation requests.
path-computation-reply <uint32>The number of Path Computation replies.
notification <uint32>The number of NOTIFICATION messages.
error <uint32>The number of ERROR messages.
close <uint32>The number of CLOSE messages.
report <uint32>The number of REPORT messages.
update <uint32>The number of UPDATE messages.
initiate <uint32>The number of LSP INITIATE messages.
start-tls <uint32>The number of START TLS messages.
erroneous <uint32>The number of erroneous, unassigned messages.
total <uint32>The total number of messages.
sent-message-statisticsThe sent messages statistics by message type.
open <uint32>The number of OPEN messages.
keepalive <uint32>The number of KEEPALIVE messages.
path-computation-request <uint32>The number of Path Computation requests.
path-computation-reply <uint32>The number of Path Computation replies.
notification <uint32>The number of NOTIFICATION messages.
error <uint32>The number of ERROR messages.
close <uint32>The number of CLOSE messages.
report <uint32>The number of REPORT messages.
update <uint32>The number of UPDATE messages.
initiate <uint32>The number of LSP INITIATE messages.
start-tls <uint32>The number of START TLS messages.
erroneous <uint32>The number of erroneous, unassigned messages.
total <uint32>The total number of messages.
show boot-params¶
vsr> show boot-params
Show boot parameters. Image must be installed on disk.
Output Data¶
currentCurrent boot parameters.
intel-iommu true|falseEnable intel iommu driver. Control intel_iommu=on|off kernel option.
iommu-passthrough true|falseBypass the (default) DMA translation normally performed and instead pass DMA requests directly to the hardware IOMMU (I/O Memory Management Unit).
iommu-allow-unsafe-interrupts true|falseEnable PCI passthrough on hardware that does not support interrupt remapping, when VM are trusted. Control vfio_iommu_type1.allow_unsafe_interrupts=0|1 kernel option.
ixgbe-allow-unsupported-sfp true|falseBypass SFPs types restrictions on Intel ixgbe NICs. Control ixgbe.allow_unsupported_sfp=0|1 kernel option.
isolate-cpus ISOLATE-CPUSIsolate cpus from kernel threads, rcu callbacks, and reduce the scheduler ticks. A good value for this parameter is the fast path coremask.
ISOLATE-CPUSvaluesDescription
<coremask>A comma-separated list of cores or core ranges. Example: ‘1,4-7,10-12’.
noneUnset the coremask.
nextNext boot parameters.
intel-iommu true|falseEnable intel iommu driver. Control intel_iommu=on|off kernel option.
iommu-passthrough true|falseBypass the (default) DMA translation normally performed and instead pass DMA requests directly to the hardware IOMMU (I/O Memory Management Unit).
iommu-allow-unsafe-interrupts true|falseEnable PCI passthrough on hardware that does not support interrupt remapping, when VM are trusted. Control vfio_iommu_type1.allow_unsafe_interrupts=0|1 kernel option.
ixgbe-allow-unsupported-sfp true|falseBypass SFPs types restrictions on Intel ixgbe NICs. Control ixgbe.allow_unsupported_sfp=0|1 kernel option.
isolate-cpus ISOLATE-CPUSIsolate cpus from kernel threads, rcu callbacks, and reduce the scheduler ticks. A good value for this parameter is the fast path coremask.
ISOLATE-CPUSvaluesDescription
<coremask>A comma-separated list of cores or core ranges. Example: ‘1,4-7,10-12’.
noneUnset the coremask.
show log¶
vsr> show log [max-lines <uint16>] [service <identityref>] [vrf <string>] [facility FACILITY] \
... level [EQUAL] [greater-or-equal GREATER-OR-EQUAL] not [LEVEL]
Print log.
Input Parameters¶
max-lines <uint16>Log max lines.
service <identityref>Filter logs by service.
vrf <string>Filter logs by VRF.
facility FACILITYFilter logs by facility.
FACILITYvaluesDescription
kernelFilter kernel messages.
mailFilter mail system messages.
newsFilter network news subsystem messages.
userFilter random user-level messages.
authFilter security/authorization messages.
authprivFilter security/authorization messages (private).
cronFilter clock daemon messages.
daemonFilter system daemons messages.
line-printerFilter line printer subsystem messages.
FTPFilter FTP daemon messages.
syslogFilter messages generated internally by the syslog daemon.
uucpFilter UUCP subsystem messages.
local0Filter messages from local0.
local1Filter messages from local1.
local2Filter messages from local2.
local3Filter messages from local3.
local4Filter messages from local4.
local5Filter messages from local5.
local6Filter messages from local6.
local7Filter messages from local7.
anyFilter messages from any facilities.
levelFilter logs by level.
EQUALSelect levels to show.
EQUALvaluesDescription
emergencySystem is unusable.
alertAction must be taken immediately.
criticalCritical conditions.
errorError conditions.
warningWarning conditions.
noticeNormal but significant condition.
infoInformational messages.
debugDebug-level messages.
anyShow all messages from this facility.
greater-or-equal GREATER-OR-EQUALFilter messages with a greater or equal level than the selected one.
GREATER-OR-EQUALvaluesDescription
emergencySystem is unusable.
alertAction must be taken immediately.
criticalCritical conditions.
errorError conditions.
warningWarning conditions.
noticeNormal but significant condition.
infoInformational messages.
debugDebug-level messages.
notSelect levels to not show.
LEVELDo not show messages with this level.
LEVELvaluesDescription
emergencySystem is unusable.
alertAction must be taken immediately.
criticalCritical conditions.
errorError conditions.
warningWarning conditions.
noticeNormal but significant condition.
infoInformational messages.
debugDebug-level messages.
show logins¶
vsr> show logins [user <string>] [since SINCE] [until UNTIL] [present PRESENT] \
... [max-lines <uint32>] [status STATUS]
Show login events.
Input Parameters¶
user <string>Show login events for this user.
since SINCEShow login events since that time.
SINCEvaluesDescription
todayToday at 00:00:00.
yesterdayYesterday at 00:00:00.
tomorrowTomorrow at 00:00:00.
nowNow.
<YYYY-MM-DD>[ <HH:MM:SS>]A time filter.
until UNTILShow login events until that time.
UNTILvaluesDescription
todayToday at 00:00:00.
yesterdayYesterday at 00:00:00.
tomorrowTomorrow at 00:00:00.
nowNow.
<YYYY-MM-DD>[ <HH:MM:SS>]A time filter.
present PRESENTShow which users were present at that time.
PRESENTvaluesDescription
todayToday at 00:00:00.
yesterdayYesterday at 00:00:00.
tomorrowTomorrow at 00:00:00.
nowNow.
<YYYY-MM-DD>[ <HH:MM:SS>]A time filter.
max-lines <uint32>Limit the number of lines shown.
status STATUSShow login events with this status.
STATUSvaluesDescription
successLogin succeeded.
failureLogin failed.
Output Data¶
sessionThe list of the login events.
entry <uint32>A number to identify the list element.
terminal-id <uint32>The pseudo terminal id associated to an active session.
user <string>The user that triggered the event.
source <string>The source IP used to trigger the event. ‘local’ means from console.
start-time START-TIMEThe time when the user session started.
START-TIMEThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
end-time END-TIMEThe time when the user session ended. If omitted, the session is still running.
END-TIMEThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
status STATUSThe status of the login.
STATUSvaluesDescription
successLogin succeeded.
failureLogin failed.
show user permissions¶
vsr> show user permissions USER
Show permission given to a user.
Input Parameters¶
USER(mandatory)The user name.
USERA user name.
Output Data¶
roleThe list of user role ordered by processing priority.
name NAMEThe user role name identifying this entry.
NAMEName of administrative group to which users can be assigned.
priority <uint8>The priority of processing for this role. If a user is member of several roles, the role with the lowest priority will be processed first. If two roles have the same priority the order of processing is undefined.
denyConfigure deny rules for this role. These rules will be always processed before permit rules.
configPermit/deny read-only or read/write access to a specific configuration path. This rule is also applied to the corresponding state path.
path PATHThe configuration path on which the rule will be applied.
PATHA data path.
access-permission ACCESS-PERMISSIONDeny write or read/write access to a specific configuration path.
ACCESS-PERMISSIONvaluesDescription
writeDeny write access to this path. The user cannot modify any data in this path.
read-writeDeny read/write access to this path. The user have no access to this path.
statePermit/deny read access to a specific state path.
path PATHThe state path on which the rule will be applied.
PATHA data path.
rpcGive execution access to a specific RPC.
name NAMEThe name of the RPC on which the rule will be applied.
NAMEA notification or RPC yang name.
vrfApply this rule only for RPCs called with this vrf/l3vrf.
name NAMEThe VRF name.
NAMEvaluesDescription
<leafref>No description.
<string>No description.
l3vrf L3VRFThe list of L3VRF name.
L3VRFvaluesDescription
<leafref>No description.
<string>No description.
notificationGive access to a specific notification.
name NAMEThe name of the notification on which the rule will be applied.
NAMEA notification or RPC yang name.
permitConfigure permit rules for this role. These rules will be always processed after deny rules.
configPermit/deny read-only or read/write access to a specific configuration path. This rule is also applied to the corresponding state path.
path PATHThe configuration path on which the rule will be applied.
PATHA data path.
access-permission ACCESS-PERMISSIONPermit read or read/write access to a specific configuration path.
ACCESS-PERMISSIONvaluesDescription
readGive read only access to this path.
read-writeGive read/write access to this path.
statePermit/deny read access to a specific state path.
path PATHThe state path on which the rule will be applied.
PATHA data path.
rpcGive execution access to a specific RPC.
name NAMEThe name of the RPC on which the rule will be applied.
NAMEA notification or RPC yang name.
vrfApply this rule only for RPCs called with this vrf/l3vrf.
name NAMEThe VRF name.
NAMEvaluesDescription
<leafref>No description.
<string>No description.
l3vrf L3VRFThe list of L3VRF name.
L3VRFvaluesDescription
<leafref>No description.
<string>No description.
notificationGive access to a specific notification.
name NAMEThe name of the notification on which the rule will be applied.
NAMEA notification or RPC yang name.
show ntp¶
vsr> show ntp [vrf <string>] [details]
Show NTP information.
Input Parameters¶
vrf <string>VRF to look into.
detailsShow per server details.
Output Data¶
enabled true|falseEnable or disable the NTP protocol and indicates that the system should attempt to synchronize the system clock with an NTP server from the servers defined in the ‘ntp/server’ list.
serverList of NTP servers to use for system clock synchronization. If ‘/system/ntp/enabled’ is ‘true’, then the system will attempt to contact and utilize the specified NTP servers.
address ADDRESSThe address or hostname of the NTP server.
ADDRESSvaluesDescription
<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.
version <1-4>Version number to put in outgoing NTP packets.
association-type ASSOCIATION-TYPEThe desired association type for this NTP server.
ASSOCIATION-TYPEvaluesDescription
SERVERUse client association mode. This device will not provide synchronization to the configured NTP server.
PEERUse symmetric active association mode. This device may provide synchronization to the configured NTP server.
POOLUse client association mode with one or more of the NTP servers found by DNS resolution of the domain name given by the ‘address’ leaf. This device will not provide synchronization to the servers.
LOCAL-CLOCKUse a local reference clock.
INVALIDInvalid use of the client/symmetric active association mode. This device can not be synchronized or provide synchronization to the servers.
iburst true|falseIndicates whether this server should enable burst synchronization or not.
prefer true|falseIndicates whether this server should be preferred or not.
stratum <uint8>Indicates the level of the server in the NTP hierarchy. As stratum number increases, the accuracy is degraded. Primary servers are stratum while a maximum value of 16 indicates unsynchronized. The values have the following specific semantics: | 0 | unspecified or invalid | 1 | primary server (e.g., equipped with a GPS receiver) | 2-15 | secondary server (via NTP) | 16 | unsynchronized | 17-255 | reserved.
root-delay <uint32>The round-trip delay to the server, in milliseconds.
root-dispersion <uint64>Dispersion (epsilon) represents the maximum error inherent in the measurement.
offset <uint64>Estimate of the current time offset from the peer. This is the time difference between the local and reference clock.
poll-interval <uint32>Polling interval of the peer.
synchronized true|falseTrue if we are synchronized with this server.
state STATEThe server status in the clock selection process.
STATEvaluesDescription
rejectedNot synchronized. Indicates sources to which connectivity has been lost or whose packets do not pass all tests.
falsetickNot synchronized. Indicates a clock which chronyd thinks is a falseticker (i.e. its time is inconsistent with a majority of other sources).
candidateNot synchronized. Indicates acceptable sources which are combined with the selected source.
system-peerSynchronized. Indicates the source to which chronyd is currently synchronized.
excludedNot synchronized. Indicates acceptable sources which are excluded by the combining algorithm.
inconsistentNot synchronized. Indicates a source whose time appears to have too much variability.
auth-key-id <uint16>Integer identifier used by the client and server to designate a secret key. The client and server must use the same key id.
show ntp clients¶
vsr> show ntp clients [vrf <string>] [l3vrf <string>]
Show connected NTP clients.
Input Parameters¶
vrf <string>VRF to look into.
l3vrf <string>Specify the l3vrf.
Output Data¶
clientNTP client records.
host HOSTClient host.
HOSTvaluesDescription
<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.
ntp-packets <uint32>Number of NTP packets sent to the server.
dropped-ntp-packets <uint32>Number of dropped NTP packets to limit response rate.
last-ntp-packet-time <uint32>Time since the last NTP packet was received.
cmd-packets <uint32>Number of command packets received from the client.
dropped-cmd-packets <uint32>Number of command packets dropped to limit response rate.
last-cmd-packet-time <uint32>Time since the last command packet was received.
show dhcp-relay¶
vsr> show dhcp-relay [vrf VRF] [l3vrf L3VRF] [server SERVER] [interface INTERFACE] \
... [TYPE]
Show DHCP relay statistics and leases.
Input Parameters¶
vrf VRFVRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
l3vrf L3VRFSpecify the l3vrf.
L3VRFThe l3vrf name.
server SERVERDHCP server IP to which DHCP queries are relayed.
SERVERAn IPv4 address.
interface INTERFACEInterface on which to listen to DHCPv4 queries.
INTERFACEAn interface name.
TYPEInformation to show.
TYPEvaluesDescription
statisticsShow DHCP relay statistics.
leasesShow DHCP relay leases.
Output Data¶
dhcp-serverDHCP relay operational state.
address ADDRESSIP address of DHCP server to which DHCP queries are relayed.
ADDRESSAn IPv4 address.
dhcp-server-leasesState of leases for DHCP server.
address ADDRESSLeased IP address.
ADDRESSAn IPv4 address.
starts STARTS(mandatory)Lease start time.
STARTSThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
ends ENDS(mandatory)Lease end time.
ENDSThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
hw-mac-address HW-MAC-ADDRESS(mandatory)MAC address of the network interface on which the lease will be used.
HW-MAC-ADDRESSAn IEEE 802 MAC address.
uid <string>Client identifier used by the client to acquire the lease.
client-hostname <string>Client host name sent using client-hostname statement.
binding-state BINDING-STATELease’s binding state.
BINDING-STATEvaluesDescription
activeThe lease is active.
freeThe lease is free.
abandonedThe lease is abandoned.
next-binding-state NEXT-BINDING-STATEState the lease will move to when the current state expires.
NEXT-BINDING-STATEvaluesDescription
activeThe lease is active.
freeThe lease is free.
abandonedThe lease is abandoned.
option-agent-circuit-id <string>Circuit ID option sent by the relay agent.
option-agent-remote-id <string>Remote ID option sent by the relay agent.
vendor-class-identifier <string>Client-supplied Vendor Class Identifier option.
countersStatistics for DHCP relay.
discover <uint32>Number of DHCP discover messages.
offer <uint32>Number of DHCP offer messages.
request <uint32>Number of DHCP request messages.
decline <uint32>Number of DHCP decline messages.
ack <uint32>Number of DHCP ack messages.
nack <uint32>Number of DHCP nack messages.
release <uint32>Number of DHCP release messages.
inform <uint32>Number of DHCP inform messages.
boot-request <uint32>Number of BOOTP BOOTREQUEST messages.
boot-reply <uint32>Number of BOOTP BOOTREPLY messages.
interfaceDHCP relay operational state.
name NAMEThe interface name on which DHCPv4 queries are listened to.
NAMEAn interface name.
dhcp-server-leasesState of leases for DHCP server.
address ADDRESSLeased IP address.
ADDRESSAn IPv4 address.
starts STARTS(mandatory)Lease start time.
STARTSThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
ends ENDS(mandatory)Lease end time.
ENDSThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
hw-mac-address HW-MAC-ADDRESS(mandatory)MAC address of the network interface on which the lease will be used.
HW-MAC-ADDRESSAn IEEE 802 MAC address.
uid <string>Client identifier used by the client to acquire the lease.
client-hostname <string>Client host name sent using client-hostname statement.
binding-state BINDING-STATELease’s binding state.
BINDING-STATEvaluesDescription
activeThe lease is active.
freeThe lease is free.
abandonedThe lease is abandoned.
next-binding-state NEXT-BINDING-STATEState the lease will move to when the current state expires.
NEXT-BINDING-STATEvaluesDescription
activeThe lease is active.
freeThe lease is free.
abandonedThe lease is abandoned.
option-agent-circuit-id <string>Circuit ID option sent by the relay agent.
option-agent-remote-id <string>Remote ID option sent by the relay agent.
vendor-class-identifier <string>Client-supplied Vendor Class Identifier option.
countersStatistics for DHCP relay.
discover <uint32>Number of DHCP discover messages.
offer <uint32>Number of DHCP offer messages.
request <uint32>Number of DHCP request messages.
decline <uint32>Number of DHCP decline messages.
ack <uint32>Number of DHCP ack messages.
nack <uint32>Number of DHCP nack messages.
release <uint32>Number of DHCP release messages.
inform <uint32>Number of DHCP inform messages.
boot-request <uint32>Number of BOOTP BOOTREQUEST messages.
boot-reply <uint32>Number of BOOTP BOOTREPLY messages.
show dhcp-server¶
vsr> show dhcp-server [vrf <string>] [l3vrf <string>]
Show DHCP server leases.
Input Parameters¶
vrf <string>Specify the VRF.
l3vrf <string>Specify the l3vrf.
Output Data¶
dhcp-leaseDHCP server lease information.
address ADDRESSClient IP address.
ADDRESSAn IPv4 address.
mac-address MAC-ADDRESSClient MAC address.
MAC-ADDRESSAn IEEE 802 MAC address.
start-date <string>DHCP lease start date.
end-date <string>DHCP lease end date.
binding-state BINDING-STATELease’s binding state.
BINDING-STATEvaluesDescription
activeThe lease is active.
freeThe lease is free.
abandonedThe lease is abandoned.
show neighbors¶
vsr> show neighbors [FAMILY] [vrf <string>] [interface <ifname>]
Show neighbors information.
Input Parameters¶
FAMILYDisplay only this layer 3 family.
FAMILYvaluesDescription
ipv4IPv4 only.
ipv6IPv6 only.
vrf <string>The VRF in which to show the neighbors.
interface <ifname>Interface name.
Output Data¶
neighborNeighbor entries in ARP table.
neighbor <string>IPv4 or IPv6 address.
interface <string>Interface name.
state <string>System state (REACHABLE/PERMANENT/STATE/DELAY).
link-layer-address <string>The link-layer address.
show conntracks¶
vsr> show conntracks [vrf <string>] [family FAMILY] [protocol PROTOCOL]
Show conntracks.
Input Parameters¶
vrf <string>The VRF in which to show the conntracks.
family FAMILYDisplay only this layer 3 family.
FAMILYvaluesDescription
ipv4IPv4 only.
ipv6IPv6 only.
<string>No description.
protocol PROTOCOLDisplay only this layer 4 protocol.
PROTOCOLvaluesDescription
tcpTCP only.
udpUDP only.
<string>No description.
show product¶
vsr> show product [name] [version]
Show the product name and version.
Input Parameters¶
nameDisplay the product name.
versionDisplay the product version.
show fast-path arp parameters¶
vsr> show fast-path arp parameters
Show the fast path ARP parameters.
Output Data¶
max-queue <uint32>Maximum number of packets queued for the whole address resolution engine (IPv4 and IPv6).
garbage-collector-threshold <uint32>When the number of neighbors reaches this threshold, every stale entry older than 60 seconds is removed.
vrfList of vrf’s.
name <string>VRF name.
interfaceList of interfaces on the given VRF.
name <string>Interface name.
enabled true|falseTrue if fast path ARP is enabled.
reachable-timeout <uint32>Maximum duration for which an ARP entry may stay in ‘reachable’ state, before becoming ‘stale’.
delay-timeout <uint32>Maximum duration before sending an ARP Request when exiting the state STALE.
fail-timeout <uint32>Maximum duration for which an ARP entry may stay in a ‘fail’ state, before being deleted. Fail state begins when the fast path encountered some error with a specific ARP entry.
stale-attempts <uint8>Maximum number of times that a ‘stale’ state ARP entry can timeout before being deleted.
stale-timeout <uint32>This value multiplied by ‘stale-attempts’ is the maximum duration for which an ARP entry may stay in a ‘stale’ state.
probe-attempts <uint8>Maximum number of ARP requests sent for a target IPv4 address.
probe-timeout <uint32>Maximum duration for which the fast path should wait for a response to an ARP request.
max-queue <uint16>Maximum number of packets queued for a target IPv4 address.
reply-mode REPLY-MODESpecifies requests for which a reply is sent.
REPLY-MODEvaluesDescription
allReply to all requests.
interfaceReply to request if the requested IP address is configured on the incoming interface.
subnetReply to request if the requester is in the configured subnet of the requested IP address.
non-localDo not reply to requests for host scope IP addresses (not implemented).
noneDo not reply to any request.
port-filter true|falseTrue if fast path ARP should filter packets for which the reverse path port differs from the incoming port.
accept-gratuitous true|falseTrue if fast path should update its ARP cache based on received gratuitous ARP packets. Gratuitous ARP packets are used by hosts to update others system’s ARP caches.
notify-gratuitous true|falseTrue if the fast path should send gratuitous packets to other hosts when its own IP-to-MAC mapping is changed.
proxy true|falseTrue if proxy for the fast path ARP is enabled. It allows to respond to ARP requests for another IP address, using the current host MAC address. If it is enabled, the fast path ensures routing to the destination IP.
show fast-path ndp parameters¶
vsr> show fast-path ndp parameters
Show the fast path NDP parameters.
Output Data¶
max-queue <uint32>Maximum number of packets queued for the whole address resolution engine (IPv4 and IPv6).
garbage-collector-threshold <uint32>When the number of neighbors reaches this threshold, every entry older than 60 seconds is removed.
garbage-collector-aggressive-threshold <uint32>When the number of neighbors reaches this threshold, every entry older than 5 seconds is removed.
vrfList of VRF.
name <string>VRF name.
interfaceList of interfaces on the given VRF.
name <string>Interface name.
enabled true|falseTrue if fast path NDP is enabled.
reachable-timeout <uint32>Maximum duration for which an NDP entry may stay in ‘reachable’ state, before becoming ‘stale’.
delay-timeout <uint32>Maximum duration before sending an NDP Request when exiting the state STALE.
fail-timeout <uint32>Maximum duration for which an NDP entry may stay in a ‘fail’ state, before being deleted. Fail state begins when the fast path encountered some error with a specific NDP entry.
probe-attempts <uint8>Maximum number of NDP requests sent for a target IPv6 address.
probe-timeout <uint32>Maximum duration for which the fast path should wait for a response to an NDP request.
max-queue <uint16>Maximum number of packets queued for a target IPv6 address.
show fast-path conntrack¶
vsr> show fast-path conntrack [max-conntrack <1-1000>] [vrf <string>] origin [source SOURCE] \
... [destination DESTINATION] tcp [source-port <uint16>] [destination-port <uint16>] \
... udp [source-port <uint16>] [destination-port <uint16>] icmp [icmp-id <uint16>] \
... icmpv6 [icmp-id <uint16>] gre [key <uint32>] [direction DIRECTION] \
... [interface INTERFACE] [userid <uint32>] [name <string>] reply \
... [source SOURCE] [destination DESTINATION] tcp [source-port <uint16>] \
... [destination-port <uint16>] udp [source-port <uint16>] [destination-port <uint16>] \
... icmp [icmp-id <uint16>] icmpv6 [icmp-id <uint16>] gre [key <uint32>] \
... [direction DIRECTION] [interface INTERFACE] [userid <uint32>] \
... [name <string>]
Show fast-path conntracks.
Input Parameters¶
max-conntrack <1-1000>Number of conntracks to show.
vrf <string>Set the VRF.
originFilter only on origin conntracks.
source SOURCEFilter conntracks with this source address.
SOURCEvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
destination DESTINATIONFilter conntracks with this destination address.
DESTINATIONvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
tcpFilter on TCP protocol.
source-port <uint16>Filter on the source port.
destination-port <uint16>Filter on the destination port.
udpFilter on UDP protocol.
source-port <uint16>Filter on the source port.
destination-port <uint16>Filter on the destination port.
icmpFilter on ICMP protocol.
icmp-id <uint16>Filter on ICMP id.
icmpv6Filter on ICMPv6 protocol.
icmp-id <uint16>Filter on ICMPv6 id.
greFilter on GRE protocol.
key <uint32>Filter on GRE key.
direction DIRECTIONSpecify filtered direction for interface, rule userid and rule name.
DIRECTIONvaluesDescription
ingressFilter on ingress rule or interface.
egressFilter on egress rule or interface.
interface INTERFACEFilter on conntrack interface, according to direction if specified.
INTERFACEAn interface name.
userid <uint32>Filter on rule userid, according to direction if specified.
name <string>Filter on rule name, according to direction if specified.
replyFilter only on reply conntracks.
source SOURCEFilter conntracks with this source address.
SOURCEvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
destination DESTINATIONFilter conntracks with this destination address.
DESTINATIONvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
tcpFilter on TCP protocol.
source-port <uint16>Filter on the source port.
destination-port <uint16>Filter on the destination port.
udpFilter on UDP protocol.
source-port <uint16>Filter on the source port.
destination-port <uint16>Filter on the destination port.
icmpFilter on ICMP protocol.
icmp-id <uint16>Filter on ICMP id.
icmpv6Filter on ICMPv6 protocol.
icmp-id <uint16>Filter on ICMPv6 id.
greFilter on GRE protocol.
key <uint32>Filter on GRE key.
direction DIRECTIONSpecify filtered direction for interface, rule userid and rule name.
DIRECTIONvaluesDescription
ingressFilter on ingress rule or interface.
egressFilter on egress rule or interface.
interface INTERFACEFilter on conntrack interface, according to direction if specified.
INTERFACEAn interface name.
userid <uint32>Filter on rule userid, according to direction if specified.
name <string>Filter on rule name, according to direction if specified.
show fast-path conntrack statistics¶
vsr> show fast-path conntrack statistics
Show fp-firewall and CG-NAT conntrack statistics.
Output Data¶
conntrackConntrack statistics.
allocations <uint64>Number of conntrack allocations.
reverse-connections <uint64>Number of conntracks tracking a reverse connection.
destructions <uint64>Number of conntrack destructions.
allocation-failures <uint64>Number of conntrack allocation failures.
duplicate-races <uint64>Number of attempts to create a duplicate conntrack. This race occurs when a CPU attempts to create a new conntrack that has already been created by another CPU in the meantime.
dropped-packetsInvalid and dropped packet statistics.
tcpTCP invalid packet statistics.
non-syn-first-packet <uint64>Number of TCP conntracks failed due to a non-SYN first packet.
invalid-sequence-order-rst <uint64>Number of dropped out-of-order TCP RST packets (See RFC 5961).
invalid-state-transition <uint64>Number of TCP packets dropped due to invalid transitions in the TCP state machine based on the packet’s TCP flags.
out-of-upper-bound-window <uint64>Number of dropped out-of window TCP packets (upper boundary).
out-of-lower-bound-window <uint64>Number of dropped out-of window TCP packets (lower boundary).
out-of-window-ack <uint64>Number of TCP ACK packets dropped for acknowledging unsent packets.
ipIP invalid packet statistics.
malformed-header <uint64>Number of packets dropped due to a malformed IP header.
show fast-path alg statistics¶
vsr> show fast-path alg statistics
Show fp-firewall and CG-NAT ALG statistics.
Output Data¶
algALG statistics.
dnsALG DNS statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
ftpALG FTP statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
tftpALG TFTP statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
rtspALG RTSP statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
pptpALG PPTP statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
sip-tcpALG SIP TCP statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
sip-udpALG SIP UDP statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
h323-rasALG H323 RAS statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
h323-q931ALG H323 Q931 statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
h323-h245ALG H323 H245 statistics.
connection-associations <uint64>Number of connections associated with the ALG port.
connection-usage <uint64>Number of connections used by the ALG.
connection-disassociations <uint64>Number of connections disassociated/released of the ALG.
show fast-path hash-seed¶
vsr> show fast-path hash-seed
Show the fast-path hash seed.
Output Data¶
hash-seed <string>Hash seed of the fast path.
show fast-path statistics¶
vsr> show fast-path statistics [all] [percore] [TYPE]
Show fast-path statistics.
Input Parameters¶
allShow all fast-path services statistics.
percoreShow fast-path services statistics per core.
TYPEShow fast-path services statistics.
TYPEvaluesDescription
neighborShow neighbor fast-path service statistics.
ipv4Show ipv4 fast-path service statistics.
ipv6Show ipv6 fast-path service statistics.
ipsec-ipv4Show ipsec ipv4 fast-path service statistics.
ipsec-ipv6Show ipsec ipv6 fast-path service statistics.
vxlanShow vxlan fast-path service statistics.
vlanShow vlan fast-path service statistics.
bridgeShow bridge fast-path service statistics.
lagShow lag fast-path service statistics.
greShow GRE fast-path service statistics.
pppoeShow PPPoE fast-path service statistics.
mplsShow MPLS fast-path service statistics.
globalShow global fast-path service statistics.
interfaceShow interface fast-path service statistics.
exceptionShow exception fast-path service statistics.
qos-schedShow QoS scheduler fast-path service statistics.
qos-rate-limitShow QoS rate limit fast-path service statistics.
lawful-interceptionShow Lawful Interception fast-path service statistics.
Output Data¶
neighborARP/NDP service statistics.
neighbor-arp-request-sentNumber of ARP request packets sent (neighArpRequestSent).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-request-retriesNumber of ARP request packets re-sent (neighArpRequestRetry).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-reply-receivedNumber of ARP reply packets received (neighArpReplyReceived).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-request-receivedNumber of ARP request packets received (neighArpRequestReceived).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-reply-sentNumber of ARP reply packets sent (neighArpReplySent).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-gratuitous-packetsNumber of ARP gratuitous packets sent or received (neighArpGratuitous).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-unhandled-packetsNumber of ARP packets sent as exception because of an unsupported ARP option (neighArpUnhandled).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-dropped-not-foundNumber of unhonored ARP request packets because the IP address was not found or filtered (neighArpNotFound).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-error-protocolNumber of ARP packets that were dropped because they were corrupted (neighErrorProto).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-arp-error-table-fullNumber of ARP entries that were dropped because the table was full (neighArpTableFull).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-ns-sentNumber of NDP neighbor solicitation packets sent (neighNdpNsSent).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-ns-retriesNumber of NDP neighbor solicitation packets re-sent (neighNdpNsRetry).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-ns-unicast-receivedNumber of unicast NDP neighbor solicitation packets received (neighNdpNsReceivedUcast).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-ns-multicast-receivedNumber of multicast NDP neighbor solicitation packets received (neighNdpNsReceivedMcast).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-na-receivedNumber of NDP neighbor advertisement packets received (neighNdpNaReceived).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-unhandled-packetsNumber of NDP packets sent as exception because of an unsupported NDP option (neighNdpUnhandled).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-dropped-not-foundNumber of unhonored NDP request packets because the IP address was not found or filtered (neighNdpNotFound).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-error-table-fullNumber of NDP entries that were dropped because the table was full (neighNdpTableFull).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-ndp-error-protocolNumber of NDP packets that were dropped because they were corrupted (neighNdpErrorProto).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-error-no-mbufNumber of ARP/NDP packets that could not be sent because no mbuf was available (neighErrorNoMbuf).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-delayed-packetsNumber of packets sent after delay (waiting for an neighbor resolution) (neighPacketDelayed).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-error-no-source-addressNumber of ARP/NDP packets that were not sent because no IP address was found on the output interface (neighErrorNoAddr).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-error-internalNumber of ARP/NDP packets that were dropped because of an internal processing error (neighErrorInternal).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-error-queue-fullNumber of packets that were dropped while waiting for an neighbor resolution, because the queue was full (neighErrorQfull).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-error-queue-flushedNumber of packets that were dropped while waiting for an neighbor resolution, because it failed (neighErrorQflush).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-unexpected-eventsNumber of unexpected events in the neighbor state machine (neighUnexpEvent).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
neighbor-unexpected-packetsNumber of unexpected packets in the current state of the neighbor state machine, packets are dropped (neighUnexpPacket).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ipv4IPv4 service statistics.
ip-forwarded-datagramsNumber of IP packets forwarded (IpForwDatagrams).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-in-deliveredNumber of IP packets delivered to user-protocols (IpInDelivers).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-in-receivedNumber of IP packets received (IpInReceives).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-in-truncated-packetsNumber of IP packets discarded due to a truncate IP header (IpInTruncatedPkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-in-address-errorsNumber of IP packets discarded due to invalid IP address (IpInAddrErrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-in-header-errorsNumber of IP packets discarded due to errors in header (IpInHdrErrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-fragment-createdNumber of IP fragment packets created on fragmentation processing (IpFragCreates).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-fragment-okNumber of IP fragment packets sent successfully (IpFragOKs).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-fragment-failuresNumber of IP packets discarded due to failures during fragmentation processing (IpFragFails).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-okNumber of IP packets successfully reassembled (IpReasmOKs).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-requiredNumber of IP fragments packets submitted to reassembly processing (IpReasmReqds).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-exceptionsNumber of IP fragment packets sent in exception path (IpReasmExceptions).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-failuresNumber of IP packets discarded due to failures during reassembly processing (IpReasmFails).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-dropped-duplicateNumber of IP packets dropped during reassembly considered as duplicate (IpReasmDroppedDuplicate).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-dropped-session-completeNumber of IP packets dropped during reassembly because the session is complete (IpReasmDroppedSessionComplete).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-dropped-session-fullNumber of IP packets dropped during reassembly because the session is already full (IpReasmDroppedSessionAlreadyFull).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-header-encapsulationNumber of IP packets discarded during reassembly due to header encapsulation error (IpReasmErrorHeaderEncap).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-ip-option-unsupportedNumber of IP packets discarded during reassembly due to unsupported IP option (IpReasmErrorIPOptionUnsupported).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-last-already-receivedNumber of IP packets discarded during reassembly due to receive twice the last fragment (IpReasmErrorLastAlreadyReceived).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-offset-too-largeNumber of IP packets discarded during reassembly with offset due to an offset too big (IpReasmErrorOffsetTooLarge).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-overlap-nextNumber of IP packets discarded during reassembly due to receive overlapping fragment with next one (IpReasmErrorOverlapNext).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-overlap-previousNumber of IP packets discarded during reassembly due to receive overlapping fragment with previous one (IpReasmErrorOverlapPrevious).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-packet-too-shortNumber of IP packets discarded during reassembly due to reception of a too short fragment (IpReasmErrorPacketTooShort).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-queue-allocationNumber of IP packets discarded during reassembly due to reassembly queue allocation failure (IpReasmErrorQueueAlloc).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-queue-fullNumber of IP packets discarded during reassembly due to reassembly queue full (too many fragments have been received) (IpReasmErrorQueueFull).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-size-exceedNumber of IP packets discarded during reassembly due to total received bytes greater than the maximal authorized value (65535) (IpReasmErrorSizeExceed).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-size-overflowNumber of IP packets discarded during reassembly due to total received bytes greater than the expected value (IpReasmErrorSizeOverflow).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-error-too-many-segmentsNumber of IP packets discarded during reassembly due to too many segments in IP packets (IpReasmErrorTooManySegments).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-reassembly-timeoutNumber of IP packets discarded due to timeout in reassembly processing (IpReasmTimeout).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-checksum-errorsNumber of IP packets discarded due to an invalid checksum (IpCsumErrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-blackholeNumber of IP packets discarded due to matching blackhole route (IpDroppedBlackhole).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-filteringNumber of IP packets discarded by filtering processing (IpDroppedNetfilter).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-forwardingNumber of IP packets discarded due to forwarding being disabled (IpDroppedForwarding).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-invalid-interfaceNumber of IP packets discarded due to invalid outgoing interface (IpDroppedInvalidInterface).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-ipsecNumber of IP packets discarded by IPsec processing (IpDroppedIPsec).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-mtu-exceededNumber of IP packets discarded due to exceeding MTU (IpDroppedMtuExceeded).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-no-arpNumber of IP packets discarded due to missing ARP resolution (IpDroppedNoArp).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-no-memoryNumber of IP packets discarded due to memory allocation errors (IpDroppedNoMemory).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-out-operativeNumber of IP packets discarded because the outgoing interface is down (IPDroppedOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-dropped-route-exceptionNumber of IP packets sent to exception due to specific route (IpDroppedRouteException).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-nhrp-packetNumber of IP NHRP packets (IpNhrpPacket).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip-nhrp-error-sendNumber of discarded sent IP NHRP packets (IpNhrpErrorSend).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ipv6IPv6 service statistics.
ip6-forwarded-datagramsNumber of IPv6 packets forwarded (IpForwDatagrams).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-in-deliveredNumber of IPv6 packets delivered to user-protocols (IpInDelivers).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-in-receivedNumber of IPv6 packets received (IpInReceives).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-in-truncated-packetsNumber of IPv6 packets discarded due to a truncate IP header (IpInTruncatedPkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-in-address-errorsNumber of IPv6 packets discarded due to invalid IPv6 address (IpInAddrErrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-in-header-errorsNumber of IPv6 packets discarded due to errors in header (IpInHdrErrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-fragment-createdNumber of IPv6 fragment packets created on fragmentation processing (IpFragCreates).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-fragment-okNumber of IPv6 fragment packets sent successfully (IpFragOKs).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-fragment-failuresNumber of IPv6 packets discarded due to failures during fragmentation processing (IpFragFails).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-fragment-reassembly-exceptionsNumber of IP fragment packets sent in exception path.
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-okNumber of IPv6 packets successfully reassembled (IpReasmOKs).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-requiredNumber of IPv6 fragments packets submitted to reassembly processing (IpReasmReqds).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-exceptionsNumber of IPv6 fragment packets sent in exception path (IpReasmExceptions).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-failuresNumber of IPv6 packets discarded due to failures during reassembly processing (IpReasmFails).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-dropped-session-completeNumber of IPv6 packets dropped during reassembly because the session is complete (IpReasmDroppedSessionComplete).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-dropped-session-fullNumber of IPv6 packets dropped during reassembly because the session is already full (IpReasmDroppedSessionAlreadyFull).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-fragment-headerNumber of IPv6 packets discarded during reassembly due to header reading error (IpReasmErrorFragmentHeader).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-header-encapsulationNumber of IPv6 packets discarded during reassembly due to header encapsulation error (IpReasmErrorHeaderEncap).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-ip6-option-too-largeNumber of IPv6 packets discarded during reassembly due to IPv6 option too large (IpReasmErrorIPOptionTooLarge).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-last-already-receivedNumber of IPv6 packets discarded during reassembly due to receive twice the last fragment (IpReasmErrorLastAlreadyReceived).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-offset-too-largeNumber of IPv6 packets discarded during reassembly with offset due to an offset too big (IpReasmErrorOffsetTooLarge).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-overlap-nextNumber of IPv6 packets discarded during reassembly due to receive overlapping fragment with next one (IpReasmErrorOverlapNext).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-overlap-previousNumber of IPv6 packets discarded during reassembly due to receive overlapping fragment with previous one (IpReasmErrorOverlapPrevious).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-packet-too-shortNumber of IPv6 packets discarded during reassembly due to reception of a too short fragment (IpReasmErrorPacketTooShort).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-queue-allocationNumber of IPv6 packets discarded during reassembly due to reassembly queue allocation failure (IpReasmErrorQueueAlloc).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-queue-fullNumber of IPv6 packets discarded during reassembly due to reassembly queue full (too many fragments have been received) (IpReasmErrorQueueFull).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-size-exceedNumber of IPv6 packets discarded during reassembly due to total received bytes greater than the maximal authorized value (65535) (IpReasmErrorSizeExceed).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-size-overflowNumber of IPv6 packets discarded during reassembly due to total received bytes greater than the expected value (IpReasmErrorSizeOverflow).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-error-too-many-segmentsNumber of IPv6 packets discarded during reassembly due to too many segments in IP packets (IpReasmErrorTooManySegments).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-reassembly-timeoutNumber of IPv6 packets discarded due to timeout in reassembly processing (IpReasmTimeout).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-blackholeNumber of IPv6 packets discarded due to matching blackhole route (IpDroppedBlackhole).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-filteringNumber of IPv6 packets discarded by filtering processing (IpDroppedNetfilter).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-forwardingNumber of IPv6 packets discarded due to forwarding being disabled (IpDroppedForwarding).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-invalid-interfaceNumber of IPv6 packets discarded due to invalid outgoing interface (IpDroppedInvalidInterface).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-ipsecNumber of IPv6 packets discarded by IPsec processing (IpDroppedIPsec).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-mtu-exceededNumber of IPv6 packets discarded due to exceeding MTU (IpDroppedMtuExceeded).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-no-arpNumber of IPv6 packets discarded due to missing ARP resolution (IpDroppedNoArp).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-no-memoryNumber of IPv6 packets discarded due to memory allocation errors (IpDroppedNoMemory).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-out-operativeNumber of IPv6 packets discarded because the outgoing interface is down (IPDroppedOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-dropped-route-exceptionNumber of IPv6 packets sent to exception due to specific route (IpDroppedRouteException).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-nhrp-packetNumber of IPv6 NHRP packets (IpNhrpPacket).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ip6-nhrp-error-sendNumber of discarded sent IPv6 NHRP packets (IpNhrpErrorSend).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ipsec-ipv4IPsec service statistics.
ipsec-ipv4-in-saNumber of IPv4 packets decrypted with a security association (IpsecInSA).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ipsec-ipv4-out-saNumber of IPv4 packets encrypted with a security association (IpsecOutSA).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ipsec-ipv6IPsec IPv6 service statistics.
ipsec-ipv6-in-saNumber of IPv6 packets decrypted with a security association (Ipsec6InSA).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
ipsec-ipv6-out-saNumber of IPv6 packets encrypted with a security association (Ipsec6OutSA).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlanVXLAN service statistics.
vxlan-dropped-header-too-shortNumber of input packets dropped in VXLAN due to a VXLAN header too short (VxlanDroppedHeaderTooShort).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-in-operativeNumber of input packets dropped in VXLAN because the incoming interface is down (VxlanDroppedInOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-invalid-ip-familyNumber of output packets dropped in VXLAN due to a failure to get the VXLAN header (VxlanDroppedInvalidIpFamily).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-invalid-ipv4-checksumNumber of input packets dropped in IPv4 VXLAN due to an invalid checksum (VxlanDroppedInvalidIPv4Csum).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-invalid-ipv4-headerNumber of input packets dropped in IPv4 VXLAN due to a failure to get the VXLAN header (VxlanDroppedInvalidIPv4Header).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-invalid-ipv6-checksumNumber of input packets dropped in IPv4 VXLAN due to an invalid checksum (VxlanDroppedInvalidIPv6Csum).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-invalid-ipv6-headerNumber of input packets dropped in IPv6 VXLAN due to a failure to get the VXLAN header (VxlanDroppedInvalidIPv6Header).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-ipv4-mtu-exceededNumber of output packets dropped in IPv4 VXLAN due to a MTU exceeded the authorized value (VxlanDroppedIPv4MtuExceeded).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-ipv4-no-destinationNumber of output packets dropped in IPv4 VXLAN due to a null destination address (VxlanDroppedIPv4NoDst).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-ipv6-mtu-exceededNumber of output packets dropped in IPv6 VXLAN due to a MTU exceeded the authorized value (VxlanDroppedIPv6MtuExceeded).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-ipv6-no-destinationNumber of output packets dropped in IPv6 VXLAN due to a null destination address (VxlanDroppedIPv6NoDst).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-ovs-mtu-exceededNumber of output packets dropped in OVS VXLAN due to a MTU exceeded the authorized value (VxlanDroppedOvsMtuExceeded).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-ovs-no-destinationNumber of output packets dropped in OVS VXLAN due to a null destination address (VxlanDroppedOvsNoDst).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-prepend-ipv4-failureNumber of output packets dropped in IPv4 VXLAN due to add IP header (VxlanDroppedPrependIPv4Failure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-prepend-ipv6-failureNumber of output packets dropped in IPv6 VXLAN due to add IP header (VxlanDroppedPrependIPv6Failure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-prepend-ovs-failureNumber of output packets dropped in OVS VXLAN due to add IP header (VxlanDroppedPrependOvsFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-unknown-ifaceNumber of input packets dropped in VXLAN due to an invalid interface (VxlanDroppedUnknownIface).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-dropped-unknown-vniNumber of input packets dropped in VXLAN due to an invalid VNI (VxlanDroppedUnknownVNI).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-i-flag-not-setNumber of input packets sent to exception by VXLAN due a I flags not set (see rfc 7348) (VxlanExceptionIFlagNotSet).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-ipv4-no-multicast-sourceNumber of output packets sent to exception by IPv4 VXLAN due to no valid src address found for a multicast packet (VxlanExceptionIPv4NoMcastSrc).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-ipv4-routeNumber of output packets sent to exception by IPv4 VXLAN due to specific route (VxlanExceptionIPv4Route).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-ipv6-no-multicast-sourceNumber of output packets sent to exception by IPv6 VXLAN due to no valid src address found for a multicast packet (VxlanExceptionIPv6NoMcastSrc).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-ipv6-routeNumber of output packets sent to exception by IPv6 VXLAN due to specific route (VxlanExceptionIPv6Route).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-no-input-fdbNumber of input packets sent to exception by VXLAN due to no valid fdb found (VxlanExceptionNoInputFdb).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-no-output-fdbNumber of output packets sent to exception by VXLAN due to no valid fdb found (VxlanExceptionNoOutputFdb).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-no-remoteNumber of output packets sent to exception by VXLAN due to no remote found (VxlanExceptionNoRemote).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-ovs-routeNumber of output packets sent to exception by Ovs VXLAN due to specific route (VxlanExceptionOvsRoute).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-exception-too-many-flagsNumber of input packets sent to exception by VXLAN due to a presence of an unsupported flag (neither I and G ones, see rfc 7348) (VxlanExceptionTooManyFlags).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vxlan-fdb-forwarding-duplicate-errorNumber of failure to duplicate a packet for fdb forwarding (VxlanFdbForwDuplicateError).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vlanVLAN service statistics.
vlan-dropped-in-operativeNumber of input packets dropped in VLAN because the incoming interface is down (VlanDroppedInOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vlan-dropped-input-unknown-interfaceNumber of input packets dropped in VLAN due to unknown interface (VlanDroppedInputUnknownIf).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vlan-dropped-invalid-tagNumber of input packets dropped in VLAN due to an invalid tag (VlanDroppedInvalidTag).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vlan-dropped-out-operativeNumber of output packets dropped in VLAN because the outgoing interface is down (VlanDroppedOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vlan-dropped-prepend-failureNumber of output packets dropped in VLAN due to a failure to add VLAN tag (VlanDroppedPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vlan-output-unknown-interfaceNumber of output packets with unknown interface (VlanOutputUnknownIf).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
vlan-unknown-tagNumber of packets with unknown VLAN tag (VlanUnknownTag).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridgeBridge service statistics.
l2-forwarded-framesNumber of packets forwarded at layer 2 (bridging processing) (L2ForwFrames).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-forwarding-invalidNumber of output packets dropped in bridge due to forbidden forwarding (forwarding disable or originating port) (BridgeDroppedFwdInvalid).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-input-lookup-errorNumber of input packets dropped in bridge due to a lookup error (BridgeDroppedInputLookupError).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-invalid-output-portNumber of output packets dropped in bridge because output port index is invalid (BridgeDroppedInvalidOutPort).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-invalid-sourceNumber of input packets dropped in bridge due to invalid mac source (BridgeDroppedInvalidSrc).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-invalid-stateNumber of input packets dropped in bridge due to invalid state (not learning or forwarding) of the bridge (BridgeDroppedInvalidState).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-learningNumber of output packets dropped in bridge while it is in learning state (BridgeDroppedLearning).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-mtu-exceededNumber of output packets dropped in bridge due to MTU greater than the authorized one (BridgeDroppedMtuExceeded).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-no-output-portNumber of output packets dropped in bridge due to no valid output (BridgeDroppedNoOutputPort).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-output-lookup-errorNumber of output packets dropped in bridge due to a lookup error (BridgeDroppedOutputLookupError).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-out-operativeNumber of output packets dropped in bridge because the outgoing interface is down (BridgeDroppedOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-output-unknownNumber of output packets dropped in bridge due to an unknown output (BridgeDroppedOutputUnknown).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-pause-frameNumber of input packets dropped in bridge because it is a pause frame (BridgeDroppedPauseFrame).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-dropped-unknown-interfaceNumber of input packets dropped in bridge due to an invalid interface (BridgeDroppedUnknownIface).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
bridge-fdb-synchronization-errorNumber of packets dropped in bridge due to fdb synchronization error (BridgeFdbSyncError).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
lagLag service statistics.
lag-dropped-inactive-portNumber of LAG dropped inactive ports (LagDroppedInactivePort).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
greGRE service statistics.
gre-dropped-init-gre-ipv4-header-failureNumber of output packets dropped in GRE due to a failure to add the GRE header (GREDroppedInitGreIPv4HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-init-gre-ipv6-header-failureNumber of output packets dropped in GRE6 due to a failure to add the GRE header (GREDroppedInitGreIPv6HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-init-ipv4-header-failureNumber of output packets dropped in GRE due to a failure to add the IPv4 header (GREDroppedInitIPv4HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-init-ipv6-header-failureNumber of output packets dropped in GRE due to a failure to add the IPv4 header (GREDroppedInitIPv6HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-in-operativeNumber of input packets dropped in GRE because the ingoing interface is down (GREDroppedInOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-missing-checksumNumber of input packets dropped in GRE due to a missing checksum (GREDroppedMissingChecksum).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-out-mtu-exceededNumber of output packets dropped in GRE due to packet size exceeding MTU (GREDroppedOutMtuExceeded).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-out-operativeNumber of output packets dropped in GRE because the outgoing interface is down (GREDroppedOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-parse-ipv4-header-failureNumber of input packets dropped in GRE due to failure to parse IPv4 header (GREDroppedParseIPv4HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-parse-ipv6-header-failureNumber of input packets dropped in GRE due to failure to parse IPv6 header (GREDroppedParseIPv6HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-pullup-ipv4-header-failureNumber of input packets dropped in IPv4 GRE due to pullup failure on gre header (GREDroppedPullupIPv4HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-pullup-ipv6-header-failureNumber of input packets dropped in IPv6 GRE due to pullup failure on gre header (GREDroppedPullupIPv6HeaderFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-unexpected-checksumNumber of input packets dropped in GRE due to an unexpected checksum (GREDroppedUnexpectedChecksum).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-dropped-wrong-checksumNumber of input packets dropped in GRE due to an incorrect checksum (GREDroppedWrongChecksum).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-exception-input-unsupported-protocolNumber of input packets sent to exception by GRE due to unsupported GRE protocol (GREExceptionInputUnsupportedProtocol).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-exception-ipv4-routeNumber of output packets sent to exception by GRE due to specific route (for IPv4 packet) (GREExceptionIPv4Route).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-exception-ipv4-source-select-failedNumber of output packets sent to exception by GRE due to no src address can be set (for IPv4 packet) (GREExceptionIPv4SourceSelectFailed).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-exception-ipv6-routeNumber of output packets sent to exception by GRE due to specific route (for IPv6 packet) (GREExceptionIPv6Route).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-exception-output-unsupported-protocolNumber of output packets sent to exception by GRE due to unsupported GRE protocol (GREExceptionOutputUnsupportedProtocol).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-exception-unknown-ifaceNumber of output packets sent to exception by GRE due to an invalid GRE interface id (GREExceptionUnknownIface).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-exception-unsupported-ethernet-typeNumber of output packets sent to exception by GRE due to unsupported ethernet type (GREExceptionUnsupportedEtherType).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-invalid-headerNumber of input packets not managed by GRE due to routing flags set (see rfc 1701) or version number different to 0. The packet can be dropped or sent to exception later in other fast path processing part (GREInvalidHeader).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gre-protocol-not-supportedNumber of input packets not supported by GRE (GREProtocolNotSupported).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gretap-dropped-out-operativeNumber of output packets dropped in GRETAP because the outgoing interface is down (GRETAPDroppedOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
gretap-exception-unknown-ifaceNumber of output packets sent to exception by GRETAP due to an invalid GRE interface id (GRETAPExceptionUnknownIface).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mplsMPLS service statistics.
mpls-forwardingNumber of forwarding packets in MPLS (MplsForwarding).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-inputNumber of input packets in MPLS (MplsInput).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-no-routeNumber of packets in MPLS with no route (MplsNoRoute).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-pushNumber of push packets in MPLS (MplsPush).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-in-header-errorsNumber of packets in MPLS discarded due to errors in header (MplsInHdrErrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-received-droppedNumber of received dropped packets in MPLS (MplsRxDrop).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-dropped-invalid-interfaceNumber of packets dropped in MPLS due to invalid outgoing interface (MplsDroppedInvalidInterface).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-dropped-mtuNumber of packets dropped in MPLS due to MTU greater than the authorized one (MplsDroppedMtu).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-dropped-no-memoryNumber of packets dropped in MPLS due to memory allocation errors (MplsDroppedNoMem).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-dropped-no-neighborNumber of dropped packets in MPLS due to no neighbor is found (MplsDroppedNoNeigh).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
mpls-dropped-ttl-exceedNumber of packets dropped in MPLS due to ttl exceeded (MplsDroppedTtlExceed).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
globalGlobal service statistics.
fast-path-droppedNumber of packets dropped by fast path (fp_dropped).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-neighborNumber of packets dropped by fast path in ARP/NDP (fp_dropped_neigh).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-bondingNumber of packets dropped by fast path in bonding (fp_dropped_bonding).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-bridgeNumber of packets dropped by fast path in bridge (fp_dropped_bridge).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-ebtablesNumber of packets dropped by fast path in layer 2 filtering (fp_dropped_ebtables).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-ethernetNumber of packets dropped by fast path at the generic ethernet layer (fp_dropped_ether).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-exceptionNumber of packets dropped by fast path in exception path (fp_dropped_excp).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-exception-loopNumber of packets dropped by fast path due to exception loop (fp_dropped_excloop).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-filteringNumber of packets dropped by fast path in IPv4 filtering (fp_dropped_netfilter).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-filtering-ipv6Number of packets dropped by fast path in IPv6 filtering (fp_dropped_netfilter6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-greNumber of packets dropped by fast path in GRE (fp_dropped_gre).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-ipNumber of packets dropped by fast path in generic IPv4 (fp_dropped_ip).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-ipsecNumber of packets dropped by fast path in IPv4 IPsec (fp_dropped_ipsec).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-ipsec-ipv6Number of packets dropped by fast path in IPv6 IPsec (fp_dropped_ipsec6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-ipv6Number of packets dropped by fast path in generic IPv6 (fp_dropped_ipv6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-macvlanNumber of packets dropped by fast path in MACVLAN (fp_dropped_macvlan).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-mplsNumber of packets dropped by fast path in MultiProtocol Label Switching (fp_dropped_mpls).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-multicastNumber of packets dropped by fast path in IPv4 multicast (fp_dropped_mcast).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-multicast-ipv6Number of packets dropped by fast path in IPv6 multicast (fp_dropped_mcast6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-npfNumber of packets dropped by fast path in Network Address Translation and Carrier-grade NAT (fp_dropped_npf).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-ovsNumber of packets dropped by fast path in Open vSwitch (fp_dropped_ovs).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-pluginsNumber of packets dropped by fast path in plugin (fp_dropped_plugins).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-qosNumber of packets dropped by fast path in QoS (fp_dropped_qos).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-reassemblyNumber of packets dropped by fast path in IPv4 reassembly (fp_dropped_reasm).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-reassembly-ipv6Number of packets dropped by fast path in IPv6 reassembly (fp_dropped_reasm6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-systemNumber of packets dropped by fast path in internal processing (fp_dropped_system).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-tcNumber of packets dropped by fast path in generic traffic conditioning (fp_dropped_tc).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-tc-erlNumber of packets dropped by fast path in traffic conditioning by exception rate limitation (fp_dropped_tc_erl).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-tunnelNumber of packets dropped by fast path in IPinIP tunnel (fp_dropped_tunnel).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-vethernetNumber of packets dropped by fast path in vEthernet (fp_dropped_veth).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-vlanNumber of packets dropped by fast path in VLAN (fp_dropped_vlan).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-dropped-vxlanNumber of packets dropped by fast path in VXLAN (fp_dropped_vxlan).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-missing-ipsec-licenseNumber of packets dropped in fast path due to missing ipsec license (fp_missing_ipsec_license).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-missing-product-licenseNumber of packets dropped in fast path due to missing product license (fp_missing_product_license).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
interfaceInterface statistics.
name <string>Interface name.
input-bytesThe number of input received bytes (ifs_ibytes).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
input-errorsThe number of input received errors (ifs_ierrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
input-last-errorThe number of input received last errors (ifs_ilasterror).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
input-multicastsThe number of input received multicast packets (ifs_imcasts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
input-no-mbufThe number of input packets dropped because no mbuf was available (ifs_inombuf).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
input-packetsThe number of input received packets (ifs_ipackets).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
missed-input-packetsThe number of missed input packets (ifs_imissed).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
multicastsThe number of multicasts (ifs_mcasts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
output-bytesThe number of output sent bytes (ifs_obytes).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
output-errorsThe number of output sent errors (ifs_oerrors).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
output-packetsThe number of ouput sent packets (ifs_opackets).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exceptionException service statistics.
exception-by-moduleExceptions by module statistics.
fast-path-exception-bondingNumber of packets send in exception in bonding (fp_exception_bonding).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-bridgeNumber of packets send in exception in bridge (fp_exception_bridge).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-ebtablesNumber of packets send in exception in layer 2 filtering (fp_exception_ebtables).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-ethernetNumber of packets send in exception in generic layer 2 (fp_exception_ether).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-filteringNumber of packets send in exception in IPv4 filtering (fp_exception_netfilter).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-filtering-ipv6Number of packets send in exception in IPv6 filtering (fp_exception_netfilter6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-greNumber of packets send in exception in GRE (fp_exception_gre).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-ifnetNumber of packets send in exception by a virtual interface (fp_exception_ifnet).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-ipNumber of packets send in exception in generic IPv4 (fp_exception_ip).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-ipsecNumber of packets send in exception in IPv4 IPsec (fp_exception_ipsec).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-ipsec-ipv6Number of packets send in exception in IPv6 IPsec (fp_exception_ipsec6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-ipv6Number of packets send in exception in generic IPv6 (fp_exception_ipv6).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-macvlanNumber of packets send in exception in MACVLAN (fp_exception_macvlan).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-mplsNumber of packets send in exception in MPLS (fp_exception_mpls).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-npfNumber of packets send in exception in NPF (fp_exception_npf).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-reassemblyNumber of packets send in exception in IPv4 reassembly (fp_exception_reass).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-sflowNumber of packets sent in exception in sflow (fp_exception_sflow).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-syslogNumber of packets send in exception for logging (for system without syslog) (fp_exception_syslog).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-tapNumber of packets send in exception in eBPF (Enhanced Berkeley Packet Filtering), typically when there is a tcpdump or sflow (fp_exception_tap).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-tunnelNumber of packets send in exception in IPinIP tunnel (fp_exception_tunnel).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-unknown-ifnetNumber of packets sent in exception due to unknown ifnet (fp_exception_unknown_ifnet).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-vethernetNumber of packets sent in exception in vEthernet (fp_exception_veth).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-vlanNumber of packets sent in exception in VLAN (fp_exception_vlan).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fast-path-exception-vxlanNumber of packets send in exception in VXLAN (fp_exception_vxlan).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-add-mark-failureNumber of exception packets to Linux dropped due to a tag addition failure (ExcpDroppedFpToLinuxAddMarkFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-fptun-failureNumber of ExcpDroppedFpToLinuxFptunFailure exceptions (ExcpDroppedFpToLinuxFptunFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-no-ipv4-route-localNumber of exception packets to Linux dropped due to a failure to find the IPv4 route (ExcpDroppedFpToLinuxNoIPv4RouteLocal).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-no-ipv6-route-localNumber of exception packets to Linux dropped due to a failure to find the IPv6 route (ExcpDroppedFpToLinuxNoIPv6RouteLocal).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-prepend-failureNumber of ExcpDroppedFpToLinuxPrependFailure exceptions (ExcpDroppedFpToLinuxPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-prepend-failure-detailedDetailed exceptions of the packets dropped from fast-path to linux with prepend failure.
exception-dropped-fp-to-linux-ecmp-prepend-failureNumber of ExcpDroppedFpToLinuxEcmpPrependFailure exceptions (ExcpDroppedFpToLinuxEcmpPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-ecmp6-prepend-failureNumber of ExcpDroppedFpToLinuxEcmp6PrependFailure exceptions (ExcpDroppedFpToLinuxEcmp6PrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-eth-fptun-prepend-failureNumber of ExcpDroppedFpToLinuxEthFptunPrependFailure exceptions (ExcpDroppedFpToLinuxEthFptunPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-eth-prepend-failureNumber of ExcpDroppedFpToLinuxEthPrependFailure exceptions (ExcpDroppedFpToLinuxEthPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-ipsec-prepend-failureNumber of ExcpDroppedFpToLinuxIPsecPrependFailure exceptions (ExcpDroppedFpToLinuxIPsecPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-restore-failureNumber of ExcpDroppedFpToLinuxRestoreFailure exceptions (ExcpDroppedFpToLinuxRestoreFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-fp-to-linux-tuple-prepend-failureNumber of ExcpDroppedFpToLinuxTuplePrependFailure exceptions (ExcpDroppedFpToLinuxTuplePrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-invalid-mtagNumber of ExcpDroppedInvalidMtag exceptions (ExcpDroppedInvalidMtag).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-generic-command-failureNumber of packets from Linux dropped due to a FPTUN internal error (ExcpDroppedLinuxToFpGenericCommandFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-invalid-port-idNumber of packets from Linux dropped due to a reception of a FPTUN message on an unexpected port (ExcpDroppedLinuxToFpInvalidPortId).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-invalid-versionNumber of packets from Linux dropped due to an invalid FPTUN version (ExcpDroppedLinuxToFpInvalidVersion).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-ipv4-pullup-failureNumber of packets from Linux dropped due to a failure when getting the IPv4 header of the FPTUN message (ExcpDroppedLinuxToFpIPv4PullupFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-ipv6-pullup-failureNumber of packets from Linux dropped due to a failure when getting the IPv6 header of the FPTUN message (ExcpDroppedLinuxToFpIPv6PullupFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-msg-too-shortNumber of packets from Linux dropped due to an incomplete FPTUN message (ExcpDroppedLinuxToFpMsgTooShort).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-no-output-functionNumber of packets from Linux dropped because no TX function has been registered (ExcpDroppedLinuxToFpNoOutputFunction).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-other-hostNumber of packets from Linux dropped due to a reception of a FPTUN message marked as PACKET_OTHERHOST (ExcpDroppedLinuxToFpOtherHost).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-out-operativeNumber of packets from Linux dropped because the destination interface is down (ExcpDroppedLinuxToFpOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-tproxy-failureNumber of ExcpDroppedLinuxToFpTproxyFailure exceptions (ExcpDroppedLinuxToFpTproxyFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-unknown-commandNumber of packets from Linux dropped due to an invalid FPTUN command (ExcpDroppedLinuxToFpUnknownCommand).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-linux-to-fp-unknown-interface-uidNumber of packets from Linux dropped due to an invalid interface id for FPTUN (ExcpDroppedLinuxToFpUnknownIfUid).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exception-dropped-no-conntrackNumber of ExcpDroppedNoConntrack exceptions (ExcpDroppedNoConntrack).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
local-basic-exceptionsThe number of local basic exceptions (LocalBasicExceptions).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
local-exception-classLocal exception class statistics.
fptun-exception-ether-dstThe number of FPTUN_EXC_ETHER_DST exceptions (FPTUN_EXC_ETHER_DST).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-icmp-neededThe number of FPTUN_EXC_ICMP_NEEDED exceptions (FPTUN_EXC_ICMP_NEEDED).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-ike-neededThe number of FPTUN_EXC_IKE_NEEDED exceptions (FPTUN_EXC_IKE_NEEDED).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-ip-dstThe number of FPTUN_EXC_IP_DST exceptions (FPTUN_EXC_IP_DST).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-ndisc-neededThe number of FPTUN_EXC_NDISC_NEEDED exceptions (FPTUN_EXC_NDISC_NEEDED).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-nf-funcThe number of FPTUN_EXC_NF_FUNC exceptions (FPTUN_EXC_NF_FUNC).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-sp-funcThe number of FPTUN_EXC_SP_FUNC exceptions (FPTUN_EXC_SP_FUNC).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-tapThe number of FPTUN_EXC_TAP exceptions (FPTUN_EXC_TAP).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-exception-undefThe number of FPTUN_EXC_UNDEF exceptions (FPTUN_EXC_UNDEF).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
local-exception-typeLocal exception types statistics.
fptun-basic-exceptionNumber of basic exception packets for Linux reception processing (FPTUN_BASIC_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-eth-input-exceptionNumber of FPTUN exception packets for Linux ethernet input processing (FPTUN_ETH_INPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-eth-sp-output-reqNumber of FPTUN exception packets from Linux for fast path ethernet processing (FPTUN_ETH_SP_OUTPUT_REQ).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-iface-input-exceptionNumber of FPTUN exception packets for Linux VNB iface processing (FPTUN_IFACE_INPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipsec-sp-output-reqNumber of FPTUN exception packets from Linux for fast path IPsec processing (FPTUN_IPSEC_SP_OUTPUT_REQ).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv4-ipsecdone-input-exceptionNumber of FPTUN exception packets for Linux IPv4 input after IPsec processing (FPTUN_IPV4_IPSECDONE_INPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv4-ipsecdone-output-exceptionNumber of FPTUN exception packets for Linux IPv4 output after IPsec processing (FPTUN_IPV4_IPSECDONE_OUTPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv4-natdone-input-exceptionNumber of FPTUN exception packets for Linux IPv4 input after NAT processing (FPTUN_IPV4_NATDONE_INPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv4-output-exceptionNumber of FPTUN exception packets for Linux IPv4 output (FPTUN_IPV4_OUTPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv4-sp-output-reqNumber of FPTUN exception packets from Linux for fast path IPv4 processing (FPTUN_IPV4_SP_OUTPUT_REQ).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv6-ipsecdone-input-exceptionNumber of FPTUN exception packets for Linux IPv6 input after IPsec processing (FPTUN_IPV6_IPSECDONE_INPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv6-ipsecdone-output-exceptionNumber of FPTUN exception packets for Linux IPv6 output after IPsec processing (FPTUN_IPV6_IPSECDONE_OUTPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv6-output-exceptionNumber of FPTUN exception packets for Linux IPv6 output (FPTUN_IPV6_OUTPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-ipv6-sp-output-reqNumber of FPTUN exception packets from Linux for fast path IPv6 processing (FPTUN_IPV6_SP_OUTPUT_REQ).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-output-exceptionNumber of FPTUN exception packets for Linux interface output processing (FPTUN_OUTPUT_EXCEPT).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
fptun-tapNumber of FPTUN exception packets for Linux TAP (tcpdump) (FPTUN_TAP).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
local-fptun-exceptionsThe number of local fptun exceptions (LocalFPTunExceptions).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
qos-schedQoS scheduler service statistics.
interfaceInterface QoS statistics.
name <string>Interface name.
enqueue-drop-no-class-packetsThe number of packets that were dropped because they matched no class (enq_drop_noclass_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
enqueue-drop-policer-packetsThe number of packets that were dropped by a policer (enq_drop_meter_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
enqueue-drop-queue-full-packetsThe number of packets that were dropped because a queue was full (enq_drop_qfull_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
enqueue-success-packetsThe number of packets that were enqueued (enq_ok_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
transmit-drop-packetsThe number of packets that were dropped during transmission (xmit_drop_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
transmit-success-packetsThe number of packets that were transmitted (xmit_ok_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
classFast-path class statistics.
class-id <uint64>Class Id.
enqueue-drop-policer-packetsThe number of packets that were dropped by a policer (enq_drop_meter_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
enqueue-drop-queue-full-packetsThe number of packets that were dropped because a queue was full (enq_drop_qfull_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
enqueue-success-packetsThe number of packets that were enqueued (enq_ok_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
transmit-drop-packetsThe number of packets that were dropped during transmission (xmit_drop_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
transmit-success-packetsThe number of packets that were transmitted (xmit_ok_pkts).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
qos-rate-limitQoS rate limit service statistics.
greenGreen statistics.
packets <uint64>Number of green packets.
bytes <uint64>Number of green bytes.
yellowYellow statistics.
packets <uint64>Number of yellow packets.
bytes <uint64>Number of yellow bytes.
redRed statistics.
packets <uint64>Number of red packets.
bytes <uint64>Number of red bytes.
pppoePPPoE service statistics.
exc-in-unknown-channelNumber of input packets sent in exception due to an unknown channel (PppoeExcInUnknownChannel).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
exc-out-unknown-ethernetNumber of output packets sent in exception due to an unknown ethernet interface (PppoeExcOutUnknownEthernet).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
dropped-in-malformed-ppp-frameNumber of input packets dropped due to a malformed PPP frame (PppoeDroppedInMalformedPppFrame).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
dropped-out-prepend-failureNumber of output packets dropped due to an mbuf prepend failure (PppoeDroppedOutPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
dropped-in-operativeNumber of input packets dropped due to an inoperative interface (PppoeDroppedInOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
dropped-out-operativeNumber of output packets dropped due to an inoperative interface (PppoeDroppedOutOperative).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
lawful-interceptionLawful Interception service statistics.
output-packetsNumber of packets sent (LiOutputPacket).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
dropped-no-next-hopNumber of packets dropped due to next hop was not found (LiDroppedNoNextHop).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
dropped-duplication-failuresNumber of packets dropped due to an mbuf duplication failure (LiDroppedDuplicationFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
dropped-prepend-failuresNumber of packets dropped due to an mbuf prepend failure (LiDroppedPrependFailure).
total <uint64>The total value of the statistic.
cpuPer-core statistics.
id <uint16>Core ID.
value <uint64>Core statistic.
show fast-path ports¶
vsr> show fast-path ports
Show the fast path handled ports.
Output Data¶
portList of fast-path ports.
id <uint32>Fast-path port identifier.
name <string>Physical port name.
interface INTERFACEInterface name.
INTERFACEAn interface name.
vrf VRFVRF name on which the port is configured.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
driver <string>Port driver name.
show ike¶
vsr> show ike [vrf VRF] counters [vpn <string>] ike-sa [details] [with-keys] \
... [vpn <string>] [remote-ip <string>] [remote-id <string>] [state STATE] \
... ike-sa-count [state STATE] ipsec-sa-count [fastpath] ipsec-sa \
... [source-ip <string>] [destination-ip <string>] [protocol PROTOCOL] \
... [spi SPI] [mode MODE] [svti-id SVTI-ID] [with-keys] [fastpath] \
... ipsec-sp [direction DIRECTION] [svti-id SVTI-ID] [fastpath] certificate \
... [subject SUBJECT] [pem] [brief] [details] crl [issuer <distinguished-name>] \
... [pem] [brief] [details]
Show filtered SA state or general information.
Input Parameters¶
vrf VRFShow objects in selected VRF only.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
countersShow IKE counters.
vpn <string>Show counters for selected VPN.
ike-saShow SA state.
detailsShow detailed output.
with-keysShow detailed output with IKE and IPsec keys.
vpn <string>Show SA for selected VPN.
remote-ip <string>Show SAs to selected remote-ip.
remote-id <string>Show SAs to selected remote-id.
state STATEShow SAs in selected state.
STATEvaluesDescription
createdIKE SA just got created, but is not initiating nor responding yet.
connectingIKE SA gets initiated actively or passively.
establishedIKE SA is fully established.
passiveIKE SA is managed externally and does not process messages.
rekeyingIKE SA rekeying in progress.
rekeyedIKE SA has been rekeyed (or is redundant).
deletingIKE SA deletion in progress.
destroyingIKE SA object gets destroyed.
ike-sa-countShow SA count.
state STATEOnly count SAs in selected state.
STATEvaluesDescription
createdIKE SA just got created, but is not initiating nor responding yet.
connectingIKE SA gets initiated actively or passively.
establishedIKE SA is fully established.
passiveIKE SA is managed externally and does not process messages.
rekeyingIKE SA rekeying in progress.
rekeyedIKE SA has been rekeyed (or is redundant).
deletingIKE SA deletion in progress.
destroyingIKE SA object gets destroyed.
ipsec-sa-countShow IPsec SA count (default is from Linux).
fastpathShow IPsec SA count from Fast-Path.
ipsec-saShow IPsec SAs (default is from Linux).
source-ip <string>Show SAs with specified source IP.
destination-ip <string>Show SAs with specified destination IP.
protocol PROTOCOLShow SAs with specified IPsec protocol.
PROTOCOLvaluesDescription
noneNone.
ikeIKE.
ahAH.
espESP.
ipcompIPComp.
spi SPIShow SAs with specified Security Parameters Index.
SPIvaluesDescription
<0x-hex-string>Integer (uint32) encoded in decimal or hexadecimal.
<uint32>Integer (uint32) encoded in decimal or hexadecimal.
mode MODEShow SAs with specified IPsec mode.
MODEvaluesDescription
tunnelTunnel mode.
transportTransport mode.
beetBound End to End Tunnel mode.
svti-id SVTI-IDShow SAs with the specified SVTI ID.
SVTI-IDvaluesDescription
<0x-hex-string>Integer (uint32) encoded in decimal or hexadecimal.
<uint32>Integer (uint32) encoded in decimal or hexadecimal.
anyShow SVTI SAs with any SVTI ID.
noneShow non-SVTI SAs.
with-keysShow IPsec keys.
fastpathShow IPsec SAs from Fast-Path.
ipsec-spShow IPsec SPs (default is from Linux).
direction DIRECTIONShow SPs in the specified direction.
DIRECTIONvaluesDescription
outOutbound SPs.
inInbound SPs.
forwardForward SPs.
svti-id SVTI-IDShow SPs with the specified SVTI ID.
SVTI-IDvaluesDescription
<0x-hex-string>Integer (uint32) encoded in decimal or hexadecimal.
<uint32>Integer (uint32) encoded in decimal or hexadecimal.
anyShow SVTI SPs with any SVTI ID.
noneShow non-SVTI SPs.
fastpathShow IPsec SPs from Fast-Path.
certificateShow cached certificates.
subject SUBJECTFilter by certificate Subject or Subject Alternative Name.
SUBJECTvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
<fqdn>{1,253}The domain-name type represents a DNS domain name. Fully quallified left to the models which utilize this type. 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. Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be encoded in punycode as described in RFC 3492.
<user-fqdn>IKE ID (IP address, fqdn, e-mail address or distinguished name).
<distinguished-name>IKE ID (IP address, fqdn, e-mail address or distinguished name).
pemShow the certificate in PEM format.
briefShow brief information about the certificate.
detailsShow the certificate details.
crlShow cached Certificate Revocation Lists.
issuer <distinguished-name>Filter by CRL Issuer.
pemShow the CRL in PEM format.
briefShow brief information about the CRL.
detailsShow the CRL details.
show cg-nat pool-usage¶
vsr> show cg-nat pool-usage [vrf <string>] pool-name <string>{1,63} [address ADDRESS]
Show address usage of a CG-NAT pool.
Input Parameters¶
vrf <string>VRF.
pool-name <string>{1,63}(mandatory)IP address pool name.
address ADDRESSIP address in the pool.
ADDRESSAn IPv4 address.
show cg-nat translation-usage¶
vsr> show cg-nat translation-usage [vrf <string>] [rule-id <uint32>] user-address USER-ADDRESS
Show translation usage of a CG-NAT user of dynamic or deterministic rules.
Input Parameters¶
vrf <string>VRF.
rule-id <uint32>Rule id.
user-address USER-ADDRESS(mandatory)User IP address.
USER-ADDRESSvaluesDescription
<ip-address>An IPv4 address.
<ip-address>An IPv6 address.
show cg-nat user¶
vsr> show cg-nat user [vrf <string>] [rule-id <uint32>] [user-address USER-ADDRESS] \
... [threshold-errors <uint32>] [usage-min <1-100>]
Show user(s) of dynamic or deterministic CG-NAT rules.
Input Parameters¶
vrf <string>VRF.
rule-id <uint32>Rule id.
user-address USER-ADDRESSUser IP address.
USER-ADDRESSvaluesDescription
<ip-address>An IPv4 address.
<ip-address>An IPv6 address.
threshold-errors <uint32>Users having more errors than a given threshold.
usage-min <1-100>Users usage by at least the given rate.
show cg-nat blocks¶
vsr> show cg-nat blocks [vrf <string>] [rule-id <uint32>] user-address USER-ADDRESS
Show blocks of a CG-NAT user of dynamic or deterministic rules.
Input Parameters¶
vrf <string>VRF.
rule-id <uint32>Rule id.
user-address USER-ADDRESS(mandatory)User IP address.
USER-ADDRESSvaluesDescription
<ip-address>An IPv4 address.
<ip-address>An IPv6 address.
show cg-nat conntracks¶
vsr> show cg-nat conntracks [vrf <string>] [rule-id <uint32>] user-address USER-ADDRESS forward \
... [peer-address PEER-ADDRESS] backward [peer-address PEER-ADDRESS] \
... protocol tcp [peer-port PEER-PORT] udp [peer-port PEER-PORT] \
... icmp [peer-id <uint16>] icmpv6 [peer-id <uint16>] gre-pptp [key <uint16>]
Show conntracks of a CG-NAT user of dynamic or deterministic rules.
Input Parameters¶
vrf <string>VRF.
rule-id <uint32>Rule id.
user-address USER-ADDRESS(mandatory)User IP address.
USER-ADDRESSvaluesDescription
<ip-address>An IPv4 address.
<ip-address>An IPv6 address.
forwardFilter by IP and/or port using the forward tuple (the default).
peer-address PEER-ADDRESSForward peer IPv4/IPv6 address.
PEER-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
backwardFilter by IP and/or port using the backward tuple.
peer-address PEER-ADDRESSBackward peer IPv4 address.
PEER-ADDRESSAn IPv4 address.
protocolFilter contracks per protocol.
tcpShow only conntracks using the TCP protocol.
peer-port PEER-PORTPeer port.
PEER-PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
udpShow only conntracks using the UDP protocol.
peer-port PEER-PORTPeer port.
PEER-PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
icmpShow only conntracks using the ICMP protocol.
peer-id <uint16>ICMP peer identifier.
icmpv6Show only conntracks using the ICMPv6 protocol.
peer-id <uint16>ICMPv6 peer identifier.
gre-pptpShow only conntracks using the GRE-PPTP protocol.
key <uint16>GRE key.
show cg-nat conntrack-statistics¶
vsr> show cg-nat conntrack-statistics [vrf <string>] [rule-id <uint32>]
Show conntracks usage statistics of dynamic or deterministic CG-NAT rules.
Input Parameters¶
vrf <string>VRF.
rule-id <uint32>Rule id.
show cg-nat translation-statistics¶
vsr> show cg-nat translation-statistics [vrf <string>] [rule-id <uint32>] [protocol PROTOCOL]
Show translation usage statistics of dynamic or deterministic CG-NAT rules.
Input Parameters¶
vrf <string>VRF.
rule-id <uint32>Rule id.
protocol PROTOCOLProtocol.
PROTOCOLvaluesDescription
tcpTransmission Control Protocol.
udpUser Datagram Protocol.
icmpInternet Control Message Protocol.
gre-pptpGeneric Routing Encapsulation for Point-to-Point Tunneling Protocol.
show cg-nat block-statistics¶
vsr> show cg-nat block-statistics [vrf <string>] [rule-id <uint32>] [protocol PROTOCOL]
Show block usage statistics of dynamic or deterministic CG-NAT rules.
Input Parameters¶
vrf <string>VRF.
rule-id <uint32>Rule id.
protocol PROTOCOLProtocol.
PROTOCOLvaluesDescription
tcpTransmission Control Protocol.
udpUser Datagram Protocol.
icmpInternet Control Message Protocol.
gre-pptpGeneric Routing Encapsulation for Point-to-Point Tunneling Protocol.
show cg-nat hash-table-statistics¶
vsr> show cg-nat hash-table-statistics
Show hash table statistics.
show cg-nat statistics¶
vsr> show cg-nat statistics
Show CG-NAT statistics.
Output Data¶
hairpinningHairpinning statistics.
hairpinned-packets <uint64>Number of packets forwarded between two hosts under the same NAT device. The two hosts communicate with each other using their external IP address.
loop-hairpin-dropped-packets <uint64>Number of hairpinned packets dropped due to the detection of a routing loop.
self-hairpin-dropped-packets <uint64>Number of hairpinned packets dropped due to a host attempting to send packets to its own NATed address.
natNAT statistics.
allocations <uint64>Number of NAT allocations.
destructions <uint64>Number of NAT destructions.
allocation-failures <uint64>Number of NAT allocation failures.
association-races <uint64>Number of NAT association races. This race occurs when a CPU attempts to associate a NAT object with a conntrack object that has already been associated by another CPU in the meantime.
port-allocation-failures <uint64>Number of NAT port allocation failures.
port-overloading-allocations <uint64>Number of NAT port overloaded allocations.
port-overloading-destructions <uint64>Number of NAT port overloaded destructions.
nat64-udp-null-checksum-dropped-packets <uint64>Number of dropped IPv4 UDP packets with null checksums. While in IPv6, null checksums are not allowed for UDP. When nating from IPv4 to IPv6, if the UDP checksum is NULL, it cannot be modified. In this case, the packet is dropped. It is possible to compute a full checksum by setting an option for NAT64.
blockBlock statistics.
allocations <uint64>Number of block allocations.
destructions <uint64>Number of block destructions.
allocation-failures <uint64>Number of block allocation failures. It happens when there are no blocks available in the pool.
userUser statistics.
allocations <uint64>Number of user allocations.
destructions <uint64>Number of user destructions.
allocation-failures <uint64>Number of user allocation failures.
duplicate-races <uint64>Number of attempts to create a duplicate user. This race occurs when a CPU attempts to create a new user that has already been created by another CPU in the meantime.
association-races <uint64>Number of user association races. This race occurs when a CPU attempts to associate a NAT object with a user object, indicating that the user object has already been released by another CPU.
too-many-conntracks <uint64>Number of times a user attempts to create more conntracks than the maximum allowed (i.e. max-conntracks-per-user in the cgnat rule).
no-public-ip-errors <uint64>Number of user allocation failures due the depletion of all available public IPs.
full-public-ip-errors <uint64>Number of block allocation failures due to the unavailability of port blocks in the user’s public IP.
loggingLogging statistics.
enqueues-to-logging-thread <uint64>Number of enqueued logs to logging threads.
enqueue-failures <uint64>Number of enqueued log failures.
build-failures <uint64>Number of log generation failures.
local-serverLocal server statistics.
transmit <uint64>Number of logs successfully transmitted to the local server.
transmit-errors <uint64>Number of logs failed to transmit to the local server.
remote-serversRemote servers statistics.
transmit <uint64>Number of logs successfully transmitted to the remote servers.
transmit-errors <uint64>Number of logs failed to transmit to the remote servers.
show cg-nat log-collectors¶
vsr> show cg-nat log-collectors [vrf <string>]
Show log collectors on a given vrf.
Input Parameters¶
vrf <string>VRF.
Output Data¶
rsyslog-groupConfigured groups of remote rsyslog collectors and their associated log messages transmission statistics.
name <string>The name of the collector group.
collectorList of remote collectors receiving CG-NAT logs.
address ADDRESSIP address of the remote log collector.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
port PORTThe destination port number for log messages to the collector.
PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
source SOURCEThe IPv4/IPv6 source address used to reach the log collector.
SOURCEvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
vrf <string>The VRF from which to access the log collector.
clientConnection state and statistics per event thread.
name <string>Name of the log client.
statisticsThe statistics for this server.
transmit <uint64>The number of logs transmitted to this server.
transmit-error <uint64>The number of logs that have not been transmitted to this server.
build-error <uint64>The number of logs that have not been built to this server.
connection-status CONNECTION-STATUSConnection status.
CONNECTION-STATUSvaluesDescription
errorConnection Unusable (Internal error).
not-connectedNo connection.
connectingConnecting.
establishedConnection established.
unknownConnection state unknown.
ipfix-groupConfigured groups of remote IPFIX collectors and their associated log messages transmission statistics.
name <string>The name of the collector group.
collectorList of remote collectors receiving CG-NAT logs.
address ADDRESSIP address of the remote log collector.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
port PORTThe destination port number for log messages to the collector.
PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
source SOURCEThe IPv4/IPv6 source address used to reach the log collector.
SOURCEvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
vrf <string>The VRF from which to access the log collector.
clientConnection state and statistics per event thread.
name <string>Name of the log client.
statisticsThe statistics for this server.
transmit <uint64>The number of logs transmitted to this server.
transmit-error <uint64>The number of logs that have not been transmitted to this server.
build-error <uint64>The number of logs that have not been built to this server.
connection-status CONNECTION-STATUSConnection status.
CONNECTION-STATUSvaluesDescription
errorConnection Unusable (Internal error).
not-connectedNo connection.
connectingConnecting.
establishedConnection established.
unknownConnection state unknown.
show ha-neighbor¶
vsr> show ha-neighbor [vrf VRF] state
Show high-availability neighbor state.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
state(mandatory)Show high-availability neighbor state.
show ha-conntrack¶
vsr> show ha-conntrack [vrf VRF] [state] [cache CACHE]
Show high-availability conntrack state.
Input Parameters¶
vrf VRFSpecify the VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
stateShow high-availability conntrack state.
cache CACHEDisplay cache content.
CACHEvaluesDescription
internalDisplay content of the internal cache.
externalDisplay content of the external cache.
show ha-ike peer¶
vsr> show ha-ike peer [vrf VRF] [name NAME]
Show IKE HA peers.
Input Parameters¶
vrf VRFShow state in selected VRF only.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
name NAMEName of the HA peer.
NAMEIKE object name type.
Output Data¶
peerList of HA peers.
name NAMEName of the HA peer.
NAMEIKE object name type.
local-address LOCAL-ADDRESSLocal IP address to communicate with the HA peer.
LOCAL-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-address REMOTE-ADDRESSRemote IP address to communicate with the HA peer.
REMOTE-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
role ROLELocal role in the connection.
ROLEvaluesDescription
clientTCP client.
serverTCP server.
state STATEStatus of the connection.
STATEvaluesDescription
createdPeer context created.
initPeer context initialized, waiting for ha module to start.
stop-recvSending is stopped, waiting for receiving to stop.
need-connectSending and receiving are stopped, connection with peer needed.
connectingConnection with peer in progress.
connectedConnection with peer established.
deadPeer context ready to be freed.
<string>No description.
show ha-ike state¶
vsr> show ha-ike state [vrf VRF]
Show IKE HA state.
Input Parameters¶
vrf VRFShow state in selected VRF only.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
Output Data¶
state STATEThe high-availability state of IKE.
STATEvaluesDescription
masterMaster state.
backupBackup state.
show vxlan fdb¶
vsr> show vxlan fdb [vrf <string>] [name NAME]
Show VXLAN FDB information.
Input Parameters¶
vrf <string>VRF to look into.
name NAMEShow FDB per interface.
NAMEAn interface name.
Output Data¶
vxlanVXLAN interface list.
name NAMEVXLAN interface name.
NAMEAn interface name.
ipv4IPv4 FDB operational state data.
fdbIPv4 FDB operational state data.
link-layer-address LINK-LAYER-ADDRESSThe link-layer address of the FDB node.
LINK-LAYER-ADDRESSAn IEEE 802 MAC address.
ip IP(mandatory)The IP address of the destination VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
IPAn IPv4 address.
link-interface LINK-INTERFACEThe outgoing interface for the VXLAN device driver to reach the remote VXLAN tunnel endpoint.
LINK-INTERFACEAn interface name.
port PORTThe UDP destination PORT number to use to connect to the remote VXLAN tunnel endpoint (default: the VXLAN dst).
PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
vni VNIThe VXLAN VNI Network Identifier (or VXLAN Segment ID) to use to connect to the remote VXLAN tunnel endpoint (default: the VXLAN vni).
VNIType definition representing VXLAN Segment ID / VXLAN Network Identifier value.
state STATEFDB operational state.
STATEvaluesDescription
reachableThe neighbor is known to have been reachable recently (within tens of seconds ago).
staleThe neighbor is no longer known to be reachable, but until traffic is sent to the neighbor no attempt should be made to verify its reachability.
permanentThe FDB has been permanently configured.
staticThe FDB has been statically configured.
otherThe FDB state is none of the above.
ipv6IPv4 FDB operational state data.
fdbIPv6 FDB operational state data.
link-layer-address LINK-LAYER-ADDRESSThe link-layer address of the FDB node.
LINK-LAYER-ADDRESSAn IEEE 802 MAC address.
ip IP(mandatory)The IP address of the destination VXLAN tunnel endpoint where the Ethernet MAC ADDRESS resides.
IPAn IPv6 address.
link-interface LINK-INTERFACEThe outgoing interface for the VXLAN device driver to reach the remote VXLAN tunnel endpoint.
LINK-INTERFACEAn interface name.
port PORTThe UDP destination PORT number to use to connect to the remote VXLAN tunnel endpoint (default: the VXLAN dst).
PORTA 16-bit port number used by a transport protocol such as TCP or UDP.
vni VNIThe VXLAN VNI Network Identifier (or VXLAN Segment ID) to use to connect to the remote VXLAN tunnel endpoint (default: the VXLAN vni).
VNIType definition representing VXLAN Segment ID / VXLAN Network Identifier value.
state STATEFDB operational state.
STATEvaluesDescription
reachableThe neighbor is known to have been reachable recently (within tens of seconds ago).
staleThe neighbor is no longer known to be reachable, but until traffic is sent to the neighbor no attempt should be made to verify its reachability.
permanentThe FDB has been permanently configured.
staticThe FDB has been statically configured.
otherThe FDB state is none of the above.
show bridge fdb¶
vsr> show bridge fdb [vrf <string>] [name NAME]
Show bridge FDB information.
Input Parameters¶
vrf <string>The VRF to look into.
name NAMEThe name of the interface for which the FDB will be displayed.
NAMEAn interface name.
Output Data¶
bridgeBridge interface list.
name NAMEThe bridge interface name.
NAMEAn interface name.
fdbFDB operational state data.
link-layer-address LINK-LAYER-ADDRESSThe link-layer address of the FDB node.
LINK-LAYER-ADDRESSAn IEEE 802 MAC address.
link-interface LINK-INTERFACEThe slave interface of this bridge.
LINK-INTERFACEAn interface name.
state STATEThe FDB operational state.
STATEvaluesDescription
reachableThe neighbor is known to have been reachable recently (within tens of seconds ago).
staleThe neighbor is no longer known to be reachable, but until traffic is sent to the neighbor no attempt should be made to verify its reachability.
permanentThe FDB has been permanently configured.
staticThe FDB has been statically configured.
otherThe FDB state is none of the above.
show dns-server¶
vsr> show dns-server [vrf <string>] [l3vrf <string>]
Show DNS server information.
Input Parameters¶
vrf <string>VRF to look into.
l3vrf <string>Specify the l3vrf.
Output Data¶
cacheDNS server cache operational state data.
size <uint32>DNS server cache size in bytes.
inserted <uint32>Number of records that have been inserted into the cache.
queryDNS server query operation state data.
total <uint32>Number of queries.
forwarded <uint32>Number of forwarded queries.
local <uint32>Number of queries answered locally.
tls <uint32>Number of TLS queries.
https <uint32>Number of HTTPS queries.
unwanted <uint32>Replies that were unwanted or unsolicited. Could have been random traffic, delayed duplicates, very late answers, or could be spoofing attempts. Some low level of late answers and delayed duplicates are to be expected with the UDP protocol. Very high values could indicate a threat (spoofing).
show certificate¶
vsr> show certificate name NAME [pem] [details]
Show X509 certificate details.
Input Parameters¶
name NAME(mandatory)The name of the certificate.
NAMECertificate name.
pemShow the certificate in PEM format.
detailsShow the certificate details.
show certificate key¶
vsr> show certificate key name NAME [pem] [details]
Show X509 certificate private key.
Input Parameters¶
name NAME(mandatory)The name of the certificate.
NAMECertificate name.
pemShow the keypair in PEM format.
detailsShow the keypair details.
show certificate-request list¶
vsr> show certificate-request list
Show X509 certificate signing request (PKCS #10) list.
show certificate-request key¶
vsr> show certificate-request key name NAME [pem] [details]
Show X509 certificate signing request (PKCS #10) key.
Input Parameters¶
name NAME(mandatory)The name of the certificate request.
NAMECertificate name.
pemShow the keypair in PEM format (default).
detailsShow the keypair details.
show certificate-request¶
vsr> show certificate-request name NAME [pem] [details]
Show an X509 certificate signing request (PKCS #10).
Input Parameters¶
name NAME(mandatory)The name of the certificate request.
NAMECertificate name.
pemShow the certificate-request in PEM format (default).
detailsShow the certificate-request details.
show certificate cmp scheduled-update¶
vsr> show certificate cmp scheduled-update name NAME
Show status of certificate scheduled updates via CMP.
Input Parameters¶
name NAME(mandatory)The name of the certificate.
NAMECertificate name.
show alarm list¶
vsr> show alarm list
Display the list of alarms.
Output Data¶
number-of-alarms NUMBER-OF-ALARMSThis object shows the total number of alarms in the system, i.e., the total number of entries in the alarm list.
NUMBER-OF-ALARMSThe gauge32 type represents a non-negative integer, which may increase or decrease, but shall never exceed a maximum value, nor fall below a minimum value. The maximum value cannot be greater than 2^32-1 (4294967295 decimal), and the minimum value cannot be smaller than 0. The value of a gauge32 has its maximum value whenever the information being modeled is greater than or equal to its maximum value, and has its minimum value whenever the information being modeled is smaller than or equal to its minimum value. If the information being modeled subsequently decreases below (increases above) the maximum (minimum) value, the gauge32 also decreases (increases). In the value set and its semantics, this type is equivalent to the Gauge32 type of the SMIv2.
last-changed LAST-CHANGEDA timestamp when the alarm list was last changed. The value can be used by a manager to initiate an alarm resynchronization procedure.
LAST-CHANGEDThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
alarmThe list of alarms. Each entry in the list holds one alarm for a given alarm type and resource. An alarm can be updated from the underlying resource or by the user. The following leafs are maintained by the resource: ‘is-cleared’, ‘last-change’, ‘perceived-severity’, and ‘alarm-text’. An operator can change ‘operator-state’ and ‘operator-text’. Entries appear in the alarm list the first time an alarm becomes active for a given alarm type and resource. Entries do not get deleted when the alarm is cleared. Clear status is represented as a boolean flag. Alarm entries are removed, i.e., purged, from the list by an explicit purge action. For example, purge all alarms that are cleared and in closed operator state that are older than 24 hours. Purged alarms are removed from the alarm list. If the alarm resource state changes after a purge, the alarm will reappear in the alarm list. Systems may also remove alarms based on locally configured policies; this is out of scope for this module.
resource RESOURCE(mandatory)The alarming resource. See also ‘alt-resource’. This could be, for example, a reference to the alarming interface.
RESOURCEvaluesDescription
<instance-identifier>References a data tree node
<object-identifier>The object-identifier type represents administratively assigned names in a registration-hierarchical-name tree. Values of this type are denoted as a sequence of numerical non-negative sub-identifier values. Each sub-identifier value MUST NOT exceed 2^32-1 (4294967295). Sub-identifiers are separated by single dots and without any intermediate whitespace. The ASN.1 standard restricts the value space of the first sub-identifier to 0, 1, or 2. Furthermore, the value space of the second sub-identifier is restricted to the range 0 to 39 if the first sub-identifier is 0 or 1. Finally, the ASN.1 standard requires that an object identifier has always at least two sub-identifiers. The pattern captures these restrictions. Although the number of sub-identifiers is not limited, module designers should realize that there may be implementations that stick with the SMIv2 limit of 128 sub-identifiers. This type is a superset of the SMIv2 OBJECT IDENTIFIER type since it is not restricted to 128 sub-identifiers. Hence, this type SHOULD NOT be used to represent the SMIv2 OBJECT IDENTIFIER type; the object-identifier-128 type SHOULD be used instead.
<string>This is an identification of the alarming resource, such as an interface. It should be as fine-grained as possible to both guide the operator and guarantee uniqueness of the alarms. If the alarming resource is modeled in YANG, this type will be an instance-identifier. If the resource is an SNMP object, the type will be an ‘object-identifier’. If the resource is anything else, for example, a distinguished name or a Common Information Model (CIM) path, this type will be a string. If the alarming object is identified by a Universally Unique Identifier (UUID), use the uuid type. Be cautious when using this type, since a UUID is hard to use for an operator. If the server supports several models, the precedence should be in the order as given in the union definition.
<uuid>A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6
alarm-type-id ALARM-TYPE-ID(mandatory)This leaf and the leaf ‘alarm-type-qualifier’ together provide a unique identification of the alarm type.
ALARM-TYPE-IDIdentifies an alarm type. The description of the alarm type id MUST indicate whether or not the alarm type is abstract. An abstract alarm type is used as a base for other alarm type ids and will not be used as a value for an alarm or be present in the alarm inventory.
alarm-type-qualifier ALARM-TYPE-QUALIFIERThis leaf is used when the ‘alarm-type-id’ leaf cannot uniquely identify the alarm type. Normally, this is not the case, and this leaf is the empty string.
ALARM-TYPE-QUALIFIERIf an alarm type cannot be fully specified at design time by ‘alarm-type-id’, this string qualifier is used in addition to fully define a unique alarm type. The definition of alarm qualifiers is considered to be part of the instrumentation and is out of scope for this module. An empty string is used when this is part of a key.
alt-resource ALT-RESOURCEUsed if the alarming resource is available over other interfaces. This field can contain SNMP OIDs, CIM paths, or 3GPP distinguished names, for example.
ALT-RESOURCEvaluesDescription
<instance-identifier>References a data tree node
<object-identifier>The object-identifier type represents administratively assigned names in a registration-hierarchical-name tree. Values of this type are denoted as a sequence of numerical non-negative sub-identifier values. Each sub-identifier value MUST NOT exceed 2^32-1 (4294967295). Sub-identifiers are separated by single dots and without any intermediate whitespace. The ASN.1 standard restricts the value space of the first sub-identifier to 0, 1, or 2. Furthermore, the value space of the second sub-identifier is restricted to the range 0 to 39 if the first sub-identifier is 0 or 1. Finally, the ASN.1 standard requires that an object identifier has always at least two sub-identifiers. The pattern captures these restrictions. Although the number of sub-identifiers is not limited, module designers should realize that there may be implementations that stick with the SMIv2 limit of 128 sub-identifiers. This type is a superset of the SMIv2 OBJECT IDENTIFIER type since it is not restricted to 128 sub-identifiers. Hence, this type SHOULD NOT be used to represent the SMIv2 OBJECT IDENTIFIER type; the object-identifier-128 type SHOULD be used instead.
<string>This is an identification of the alarming resource, such as an interface. It should be as fine-grained as possible to both guide the operator and guarantee uniqueness of the alarms. If the alarming resource is modeled in YANG, this type will be an instance-identifier. If the resource is an SNMP object, the type will be an ‘object-identifier’. If the resource is anything else, for example, a distinguished name or a Common Information Model (CIM) path, this type will be a string. If the alarming object is identified by a Universally Unique Identifier (UUID), use the uuid type. Be cautious when using this type, since a UUID is hard to use for an operator. If the server supports several models, the precedence should be in the order as given in the union definition.
<uuid>A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6
time-created TIME-CREATED(mandatory)The timestamp when this alarm entry was created. This represents the first time the alarm appeared; it can also represent that the alarm reappeared after a purge. Further state changes of the same alarm do not change this leaf; these changes will update the ‘last-changed’ leaf.
TIME-CREATEDThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
is-cleared true|false(mandatory)Indicates the current clearance state of the alarm. An alarm might toggle from active alarm to cleared alarm and back to active again.
last-raised LAST-RAISED(mandatory)An alarm may change severity level and toggle between active and cleared during its lifetime. This leaf indicates the last time it was raised (‘is-cleared’ = ‘false’).
LAST-RAISEDThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
last-changed LAST-CHANGED(mandatory)A timestamp when the ‘status-change’ or ‘operator-state-change’ list was last changed.
LAST-CHANGEDThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
perceived-severity PERCEIVED-SEVERITY(mandatory)The last severity of the alarm. If an alarm was raised with severity ‘warning’ but later changed to ‘major’, this leaf will show ‘major’.
PERCEIVED-SEVERITYvaluesDescription
indeterminateIndicates that the severity level could not be determined. This level SHOULD be avoided.
warningThe ‘warning’ severity level indicates the detection of a potential or impending service-affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service-affecting fault.
minorThe ‘minor’ severity level indicates the existence of a non-service-affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service-affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the resource.
majorThe ‘major’ severity level indicates that a service- affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the resource and its full capability must be restored.
criticalThe ‘critical’ severity level indicates that a service- affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a resource becomes totally out of service and its capability must be restored.
alarm-text ALARM-TEXT(mandatory)The last reported alarm text. This text should contain information for an operator to be able to understand the problem and how to resolve it.
ALARM-TEXTThe string used to inform operators about the alarm. This MUST contain enough information for an operator to be able to understand the problem and how to resolve it. If this string contains structure, this format should be clearly documented for programs to be able to parse that information.
show alarm inventory¶
vsr> show alarm inventory
Display an inventory of the possible alarms.
Output Data¶
alarm-typeAn entry in this list defines a possible alarm.
alarm-type-id ALARM-TYPE-IDThe statically defined alarm type identifier for this possible alarm.
ALARM-TYPE-IDIdentifies an alarm type. The description of the alarm type id MUST indicate whether or not the alarm type is abstract. An abstract alarm type is used as a base for other alarm type ids and will not be used as a value for an alarm or be present in the alarm inventory.
alarm-type-qualifier ALARM-TYPE-QUALIFIERThe optionally dynamically defined alarm type identifier for this possible alarm.
ALARM-TYPE-QUALIFIERIf an alarm type cannot be fully specified at design time by ‘alarm-type-id’, this string qualifier is used in addition to fully define a unique alarm type. The definition of alarm qualifiers is considered to be part of the instrumentation and is out of scope for this module. An empty string is used when this is part of a key.
severity-level-triggerAn entry in this list defines a possible severity level.
severity-level-id SEVERITY-LEVEL-IDThis leaf-list indicates the possible severity levels of this alarm type. Note well that ‘clear’ is not part of the severity type. In general, the severity level should be defined by the instrumentation based on the dynamic state, rather than being defined statically by the alarm type, in order to provide a relevant severity level based on dynamic state and context. However, most alarm types have a defined set of possible severity levels, and this should be provided here.
SEVERITY-LEVEL-IDvaluesDescription
clearedThe alarm is cleared by the instrumentation.
indeterminateIndicates that the severity level could not be determined. This level SHOULD be avoided.
warningThe ‘warning’ severity level indicates the detection of a potential or impending service-affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service-affecting fault.
minorThe ‘minor’ severity level indicates the existence of a non-service-affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service-affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the resource.
majorThe ‘major’ severity level indicates that a service- affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the resource and its full capability must be restored.
criticalThe ‘critical’ severity level indicates that a service- affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a resource becomes totally out of service and its capability must be restored.
text <string>(mandatory)A user-friendly text describing the alarm-state change. Some variables are available in the text {name} {description} {severity} {value}.
above <int64>The alarm will be triggered if the value is above.
below <int64>The alarm will be triggered if the value is below.
betweenThe alarm will be triggered if the value is between start and end.
start <int64>Set the start value.
end <int64>Set the end value.
equal EQUALThe alarm will be triggered if the value is equal.
EQUALvaluesDescription
<int64>No description.
<string>No description.
true|falseNo description.
different DIFFERENTThe alarm will be triggered if the value is different.
DIFFERENTvaluesDescription
<int64>No description.
<string>No description.
true|falseNo description.
resource RESOURCEOptionally, specifies for which resources the alarm type is valid.
RESOURCEvaluesDescription
<xpath1.0>This type represents an XPATH 1.0 expression. When a schema node is defined that uses this type, the description of the schema node MUST specify the XPath context in which the XPath expression is evaluated.
<object-identifier>The object-identifier type represents administratively assigned names in a registration-hierarchical-name tree. Values of this type are denoted as a sequence of numerical non-negative sub-identifier values. Each sub-identifier value MUST NOT exceed 2^32-1 (4294967295). Sub-identifiers are separated by single dots and without any intermediate whitespace. The ASN.1 standard restricts the value space of the first sub-identifier to 0, 1, or 2. Furthermore, the value space of the second sub-identifier is restricted to the range 0 to 39 if the first sub-identifier is 0 or 1. Finally, the ASN.1 standard requires that an object identifier has always at least two sub-identifiers. The pattern captures these restrictions. Although the number of sub-identifiers is not limited, module designers should realize that there may be implementations that stick with the SMIv2 limit of 128 sub-identifiers. This type is a superset of the SMIv2 OBJECT IDENTIFIER type since it is not restricted to 128 sub-identifiers. Hence, this type SHOULD NOT be used to represent the SMIv2 OBJECT IDENTIFIER type; the object-identifier-128 type SHOULD be used instead.
<string>This type is used to match resources of type ‘resource’. Since the type ‘resource’ is a union of different types, the ‘resource-match’ type is also a union of corresponding types. If the type is given as an XPath 1.0 expression, a resource of type ‘instance-identifier’ matches if the instance is part of the node set that is the result of evaluating the XPath 1.0 expression. For example, the XPath 1.0 expression: /ietf-interfaces:interfaces/ietf-interfaces:interface [ietf-interfaces:type=’ianaift:ethernetCsmacd’] would match the resource instance-identifier: /if:interfaces/if:interface[if:name=’eth1’], assuming that the interface ‘eth1’ is of type ‘ianaift:ethernetCsmacd’. If the type is given as an object identifier, a resource of type ‘object-identifier’ matches if the match object identifier is a prefix of the resource’s object identifier. For example, the value: 1.3.6.1.2.1.2.2 would match the resource object identifier: 1.3.6.1.2.1.2.2.1.1.5 If the type is given as an UUID or a string, it is interpreted as an XML Schema regular expression, which matches a resource of type ‘yang:uuid’ or ‘string’ if the given regular expression matches the resource string. If the type is given as an XPath expression, it is evaluated in the following XPath context: o The set of namespace declarations is the set of prefix and namespace pairs for all YANG modules implemented by the server, where the prefix is the YANG module name and the namespace is as defined by the ‘namespace’ statement in the YANG module. If a leaf of this type is encoded in XML, all namespace declarations in scope on the leaf element are added to the set of namespace declarations. If a prefix found in the XML is already present in the set of namespace declarations, the namespace in the XML is used. o The set of variable bindings is empty. o The function library is the core function library, and the functions are defined in Section 10 of RFC 7950. o The context node is the root node in the data tree.
description <string>(mandatory)A description of the possible alarm. It SHOULD include information on possible underlying root causes and corrective actions.
will-clear true|false(mandatory)This leaf tells the operator if the alarm will be cleared when the correct corrective action has been taken. Implementations SHOULD strive for detecting the cleared state for all alarm types. If this leaf is ‘true’, the operator can monitor the alarm until it becomes cleared after the corrective action has been taken. If this leaf is ‘false’, the operator needs to validate that the alarm is no longer active using other mechanisms. Alarms can lack a corresponding clear due to missing instrumentation or no logical corresponding clear state.
severity-level SEVERITY-LEVELThis leaf-list indicates the possible severity levels of this alarm type. Note well that ‘clear’ is not part of the severity type. In general, the severity level should be defined by the instrumentation based on the dynamic state, rather than being defined statically by the alarm type, in order to provide a relevant severity level based on dynamic state and context. However, most alarm types have a defined set of possible severity levels, and this should be provided here.
SEVERITY-LEVELvaluesDescription
indeterminateIndicates that the severity level could not be determined. This level SHOULD be avoided.
warningThe ‘warning’ severity level indicates the detection of a potential or impending service-affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service-affecting fault.
minorThe ‘minor’ severity level indicates the existence of a non-service-affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service-affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the resource.
majorThe ‘major’ severity level indicates that a service- affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the resource and its full capability must be restored.
criticalThe ‘critical’ severity level indicates that a service- affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a resource becomes totally out of service and its capability must be restored.
show alarm summary¶
vsr> show alarm summary
Display a summary of the alarms.
Output Data¶
alarm-summaryA global summary of all alarms in the system. The summary does not include shelved alarms.
severity SEVERITYAlarm summary for this severity level.
SEVERITYvaluesDescription
indeterminateIndicates that the severity level could not be determined. This level SHOULD be avoided.
warningThe ‘warning’ severity level indicates the detection of a potential or impending service-affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service-affecting fault.
minorThe ‘minor’ severity level indicates the existence of a non-service-affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service-affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the resource.
majorThe ‘major’ severity level indicates that a service- affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the resource and its full capability must be restored.
criticalThe ‘critical’ severity level indicates that a service- affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a resource becomes totally out of service and its capability must be restored.
total TOTALTotal number of alarms of this severity level.
TOTALThe gauge32 type represents a non-negative integer, which may increase or decrease, but shall never exceed a maximum value, nor fall below a minimum value. The maximum value cannot be greater than 2^32-1 (4294967295 decimal), and the minimum value cannot be smaller than 0. The value of a gauge32 has its maximum value whenever the information being modeled is greater than or equal to its maximum value, and has its minimum value whenever the information being modeled is smaller than or equal to its minimum value. If the information being modeled subsequently decreases below (increases above) the maximum (minimum) value, the gauge32 also decreases (increases). In the value set and its semantics, this type is equivalent to the Gauge32 type of the SMIv2.
not-cleared NOT-CLEAREDTotal number of alarms of this severity level that are not cleared.
NOT-CLEAREDThe gauge32 type represents a non-negative integer, which may increase or decrease, but shall never exceed a maximum value, nor fall below a minimum value. The maximum value cannot be greater than 2^32-1 (4294967295 decimal), and the minimum value cannot be smaller than 0. The value of a gauge32 has its maximum value whenever the information being modeled is greater than or equal to its maximum value, and has its minimum value whenever the information being modeled is smaller than or equal to its minimum value. If the information being modeled subsequently decreases below (increases above) the maximum (minimum) value, the gauge32 also decreases (increases). In the value set and its semantics, this type is equivalent to the Gauge32 type of the SMIv2.
cleared CLEAREDFor this severity level, the number of alarms that are cleared.
CLEAREDThe gauge32 type represents a non-negative integer, which may increase or decrease, but shall never exceed a maximum value, nor fall below a minimum value. The maximum value cannot be greater than 2^32-1 (4294967295 decimal), and the minimum value cannot be smaller than 0. The value of a gauge32 has its maximum value whenever the information being modeled is greater than or equal to its maximum value, and has its minimum value whenever the information being modeled is smaller than or equal to its minimum value. If the information being modeled subsequently decreases below (increases above) the maximum (minimum) value, the gauge32 also decreases (increases). In the value set and its semantics, this type is equivalent to the Gauge32 type of the SMIv2.
show ipfix statistics¶
vsr> show ipfix statistics [vrf VRF]
Get statistics from an IPFIX probe.
Input Parameters¶
vrf VRFThe VRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
Output Data¶
probeStatistics list per probe in the same VRF.
interface INTERFACEInterface name.
INTERFACEAn interface name.
statsStatistics associated with the probe.
flow-received <uint64>The number of received flows from the dataplane.
flow-merged <uint64>The number of merged flows (updated since the last synchronization with the dataplane).
flow-expired <uint64>The number of expired flows due to a timeout (no new packet for this flow has been recently received). The expiration timeout is the sum of ‘active-flow-lifetime-interval-seconds’ and ‘idle-flow-lifetime-interval-seconds’ configured in the collector associated with this probe.
show commit¶
vsr> show commit
Show committed configurations.
Output Data¶
commit-historyCommit information.
id <uint32>ID of the commit in the list.
date DATEDate and time of the commit.
DATEThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
user <string>User who make the commit.
description <string>{0,1024}The description of the commit.
show ipoe-server session¶
vsr> show ipoe-server session [vrf VRF] [details] match [username <string>] [interface INTERFACE] \
... [ip IP] [mac MAC] [vlans VLANS]
Display IPoE server sessions.
Input Parameters¶
vrf VRFThe VRF in which IPoE server is started.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
detailsDisplay detailed information.
matchMatch specific sessions. It acts as a logical AND operation.
username <string>The username associated to the session.
interface INTERFACEThe interface of the session.
INTERFACEAn interface name.
ip IPThe IP address of the client.
IPvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
mac MACThe MAC address of the client.
MACAn IEEE 802 MAC address.
vlans VLANSThe dynamic VLANs of the session, each entry must contain the tag protocol ID, either 0x8100 for the inner VLAN or 0x88a8 for the outer (PE) VLAN, followed by a dash and the VLAN ID.
VLANSvaluesDescription
noneNo dynamic VLANs.
0x(88a8|8100)-<vlanid>[,(0x(88a8|8100)-<vlanid>]{0,2}No description.
Output Data¶
sessionDHCP relay sessions state.
interface INTERFACEInterface name.
INTERFACEAn interface name.
username <string>IPoE client username.
mac MACDHCP client identifier (MAC address).
MACAn IEEE 802 MAC address.
ip IPDHCP client IP address.
IPvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
status <string>Session operational status.
uptime <string>Session uptime.
server SERVERThe DHCP serveur IP addresses.
SERVERvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
l3vrf <string>The l3vrf of the IPoE session.
vlans <string>Session’s dynamic VLANs, each entry indicated the tag protocol ID, either 0x8100 for the inner VLAN or 0x88a8 for the outer (PE) VLAN, followed by the related VLAN ID used by the session.
ipv6-delegated-prefix IPV6-DELEGATED-PREFIXIPv6 delegated prefix.
IPV6-DELEGATED-PREFIXAn IPv6 prefix: address and CIDR mask.
inbound-interface INBOUND-INTERFACEInbound Interface.
INBOUND-INTERFACEAn interface name.
accounting-session-id <string>Accounting session ID.
circuit-id <string>IPOE circuit ID.
remote-id <string>IPOE remote ID.
qos-template <string>QoS template name.
rate-limit-in <string>Rate limiter for incoming traffic.
rate-limit-out <string>Rate limiter for outgoing traffic.
show ipoe-server subscribers¶
vsr> show ipoe-server subscribers [vrf VRF]
Show IPoE subscribers count. A subscriber represents all IPoE sessions associated with a single username.
Input Parameters¶
vrf VRFThe VRF in which IPoE server is started.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
Output Data¶
count <uint64>Show IPoE subscribers count.
show ppp-server statistics¶
vsr> show ppp-server statistics [vrf <string>] instance <string> sessions [interface INTERFACE] \
... [vlans VLANS]
Show ppp-server stats.
Input Parameters¶
vrf <string>Show objects in selected vrf only.
instance <string>(mandatory)Show stats for the selected ppp-server.
sessionsShow detailed sessions statistics.
interface INTERFACEShow sessions in selected interface only.
INTERFACEAn interface name.
vlans VLANSShow sessions in selected dynamic VLANs, each entry must contain the tag protocol ID, either 0x8100 for the inner VLAN or 0x88a8 for the outer (PE) VLAN, followed by a dash and the VLAN ID.
VLANSvaluesDescription
noneNo dynamic VLANs.
0x(88a8|8100)-<vlanid>[,(0x(88a8|8100)-<vlanid>]{0,2}No description.
Output Data¶
sessionsContainer for the sessions state.
statsPPP sessions statistics.
starting <uint64>Show starting sessions.
active <uint64>Show active sessions.
finishing <uint64>Show finishing sessions.
interfacesList of interfaces.
name <string>Name of the interface.
statsPPP sessions statistics of the interface.
starting <uint64>Show starting sessions.
active <uint64>Show active sessions.
finishing <uint64>Show finishing sessions.
vlansList of dynamic vlans.
name <string>Name of the dynamic vlan.
statsPPP sessions statistics of the dynamic vlan.
starting <uint64>Show starting sessions.
active <uint64>Show active sessions.
finishing <uint64>Show finishing sessions.
pppoeContainer for PPPoE counters.
start-ses <uint64>Show PPPoE starting sessions.
active-ses <uint64>Show PPPoE active sessions.
recv-PADI <uint64>Show counters for PADI received packets.
drop-PADI <uint64>Show counters for dropped PADI packets.
sent-PADO <uint64>Show counters for PADO sent packets.
recv-PADR <uint64>Show counters for PADR received packets.
sent-PADS <uint64>Show counters for PADS sent packets.
radius-serverList of Radius servers counters.
id <uint32>Show Radius server identifier.
address ADDRESSShow Radius server IP address.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
state <string>Show state of Radius server.
auth-sent <uint64>Show counters for authentication request packets.
acct-start-stop-sent <uint64>Show counters for accounting start and stop sent requests.
acct-interim-update-sent <uint64>Show counters for accounting interim-update sent requests.
show ppp-server session¶
vsr> show ppp-server session [vrf VRF] instance <string> [details] match [username <string>] \
... [interface INTERFACE] [ip IP] [mac MAC] [vlans VLANS]
Display list of PPP server sessions.
Input Parameters¶
vrf VRFThe VRF in which the specific PPP server is running.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
instance <string>(mandatory)Specific instance from which to show sessions.
detailsDisplay detailed information.
matchMatch specific sessions. It acts as a logical AND operation.
username <string>The username associated to the session.
interface INTERFACEThe PPP interface of the session.
INTERFACEAn interface name.
ip IPThe IP address of the client.
IPvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
mac MACThe MAC address of the client.
MACAn IEEE 802 MAC address.
vlans VLANSThe dynamic VLANs of the session, each entry must contain the tag protocol ID, either 0x8100 for the inner VLAN or 0x88a8 for the outer (PE) VLAN, followed by a dash and the VLAN ID.
VLANSvaluesDescription
noneNo dynamic VLANs.
0x(88a8|8100)-<vlanid>[,(0x(88a8|8100)-<vlanid>]{0,2}No description.
Output Data¶
sessionList of PPP server running sessions.
interface INTERFACEInterface on which the session is attached.
INTERFACEAn interface name.
username <string>Username associated to the session.
mac MACIndicates the client’s MAC address.
MACAn IEEE 802 MAC address.
ipv4 IPV4The client IPv4 address.
IPV4An IPv4 address.
ipv6 IPV6The client IPv6 address.
IPV6An IPv6 address.
status <string>The operational status of this session.
uptime <string>The session uptime.
l3vrf <string>The l3vrf of the session.
vlans <string>Session’s dynamic VLANs, each entry indicated the tag protocol ID, either 0x8100 for the inner VLAN or 0x88a8 for the outer (PE) VLAN, followed by the related VLAN ID used by the session.
session-id <uint16>PPPoE session ID.
ipv6-delegated-prefix IPV6-DELEGATED-PREFIXIPv6 delegated prefix.
IPV6-DELEGATED-PREFIXAn IPv6 prefix: address and CIDR mask.
inbound-interface INBOUND-INTERFACEInbound Interface.
INBOUND-INTERFACEAn interface name.
accounting-session-id <string>Accounting session ID.
qos-template <string>QoS template name.
rate-limit-in <string>Rate limiter for incoming traffic.
rate-limit-out <string>Rate limiter for outgoing traffic.
show gtp tunnels¶
vsr> show gtp tunnels [vrf VRF] [limit LIMIT] [ue-address UE-ADDRESS] [role ROLE]
Retrieve GTP-U tunnels.
Input Parameters¶
vrf VRFThe VRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
limit LIMITMaximum number of matching GTP-U tunnels to report.
LIMITvaluesDescription
<uint32>No description.
noneDisable limit.
ue-address UE-ADDRESSReport GTP-U tunnels associated with these UE/MS addresses only.
UE-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
role ROLEGTP-U tunnel roles to match.
ROLEvaluesDescription
gatewayGateway stands for local termination of a GTP-U tunnel. Implies encapsulation/decapsulation of GTP-U traffic.
relayA relay forwards encapsulated traffic between two GTP-U tunnels. GTP-U headers are modified without decapsulation.
unknownGTP-U tunnels without an assigned role.
Output Data¶
limited true|falseWhether list of tunnels is incomplete due to query limit.
tunnelList of tunnels.
link-interface <string>Name of GTP interface associated with tunnel.
role ROLEGTP-U tunnel role.
ROLEvaluesDescription
gatewayGateway stands for local termination of a GTP-U tunnel. Implies encapsulation/decapsulation of GTP-U traffic.
relayA relay forwards encapsulated traffic between two GTP-U tunnels. GTP-U headers are modified without decapsulation.
unknownGTP-U tunnels without an assigned role.
remote-endpoint REMOTE-ENDPOINTAddress of remote GTP-U endpoint.
REMOTE-ENDPOINTvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
remote-teid <uint32>Remote TEID used in outgoing traffic.
local-teid <uint32>Local TEID associated with incoming traffic.
ue-address UE-ADDRESSUE/MS address.
UE-ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-prefix>An IPv6 prefix: address and CIDR mask.
rx-packets <uint64>Number of packets received or forwarded.
rx-bytes <uint64>Number of bytes received or forwarded.
tx-packets <uint64>Number of packets sent or forwarded.
tx-bytes <uint64>Number of bytes sent or forwarded.
show pfcp smf¶
vsr> show pfcp smf [vrf VRF]
Retrieve and display SMF entities associated with PFCP service.
Input Parameters¶
vrf VRFThe VRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
Output Data¶
smfState of a SMF associated with PFCP instance.
address ADDRESSThe remote peer IP address of the SMF.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
start STARTThe starting date and time of the SMF.
STARTThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
feature <string>The features supported by the SMF.
set-id <string>{0,255}Identifier relating the SMF to a given set of SMFs.
latest-heartbeat <uint64>The number of seconds elapsed since the latest heartbeat received.
backup-address <string>The IP addresses of the alternative SMFs that the PFCP service can contact in case this specific SMF is not reachable.
show pfcp peer¶
vsr> show pfcp peer [vrf VRF]
Display PFCP entities in contact with the PFCP service.
Input Parameters¶
vrf VRFThe VRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
Output Data¶
peerState of a peer communicating with the PFCP service.
address ADDRESSThe IP address of the peer.
ADDRESSvaluesDescription
<ipv4-address>An IPv4 address.
<ipv6-address>An IPv6 address.
start STARTThe starting date and time of the peer.
STARTThe date-and-time type is a profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. The profile is defined by the date-time production in Section 5.6 of RFC 3339. The date-and-time type is compatible with the dateTime XML schema type with the following notable exceptions: (a) The date-and-time type does not allow negative years. (b) The date-and-time time-offset -00:00 indicates an unknown time zone (see RFC 3339) while -00:00 and +00:00 and Z all represent the same time zone in dateTime. (c) The canonical format (see below) of data-and-time values differs from the canonical format used by the dateTime XML schema type, which requires all times to be in UTC using the time-offset ‘Z’. This type is not equivalent to the DateAndTime textual convention of the SMIv2 since RFC 3339 uses a different separator between full-date and full-time and provides higher resolution of time-secfrac. The canonical format for date-and-time values with a known time zone uses a numeric time zone offset that is calculated using the device’s configured known offset to UTC time. A change of the device’s offset to UTC time will cause date-and-time values to change accordingly. Such changes might happen periodically in case a server follows automatically daylight saving time (DST) time zone offset changes. The canonical format for date-and-time values with an unknown time zone (usually referring to the notion of local time) uses the time-offset -00:00.
latest-heartbeat <uint64>The number of seconds elapsed since the latest heartbeat received.
associated true|falsePeer association status with the PFCP service.
show pfcp statistics¶
vsr> show pfcp statistics [vrf VRF]
Retrieve PFCP service packet statistics.
Input Parameters¶
vrf VRFThe VRF to look into.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
Output Data¶
rx-packets <uint64>Number of PFCP packets received.
rx-unsupported-packets <uint64>Number of unsupported PFCP requests received.
rx-error-indication <uint64>Number of error indication notifications received.
rx-threshold <uint64>Number of threshold notifications received.
rx-quota <uint64>Number of quota notifications received.
rx-buffering <uint64>Number of control plane buffering notifications received.
rx-report-errors <uint64>Number of session report responses received with an unsuccessful cause.
tx-packets <uint64>Number of PFCP packets sent.
tx-errors <uint64>Number of PFCP packets that failed to be sent.
tx-first-report <uint64>Number of initial PFCP session reports sent for a given notification.
tx-report-resend <uint64>Number of PFCP session reports resent.
rpc-errors <uint64>Number of RPC failures.
peer-restart <uint64>Number of remote peer restarts detected.
no-association <uint64>Number of PFCP requests rejected from lack of a valid SMF association.
association-created <uint64>Number of successful SMF associations with UPF.
association-released <uint64>Number of successful SMF disassociations from UPF.
session-created <uint64>Number of successful PFCP session creations.
session-modified <uint64>Number of successful PFCP session modifications.
session-deleted <uint64>Number of successful PFCP session removals.
show lldp neighbors¶
vsr> show lldp neighbors [vrf VRF] [interface INTERFACE]
Show LLDP neighbors information.
Input Parameters¶
vrf VRFThe VRF in which to show the LLDP neighbors.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
interface INTERFACEThe interface in which to show the LLDP neighbors.
INTERFACEAn interface name.
Output Data¶
vrf VRFThe neighbors VRF.
VRFvaluesDescription
mainThe main vrf.
<string>The vrf name.
interfaceList of interfaces possessing LLDP neighbors.
name NAMEThe interface name.
NAMEAn interface name.
neighborList of LLDP neighbors.
id <string>System generated identifier for the neighbor on the interface.
port-id <string>The Port ID is a mandatory TLV which identifies the port component of the endpoint identifier associated with the transmitting LLDP agent. If the specified port is an IEEE 802.3 Repeater port, then this TLV is optional.
port-id-type PORT-ID-TYPEThis field identifies the format and source of the port identifier string. It is an enumerator defined by the PtopoPortIdType object from RFC2922.
PORT-ID-TYPEvaluesDescription
interface-aliasChassis identifier based on the value of ifAlias object defined in IETF RFC 2863.
port-componentPort identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737 for a port component.
mac-addressPort identifier based on the value of a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order) associated with a port.
network-addressPort identifier based on a network address, associated with a particular port.
interface-namePort identifier based on the name of the interface, e.g., the value of ifName object defined in IETF RFC 2863.
localPort identifier based on a locally defined alphanumeric string.
port-description <string>The binary string containing the actual port identifier for the port which this LLDP PDU was transmitted. The source and format of this field is defined by PtopoPortId from RFC2922.
management-address <string>The Management Address is a mandatory TLV which identifies a network address associated with the local LLDP agent, which can be used to reach the agent on the port identified in the Port ID TLV.
system-name <string>{0,255}The system name field shall contain an alpha-numeric string that indicates the system’s administratively assigned name. The system name should be the system’s fully qualified domain name. If implementations support IETF RFC 3418, the sysName object should be used for this field.
system-description <string>{0,255}The system description field shall contain an alpha-numeric string that is the textual description of the network entity. The system description should include the full name and version identification of the system’s hardware type, software operating system, and networking software. If implementations support IETF RFC 3418, the sysDescr object should be used for this field.
chassis-id <string>The Chassis ID is a mandatory TLV which identifies the chassis component of the endpoint identifier associated with the transmitting LLDP agent.
chassis-id-type CHASSIS-ID-TYPEThis field identifies the format and source of the chassis identifier string. It is an enumerator defined by the LldpChassisIdSubtype object from IEEE 802.1AB MIB.
CHASSIS-ID-TYPEvaluesDescription
chassis-componentChassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737.
interface-aliasChassis identifier based on the value of ifAlias object defined in IETF RFC 2863.
port-componentChassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737 for a port or backplane component.
mac-addressChassis identifier based on the value of a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order), of a port on the containing chassis as defined in IEEE Std 802-2001.
network-addressChassis identifier based on a network address, associated with a particular chassis. The encoded address is composed of two fields. The first field is a single octet, representing the IANA AddressFamilyNumbers value for the specific address type, and the second field is the network address value.
interface-nameChassis identifier based on the name of the interface, e.g., the value of ifName object defined in IETF RFC 2863.
localChassis identifier based on a locally defined value.
capabilityList of LLDP system capabilities advertised by the neighbor.
name NAMEName of the system capability advertised by the neighbor. Capabilities are represented in a bitmap that defines the primary functions of the system. The capabilities are defined in IEEE 802.1AB.
NAMEvaluesDescription
otherOther capability not specified; bit position 1.
repeaterRepeater capability; bit position 2.
mac-bridgeMAC bridge capability; bit position 3.
wlan-access-pointWLAN access point capability; bit position 4.
routerRouter; bit position 5.
telephoneTelephone capability; bit position 6.
docsis-cable-deviceDOCSIS cable device; bit position 7.
station-onlyStation only capability, for devices that implement only an end station capability, and for which none of the other capabilities apply; bit position 8.
enabled true|falseIndicates whether the corresponding system capability is enabled on the neighbor.