Skip to content

Network Connection Information

The Network Connection Information object describes characteristics of an OSI Transport Layer communication, including TCP and UDP.

Attributes

Section titled “Attributes”

direction_id

  • Type: integer_t
  • Requirement: required
  • Values:
    • 0 - Unknown: The connection direction is unknown.
    • 1 - Inbound: Inbound network connection. The connection was originated from the Internet or outside network, destined for services on the inside network.
    • 2 - Outbound: Outbound network connection. The connection was originated from inside the network, destined for services on the Internet or outside network.
    • 3 - Lateral: Lateral network connection. The connection was originated from inside the network, destined for services on the inside network.
    • 99 - Other: The direction is not mapped. See the direction attribute, which contains a data source specific value.

The normalized identifier of the direction of the initiated connection, traffic, or email.

boundary_id

  • Type: integer_t
  • Requirement: recommended
  • Values:
    • 0 - Unknown: The connection boundary is unknown.
    • 1 - Localhost: Local network traffic on the same endpoint.
    • 2 - Internal: Internal network traffic between two endpoints inside network.
    • 3 - External: External network traffic between two endpoints on the Internet or outside the network.
    • 4 - Same VPC: Through another resource in the same VPC
    • 5 - Internet/VPC Gateway: Through an Internet gateway or a gateway VPC endpoint
    • 6 - Virtual Private Gateway: Through a virtual private gateway
    • 7 - Intra-region VPC: Through an intra-region VPC peering connection
    • 8 - Inter-region VPC: Through an inter-region VPC peering connection
    • 9 - Local Gateway: Through a local gateway
    • 10 - Gateway VPC: Through a gateway VPC endpoint (Nitro-based instances only)
    • 11 - Internet Gateway: Through an Internet gateway (Nitro-based instances only)
    • 99 - Other: The boundary is not mapped. See the boundary attribute, which contains a data source specific value.

The normalized identifier of the boundary of the connection.

For cloud connections, this translates to the traffic-boundary (same VPC, through IGW, etc.). For traditional networks, this is described as Local, Internal, or External.

protocol_name

  • Type: string_t
  • Requirement: recommended

The IP protocol name in lowercase, as defined by the Internet Assigned Numbers Authority (IANA). For example: tcp or udp.

protocol_num

  • Type: integer_t
  • Requirement: recommended

The IP protocol number, as defined by the Internet Assigned Numbers Authority (IANA). For example: 6 for TCP and 17 for UDP.

protocol_ver_id

  • Type: integer_t
  • Requirement: recommended
  • Values:
    • 0 - Unknown: The protocol version is unknown.
    • 4 - Internet Protocol version 4 (IPv4)
    • 6 - Internet Protocol version 6 (IPv6)
    • 99 - Other: The protocol version is not mapped. See the protocol_ver attribute, which contains a data source specific value.

The Internet Protocol version identifier.

uid

  • Type: string_t
  • Requirement: recommended

The unique identifier of the connection.

boundary

  • Type: string_t
  • Requirement: optional

The boundary of the connection, normalized to the caption of ‘boundary_id’. In the case of ‘Other’, it is defined by the event source.

For cloud connections, this translates to the traffic-boundary(same VPC, through IGW, etc.). For traditional networks, this is described as Local, Internal, or External.

community_uid

  • Type: string_t
  • Requirement: optional

The Community ID of the network connection.

direction

  • Type: string_t
  • Requirement: optional

The direction of the initiated connection, traffic, or email, normalized to the caption of the direction_id value. In the case of ‘Other’, it is defined by the event source.

flag_history

  • Type: string_t
  • Requirement: optional

The Connection Flag History summarizes events in a network connection. For example flags ShAD representing SYN, SYN/ACK, ACK and Data exchange.

protocol_ver

  • Type: string_t
  • Requirement: optional

The Internet Protocol version.

session

  • Type: session
  • Requirement: optional

The authenticated user or service session.

tcp_flags

  • Type: integer_t
  • Requirement: optional

The network connection TCP header flags (i.e., control bits).

Used By

Section titled “Used By”