show vxlan-gpe tunnel keepalive session

Displays Generic Protocol Extension for Virtual Extensible LAN (VxLAN-GPE) tunnel keepalive session information.
Syntax
show vxlan-gpe tunnel keepalive session [ peer peer-ip[ peer-tid peer-tunnel-id ][ peer-sn peer-serial-number ] [ detail | summary ]
Parameters
peer peer-ip
Specifies the IP address of the tunnel peer.
peer peer-tid
Specifies the peer tunnel ID.
peer peer-sn
Specifies the peer serial ID.
summary
Displays a brief summary of only the total number of active and backup tunnel keepalive sessions. Note that the summary and peer options cannot be used together.
detail
Displays detailed keepalive session information.
Modes

Advanced mode. - Network

The show vxlan-gpe tunnel keepalive session [peer <peer-ip>][peer-tid <peer-tunnel-id>][peer-sn <peer-serial-number>][summary|detail] command displays the following information.

Output field Description
Total active tunnel keepalive sessions Displays the total number of active keepalive sessions to the RUCKUS Edge device.
Total backup tunnel keepalive sessions Displays the total number of backup keepalive sessions to the RUCKUS Edge device.
Peer IP Displays the IP address of the tunnel peer.
Start time Displays the time since the keepalive session was established.
Status Displays if the session is Up or Down.
Active/Backup Displays whether the Edge device is the Active Edge for this session (Peer forwards traffic to this Edge device) or the Backup Edge for this session (Peer is not forwarding any traffic to this Edge device at this moment but will start forwarding once its current Active Edge goes down).
Peer IP address Displays the IP address of the tunnel peer.
Local tid Displays the local tunnel ID.
Initiator tid Displays the tunnel ID of the initiator.
Peer Device SN Displays the serial number of the peer device in the tunnel.
Mode Initiator (This Edge device initiated the keepalive session to the Peer) or Responder (This Edge is only responding to keepalive request initiated by the Peer).
Session state Displays the state of the keepalive session between the local and remote devices.
Interval and Retry Keepalive Session transmit Interval in seconds and Max Retry before it declares the session as down or peer as unreachable. This is only displayed for Initiator keepalive sessions.
Start time Date and time that the keepalive session was established.
Last PDU received Displays the amount of time elapsed since the most recent Protocol Data Unit (PDU) was received.
Last PDU transmit Displays the amount of time elapsed since the most recent Protocol Data Unit (PDU) was sent.
Age Remaining Displays the amount of time remaining before the Keepalive Session expires if no packets are received from the tunnel Peer.
Keepalive Request Packets Displays the total number of keepalive request packets sent and received.
Keepalive Reply Packets Displays the total number of keepalive reply packets sent and received.
Keepalive Connection Packets Displays the total number of keepalive connection packets sent and received.
Keepalive BackUp Packets Displays the total number of keepalive backup packets sent and received.
Usage Guidelines

This command is supported only on the RUCKUS Edge device. The AP uses the tunnel keepalive messages to bring up the tunnel to the device and to monitor the health of the tunnel. Without the keep-alive feature, if the Edge device becomes unreachable, the AP will continue tunneling traffic to the Edge, causing the traffic to be lost in the network. With the keep-alive feature enabled, the AP will generate events, bring down the tunnel, and stop broadcasting WLANs whenever the Edge device is unreachable. Additionally, the AP will periodically report its tunnel status to the RUCKUS One controller. These details will assist in troubleshooting.

Examples

The following example displays the tunnel keepalive session summary information.

vpp# show vxlan-gpe tunnel keepalive session summary                  
Total active tunnel keepalive sessions:2
Total backup tunnel keepalive sessions:3

The following example displays the tunnel keepalive session information.

vpp# show vxlan-gpe tunnel keepalive session
  #       Peer IP                 Start time             Status   Active/Backup
  1     192.168.31.3         2024-09-26  17:37:05          Up        Backup    
  2     192.168.30.4         2024-09-26  22:40:27          Up        Active    
  3     192.168.31.4         2024-09-26  22:40:33          Up        Backup    
  4     192.168.31.7         2024-09-26  23:29:35          Up        Active    
  5    192.168.10.14         2024-09-26  22:40:36          Up        Backup    
 

The following example displays the tunnel keepalive session information for a specific peer.

vpp# show vxlan-gpe tunnel keepalive session peer 192.168.31.3
  #       Peer IP                 Start time             Status   Active/Backup
  1     192.168.31.3         2024-09-26  17:37:05          Up        Backup    

The following example displays the detailed tunnel keepalive session information for a specific peer in Responder mode.

vpp# show vxlan-gpe tunnel keepalive session peer 192.168.31.3 detail
Peer IP address : 192.168.31.3
   Mode : Responder
   Session state: Up (Backup)
   Start time: 2024-09-26  17:37:05
   Last PDU received :       1.68 seconds ago
   Last PDU transmit :       1.68 seconds ago
   Age remaining : 5 seconds
   Keepalive Request Packets        Sent:  0        Received:     22611
   Keepalive Reply Packets          Sent:22611      Received:       0  
   Keepalive Connection Packets     Sent:  0        Received:       1  
   Keepalive BackUp Packets         Sent:  0        Received:     18245

The following example displays the detailed tunnel keepalive session information.

vpp# show vxlan-gpe tunnel keepalive session detail
Peer IP address : 168.56.1.2 (tid:1 NAT port:4790)
   Initiator tid : 1
   Peer Device SN : 3923395001100000000000000000000000
   Mode : Responder
   Session state: Up (Active)
   Start time: 2025-02-03  10:23:42
   Last PDU received :       1.17 seconds ago
   Last PDU transmit :       1.17 seconds ago
   Age remaining : 9 seconds
   Keepalive Request Packets        Sent:  0        Received:      4531
   Keepalive Reply Packets          Sent: 4531      Received:       0
   Keepalive Connection Packets     Sent:  0        Received:       2
   Keepalive BackUp Packets         Sent:  0        Received:       0

The following example displays the detailed tunnel keepalive session information for a specific peer in Initiator mode.

show vxlan-gpe  tunnel keepalive session peer 2.1.1.1 detail
Peer IP address : 2.1.1.1
   Mode : Initiator
   Interval: 2   Retry: 5 
   Session state: Up (Active)
   Start time: 2024-08-14  05:50:23
   Last PDU received :        .89 seconds ago
   Last PDU transmit :        .89 seconds ago
   Age remaining : 9 seconds
   Keepalive Request Packets        Sent: 142       Received:       0  
   Keepalive Reply Packets          Sent:  0        Received:      140 
   Keepalive Connection Packets     Sent:  3        Received:       0  
   Keepalive BackUp Packets         Sent:  0        Received:       0  

The following example displays the peer-tid filter in the tunnel keepalive session

DBGvpp# show vxlan-gpe tunnel keepalive session peer-tid 1
  #                    Peer IP                              Start time             Status   Active/Backup
  1     172.20.20.30    (tid:  1  NAT port: 4790)       2025-06-24  19:59:25          Up        Active
  2     172.20.20.14    (tid:  3  NAT port:  0  )       2025-06-25  18:21:08          Up        Active
  3     172.20.20.24    (tid:  2  NAT port: 4790)       2025-06-25  18:20:55          Up        Active
DBGvpp#
DBGvpp#
DBGvpp# show vxlan-gpe tunnel keepalive session peer-tid 1 detail
Peer IP address : 172.20.20.30 (Peer tid:1 NAT port:4790)
   Local tid : 1
   Peer Device SN : 1323790041390000000000000000000000
   Mode : Responder
   Session state: Up (Active)
   Start time: 2025-06-24  19:59:25
   Last PDU received :        .98 seconds ago
   Last PDU transmit :        .98 seconds ago
   Age remaining : 5 seconds
   Keepalive Request Packets        Sent:  0        Received:     43147
   Keepalive Reply Packets          Sent:43147      Received:       0
   Keepalive Connection Packets     Sent:  0        Received:       1
   Keepalive BackUp Packets         Sent:  0        Received:       0

The following example displays the peer-sn filter in the tunnel keepalive session

DBGvpp# show vxlan-gpe tunnel keepalive session peer-sn 1323790041390000000000000000000000
  #                    Peer IP                              Start time             Status   Active/Backup
  1     172.20.20.30    (tid:  1  NAT port: 4790)       2025-06-24  19:59:25          Up        Active
DBGvpp#
DBGvpp#
DBGvpp# show vxlan-gpe tunnel keepalive session peer-sn 1323790041390000000000000000000000 detail
Peer IP address : 172.20.20.30 (Peer tid:1 NAT port:4790)
   Local tid : 1
   Peer Device SN : 1323790041390000000000000000000000
   Mode : Responder
   Session state: Up (Active)
   Start time: 2025-06-24  19:59:25
   Last PDU received :       2.15 seconds ago
   Last PDU transmit :       2.15 seconds ago
   Age remaining : 6 seconds
   Keepalive Request Packets        Sent:  0        Received:     43200
   Keepalive Reply Packets          Sent:43200      Received:       0
   Keepalive Connection Packets     Sent:  0        Received:       1
   Keepalive BackUp Packets         Sent:  0        Received:       0

DBGvpp#
History
Release version Command history
2.4.0 Output supporting NAT-T.
2.1.0 This command was introduced.