show vxlan-gpe tunnel keepalive session

Displays Generic Protocol Extension for Virtual Extensible LAN (VxLAN-GPE) tunnel keepalive session information. 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.
Syntax
show vxlan-gpe tunnel keepalive session [ peer <peer-ip> ] [ summary | detail ]
Command Default

No command default.

Parameters
peer <peer-ip>
Specifies the IP address of the tunnel peer.
summary
Displays a brief summary of only the total number active and backup tunnel keepalive sessions.
detail
Displays detailed keepalive session information.
Modes

Network mode

The show vxlan-gpe tunnel keepalive session [ summary | detail ] command displays the following information.

Output field Description
Need Inputs - Please share the description for these parameters
Total active tunnel keepalive sessions Displays the total number of active keepalive sessions to the RUCKSU Edge device.
Total backup tunnel keepalive sessions Displays the total number of backup keepalive sessions to the RUCKSU Edge device.
Peer IP Displays the IP address of the tunnel peer.
Start time Displays the time since the keepalive session were established.
Status Displays if the session is Up or Down.
Active/Backup Displays whether the Edge device is Active (Peer forwards traffic to this Edge device) or back up (Peer is not forwarding any traffic to this Edge device at this moment but will start forwarding once its current Active Edge goes down) Edge for this session.
Mode Initiator (This Edge device initiated the keepalive session to the Peer) / Responder (This Edge is only responding to keepalive request initiated by the Peer).
Interval and Retry Keepalive Session transmit Interval in seconds and Max Retry before it declares the session as down or peer as un-reachable. This is only displayed for for Initiator keepalive sessions.
Start time Time since keepalive session was established.
Age Remaining Keepalive Session will Age out after these many second if no packets are received from the tunnel Peer.
Usage Guidelines

This command is supported only on the RUCKUS Edge device.

Examples

The below example displays the tunnel keepalive session summary information.

vpp# show vxlan-gpe tunnel keepalive session peer 192.168.31.3 summary
'summary' and 'Peer' option are mutually exclusive
vpp# show vxlan-gpe tunnel keepalive session summary                  
Total active tunnel keepalive sessions:2
Total backup tunnel keepalive sessions:3
vpp#

The below 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    
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    
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 below example displays the tunnel keepalive session detail.

show vxlan-gpe tunnel keepalive session 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 :       1.57 seconds ago
   Last PDU transmit :       1.57 seconds ago
   Age remaining : 10 seconds
   Keepalive Request Packets        Sent:  51       Received:       0  
   Keepalive Reply Packets          Sent:  0        Received:       49 
   Keepalive Connection Packets     Sent:  3        Received:       0  
   Keepalive BackUp Packets         Sent:  0        Received:       0  

Peer IP address : 2.1.1.3
   Mode : Initiator
   Interval: 2   Retry: 5 
   Session state: Down (Active)
   Start time:  - 
   Last PDU received :       0.00 seconds ago
   Last PDU transmit :        .57 seconds ago
   Age remaining : 0 seconds
   Keepalive Request Packets        Sent:  51       Received:       0  
   Keepalive Reply Packets          Sent:  0        Received:       0  
   Keepalive Connection Packets     Sent:  5        Received:       0  
   Keepalive BackUp Packets         Sent:  0        Received:       0  

For Responder Session :
=======================
show vxlan-gpe  tunnel keepalive session detail
Peer IP address : 2.1.1.2
   Mode : Responder
   Session state: Up (Active)
   Start time: 2024-08-14  05:50:24
   Last PDU received :       1.36 seconds ago
   Last PDU transmit :       1.36 seconds ago
   Age remaining : 9 seconds
   Keepalive Request Packets        Sent:  0        Received:      234 
   Keepalive Reply Packets          Sent: 234       Received:       0  
   Keepalive Connection Packets     Sent:  0        Received:       1  
   Keepalive BackUp Packets         Sent:  0        Received:       0

The below example displays the tunnel keepalive session peer detail.

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
History
Release version Command history
2.1.0 This command was introduced.
Parent topic: Show Commands