1.8.0

Datapath Probe CLI

The datapath probe CLI helps an operator to probe the Datapath to the UE.

Usage

On your GW host, run the following command

$ dp_probe_cli.py -i <IMSI> --direction <DL/UL> <list_rules/stats>

For example:

dp_probe_cli.py -i 001010000000004 --direction DL
IMSI: 001010000000004, IP: 192.168.128.15
LOCAL: n_packets=333, n_bytes=21998
mtr0: n_packets=0, n_bytes=0
Running: sudo ovs-appctl ofproto/trace gtp_br0 tcp,in_port=local,ip_dst=192.168.128.15,ip_src=8.8.8.8,tcp_src=80,tcp_dst=3372
Datapath Actions: set(tunnel(tun_id=0xa000428,dst=192.168.60.141,ttl=64,tp_dst=2152,flags(df|key))),pop_eth,set(skb_mark(0x11)),2
Downlink rules: allowlist_sid-IMSI001010000000004-magma.ipv4

dp_probe_cli.py -i 001010000000004 --direction UL
IMSI: 001010000000004, IP: 192.168.128.15
UL stats: n_packets=1512, n_bytes=942831
Running: sudo ovs-appctl ofproto/trace gtp_br0 tcp,in_port=3,tun_id=0x5c6,ip_dst=8.8.8.8,ip_src=192.168.128.15,tcp_src=3372,tcp_dst=80
Datapath Actions: set(eth(src=02:00:00:00:00:01,dst=da:de:f4:73:44:41)),set(skb_mark(0xf)),1
Uplink rules: allowlist_sid-IMSI001010000000004-magma.ipv4

You can also supply the followin options

# list_rules
# stats
# -I <External IP Address>
# -P <External Port>
# -UP <UE Port>
# -p <Protocol tcp/udp/icmp>

dp_probe_cli.py -i 001010000000004  --direction UL -p tcp -I 4.2.2.2 -P 8080 -UP 3172
IMSI: 001010000000004, IP: 192.168.128.15
UL stats: n_packets=312, n_bytes=189243
Running: sudo ovs-appctl ofproto/trace gtp_br0 tcp,in_port=3,tun_id=0x5e6,ip_dst=4.2.2.2,ip_src=192.168.128.15,tcp_src=3172,tcp_dst=8080
Datapath Actions: set(eth(src=02:00:00:00:00:01,dst=da:de:f4:73:44:41)),set(skb_mark(0xf)),1
Uplink rules: allowlist_sid-IMSI001010000000004-magma.ipv4

dp_probe_cli.py -i 1010000051013 --direction UL list_rules
IMSI: 1010000051013, IP: 192.168.128.13
Uplink rules: allowlist_sid-IMSI1010000051013-magma.ipv4

dp_probe_cli.py -i 001010000000004 -d DL stats
IMSI: 001010000000004, IP: 192.168.128.15
LOCAL: n_packets=1100, n_bytes=72632
mtr0: n_packets=0, n_bytes=0

What is this command doing?

This command is a wrapper around ovs-appctl ofproto/trace which simulates the Datapath of the packet based on the direction specified in the command. 'DL' - Incoming Packet, 'UL' - Outgoing packet.

How to read the output?

Based on the IMSI supplied to this command

  • If the UE is connected it prints:
    • The IP Address of the UE and the Datapath Actions based on the ovs-appctl ofproto/trace
    • Ingress or egress stats obtained from ovs-ofctl dump-flows gtp_br0 table=0
    • The enforced uplink or downlink rules in pipelined obtained from the script pipelined_cli.py enforcement display_flows
    • If the parameter list_rules was set, only the enforced rules in pipelined will be shown
    • If the parameter stats was set, only the downlink or uplink stats will be shown
  • If the UE is not connected, the command will output UE is not connected
← Show TechUser Control Plane trace CLI →