Gaming Flow

{
   "type":  "gaming",
   "name":  "<flow_name:str>",
   "source": {
         "port_group": [
            "<source_group:str>"
         ]
   },
   "destination": {
         "port_group": [
            "<destination_group:str>"
         ]
   },
   "ecn": "<ecn_code_point:str|int>",
   "dscp": "<dscp_code_point:str|int>",
   "add_reverse_direction": "<add_reverse_direction_flow:bool>",
   "packet_length": "<packet_length:int>",
   "packet_length_deviation": "<packet_length_deviation:float>",
   "packet_length_min": "<packet_length_min:int>",
   "packet_length_max": "<packet_length_max:int>",
   "frame_rate": "<frame_rate:float>",
   "imix_number_of_frames": "<flow_duration:int>",
   "udp_src": "<udp_source_port:int>",
   "udp_dest": "<udp_destination_port:int>",
   "analysis": {
      "max_threshold_latency": "<max_threshold_latency:float>"
   }
}

Gaming flow

Specific parameters for gaming flow. The type MUST be defined as gaming.

type

object

properties

  • type

Type of the flow. Defines which specific flow parameters will be possible.

type

string

enum

gaming

  • name

Name of this Flow, defaults to auto-generated name when set to none

type

string

  • source

Specifying the source of transmitted data for this flow

type

object

properties

  • port_group

List of port groups specifying the transmitting ports

type

array

items

Port group

additionalProperties

False

  • destination

Specifying the destination for receiving data for this flow

type

object

properties

  • port_group

List of port groups specifying the receiving ports

type

array

items

Port group

additionalProperties

False

  • ecn

IP ECN

Explicit Congestion Notification code point. Defaults to DEFAULT_IP_ECN (0x00)

oneOf

type

integer

maximum

3

minimum

0

type

string

  • dscp

IP DSCP

Differentiated Services Code Point. Defaults to DEFAULT_IP_DSCP (0x00)

oneOf

type

integer

maximum

63

minimum

0

type

string

  • add_reverse_direction

Enables adding a flow in the reverse direction of the original flow.

The reverse flow uses the same configuration as the original. Defaults to false

type

boolean

  • packet_length

Mean UDP length of the frames we are going to send, defaults to 110

type

integer

minimum

0

  • packet_length_deviation

Deviation of the frame length, defaults to 20

type

integer

minimum

0

  • packet_length_min

Minimum UDP packet length, defaults to 22

type

integer

minimum

0

  • packet_length_max

Maximum UDP packet length, defaults to 1480

type

integer

minimum

0

  • frame_rate

Packet rate at which we will send these frames, defaults to 30

type

number

exclusiveMinimum

0

  • imix_number_of_frames

Add <x> frames with a length which is normally distributed, defaults to 20

type

integer

minimum

1

  • udp_src

UDP port number in range [49152,65534] , defaults to udp_dynamic_port

type

integer

maximum

65535

minimum

0

  • udp_dest

UDP port number in range [49152,65534] , defaults to udp_dynamic_port

type

integer

maximum

65535

minimum

0

  • nat_keep_alive

Enable a flow to keep Network Address (and Port) Translation (NAT/NAPT) entries alive.

The direction will be from the endpoint behind a NAT/NAPT gateway to the port at the public side of the NAT/NAPT gateway. Defaults to false.

We always enable the NAT/NAPT keep alive when the user asks for it, even when:

  • The reverse flow is enabled and source and destination UDP ports are the same

  • The source is the endpoint behind the NAT/NAPT gateway: An initial time to wait on the flow can still cause the NAPT entries at the gateway might still timeout before the traffic starts. This might cause the NAPT gateway to create a new (maybe different!) NAPT entry, causing our traffic analysis to fail (with 100% loss).

Added in version v1.1.1: NAT keepalive is supported for all standard frame blasting based flows.

type

boolean

  • analysis

Sets latency related analysis configuration parameters

Maximum latency threshold

Maximum latency threshold

Maximum allowed latency in milliseconds, defaults to DEFAULT_MAX_LATENCY_THRESHOLD (5.0)

type

number