Attributes for GigaVUE Enriched Metadata for Mobile Networks.
This section describes the various attributes available within GigaVUE Enriched Metadata for Mobile Networks.
Each flow will generate only one record per export interval; however, in this section, the attributes are separated into the following categories:
Control Plane Attributes
The control plane attributes are generated based on network signaling message transactions with successful responses. These include signaling transactions for session establishment, modification, deletion, and others. These attributes are used for enriching the user plane metadata with the corresponding control plane subscriber, device, and location information.
|
Attribute |
Description |
|
imsi |
International Mobile Subscriber Identity. A 3GPP-defined unique private identifier for a mobile user on a 4G network. |
|
imei |
International Mobile Equipment Identity. A 3GPP-defined unique identifier for a mobile device on a 4G network. |
|
msisdn |
Mobile Station Integrated Services Digital Network. A 3GPP-defined identifier for a mobile device on a 4G network. |
|
supi |
Subscription Permanent Identifier. A 3GPP-defined unique identifier for a mobile user on a 5G network. |
|
gpsi |
Generic Public Subscription Identifier. A 3GPP-defined public identifier for a mobile user on a 5G network. |
|
pei |
Permanent Equipment identifier. A 3GPP-defined unique identifier for a mobile device on a 5G network. |
|
ctrl_tun_access_ipv4_addr |
Control Plane Access Tunnel IPv4 Address. MME identifier for S11, SGW identifier for S5/S8-C, AMF identifier for N11 and SGSN for Gn, GP |
|
ctrl_tun_access_ipv6_addr |
Control Plane Access Tunnel IPv6 Address. MME identifier for S11, SGW identifier for S5/S8-C, AMF identifier for N11 and SGSN for Gn, GP |
|
ctrl_tun_access_teid |
Control Plane Access Tunnel Endpoint Identifier |
|
ctrl_tun_core_ipv4_addr |
Control Plane Core Tunnel IPv4 Address. SGW identifier for S11, PGW identifier for S5/S8-C, SMF identifier for N11 and GGSN for Gn,Gp |
|
ctrl_tun_core_ipv6_addr |
Control Plane Core Tunnel IPv6 Address. SGW identifier for S11, PGW identifier for S5/S8-C, SMF identifier for N11 and GGSN for Gn,Gp |
|
ctrl_tun_core_teid |
Control Plane Core Tunnel Endpoint Identifier |
|
user_tun_up_link_ipv4_addr |
User Plane Uplink Tunnel IPv4 Address. Identifier of the SGW/UPF that receives the uplink user plane data from the eNodeB/gNodeB |
|
user_tun_up_link_ipv6_addr |
User Plane Uplink Tunnel IPv6 Address. Identifier of the SGW/UPF that receives the uplink user plane data from the eNodeB/gNodeB |
|
user_tun_up_link_teid |
User Plane Uplink Tunnel Endpoint Identifier |
|
user_tun_down_link_ipv4_addr |
User Plane Downlink Tunnel IPv4 Address. Identifier of the eNodeB/gNodeB that receives the uplink user plane data from the SGW/UPF |
|
user_tun_down_link_ipv6_addr |
User Plane Downlink Tunnel IPv6 Address. Identifier of the eNodeB/gNodeB that receives the uplink user plane data from the SGW/UPF |
|
user_tun_down_link_teid |
User Plane Downlink Tunnel Endpoint Identifier |
|
if_name |
3GPP Control Plane Interface Name |
|
name |
Name of the event on the 3GPP control plane interface |
|
cause_code |
Outcome of the event on the 3GPP control plane interface. Mostly set to 16 to indicate a successful event |
|
sm_context_ref |
Session Management Context |
|
ebi |
EPS(Evolved Packet System) Bearer ID |
|
lbi |
Linked Bearer Identity |
|
pdu_session_id |
PDU(Packet Data Unit) Session ID |
|
apn |
Access Point Name |
|
dnn |
Data Network Name |
|
ue_ipv4_addr |
User Equipment IPv4 Address |
|
ue_ipv6_addr |
User Equipment IPv6 Address |
|
ue_ipv4v6_addr |
User Equipment IPv4v6 Address |
|
ue_non_ip_addr |
User Equipment non-IP Address |
|
ue_addr_type |
User Equipment IP address type (IPv4 or IPv6) |
|
qci |
QoS Class Identifier |
|
qfi |
QoS Flow Identifier |
|
five_qi |
5G QoS Identifier |
|
cgi_mcc |
Mobile Country Code from Cell Global Identity |
|
cgi_mnc |
Mobile Network Code from Cell Global Identity |
|
cgi_lac |
Local Area Code from Cell Global Identity |
|
cgi_cell_id |
Cell Identification from Cell Global Identity |
|
sai_mcc |
Mobile Country Code from Service Area Identifier |
|
sai_mnc |
Mobile Network Code from Service Area Identifier |
|
sai_lac |
Local Area Code from Service Area Identifier |
|
sai_sac |
Service Area Code from Service Area Identifier |
|
tai_mcc |
Mobile Country Code from Tracking Area Identity |
|
tai_mnc |
Mobile Network Code from Tracking Area Identity |
|
tai_tac |
Tracking Area Code from Tracking Area Identity |
|
ecgi_mcc |
Mobile Country Code from E-UTRAN Cell Global Identifier |
|
ecgi_mnc |
Mobile Network Code from E-UTRAN Cell Global Identifier |
|
ecgi_cell_id |
Cell Identification from E-UTRAN Cell Global Identifier |
|
lai_mcc |
Mobile Country Code from Location Area Identity |
|
lai_mnc |
Mobile Network Code from Location Area Identity |
|
lai_lac |
Local Area Code from Location Area Identity |
|
enode_id_mcc |
Mobile Country Code from Evolved Node |
|
enode_id_mnc |
Mobile Network Code from Evolved Node |
|
macro_enode_id |
Evolved Node ID |
|
ncgi_mcc |
Mobile Country Code from NR Cell Global Identity |
|
ncgi_mnc |
Mobile Network Code from NR Cell Global Identity |
|
ncgi_nr_cell_id |
Cell Identification from NR Cell Global Identity |
|
rat_type |
Type of Radio Access Technology |
|
snssai_sst |
Slice/Service Type from Single Network Slice Selection Assistance Information |
|
snssai_sd |
Slice Differentiator id from Single Network Slice Selection Assistance Information |
User Plane Attributes
The user plane attributes are generated by Application Metadata Intelligence (AMI), and include information such as IP addresses, protocols, timestamps, and byte/packet counters. These attributes are generated from the network flows and do not require DPI capabilities. The attributes for the mobile network traffic are generated for the inner IP flow by bypassing the outer headers
|
Attribute |
Description |
|
ts |
Timestamp of the metadata generated in UTC |
|
vendor |
Identifying Gigamon as the vendor providing the metadata |
|
version |
Version number of the GigaSMART software release from the AMI application |
|
generator |
Identifies the Gigamon device that generates the user plane metadata. For example - HC3 |
|
src_ip |
Source IPv4 address of the inner flow |
|
dst_ip |
Destination IPv4 address of the inner flow |
|
src_mac |
Source MAC address of the inner flow |
|
dst_mac |
Destination MAC address of the inner flow |
|
mpls |
MPLS Label if the flow has the MPLS header |
|
protocol |
Layer 4 protocol of the inner flow |
|
src_port |
Layer 4 protocol source port of the inner flow |
|
dst_port |
Layer 4 protocol destination port of the inner flow |
|
device_inbound_interface |
Traffic receiving port on the Gigamon device example HC3 |
|
tcp-sport |
Source TCP port |
|
tcp_dport |
Destination TCP port |
|
udp_sport |
Source UDP port |
|
udp_dport |
Destination UDP port |
|
src_bytes |
Source bytes from client to server in the flow including the outer and the inner IP header |
|
dst_bytes |
Destination bytes from client to server in the flow including the outer and the inner IP header |
|
src_inner_bytes |
Source bytes from the client to the server in the flow with the inner IP header (without the outer header) |
|
dst_inner_bytes |
Destination bytes from the server to the client in the flow with the inner IP header (without the outer header) |
|
src_packets |
Source packets from client to server in the flow including the header |
|
dst_packets |
Destination packets from client to server in the flow including header |
|
total_bytes |
Total bytes is sum of source and destination bytes |
|
total_packets |
Total packets is sum of source and destination packets |
|
id |
Unique flow id assigned to a flow |
|
ingress_vlan_id |
Vlan id in the packet received for the flow |
|
src_ipv6 |
Source IPv6 address of the inner flow |
|
dst_ipv6 |
Destination IPv6 address of the inner flow |
|
ip_version |
IP version v4, v6 |
|
ip_cos_id |
QOS value in the IPv4 header |
|
ip_dscp |
DSCP value in the IPv4 header |
|
ip_ttl |
Time to live in the IPv4 header |
|
ip6hop_limit |
Hop limit in the IPv6 header |
|
flow_labelv6 |
flow label in the IPv6 header |
|
ip6_ds |
DSCP value in the IPv6 header |
|
tcp_flags |
TCP flag in the TCP header |
|
gre_key |
Generic routing encapsulation header key in the GRE header |
|
ip_hdr_len |
IPv4 header length |
|
ip_frag_flags |
IPv4 fragmentation flags |
|
ipv6frag_flags |
IPv6 fragmentation flags |
|
ip_frag_id |
IPv4 fragment id |
|
ipv6frag_id |
IPv6 fragment id |
|
ip_frag_offset |
IPv4 fragment offset |
|
ipv6frag_offset |
IPv6 fragment offset |
|
ipv4opt |
IPv4 options |
|
ip_precendence_id |
IPv4 precedence id |
|
ip6precendence_id |
IPv6 precedence id |
|
ip_tot_len |
IPv4 total length |
|
ip6tot_len |
IPv6 total length |
|
ipv6hdr_len |
IPv6 header length |
|
payload_len_id |
Payload length for the flow excluding the L3 IPv4 header |
|
next_hdr_v6 |
Layer 4 protocol |
|
icmp_type_v4 |
ICMP message type IPv4 |
|
icmp_code_v4 |
ICMP response code IPv4 |
|
icmp_code_v6 |
ICMP response code IPv6 |
|
icmp_type_v6 |
ICMP message type IPv6 |
|
tcp_ack_id |
TCP ack id |
|
tcp_hdr_len |
TCP header length |
|
tcp_seq_no |
TCP sequence number |
|
tcp_urgent_ptr |
TCP urgent pointer |
|
tcp_win_size |
TCP window size |
|
udp_msg_len |
UDP message length |
|
ip6traffic_class |
IPv6 traffic class same as QoS in IPv4 |
|
flow_start_usec |
Inner flow start time in microseconds in UTC |
|
flow_end_usec |
Inner flow end time in microseconds in UTC |
|
flow_start_sec |
Inner flow start time in seconds in UTC |
|
flow_end_sec |
Inner flow end time in seconds in UTC |
|
start_time |
Inner flow start time in milliseconds in UTC |
|
end_time |
Inner flow end time in milliseconds in UTC |
|
egress_intf_id |
egress IP interface-id for the Gigamon device sending the metadata |
|
sys_up_time_first |
Difference between the flow start time and the gigaSMART uptime in milliseconds |
|
sys_up_time_last |
Difference between the flow end time and the gigaSMART uptime in milliseconds |
|
end_reason |
Inner flow end reason – TCP ack, reset, inactive, etc |
|
tcpflagsyn |
TCP flag SYN from TCP header |
|
tcpflagsynack |
TCP flag SYNACK from TCP header |
|
tcpflagfin |
TCP flag FIN (finish)from TCP header |
|
tcpflagrst |
TCP flag RST (reset) from TCP header |
|
Labels |
Labels are added to the metadata by configuration in AMX. There can be multiple labels configured and added. Each label is configured as a key and a string value. |
|
Labels configured in the JSON example in the section below |
|
|
label_event_type |
Label identifying the vendor generating the event in the AMX exporter |
|
label_deployment |
Label identifying the deployment address of the AMX exporter |
|
label_traffic |
Label identifying the traffic region where the AMX is deployed |
