Basic FrameBlasting Flow
{
"type": "frame_blasting",
"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>",
"initial_time_to_wait": "<initial_time_to_wait:float|int|timedelta>",
"bitrate": "<flow_bitrate:float>",
"frame_size": "<frame_size_without_crc:int>",
"frame_rate": "<frame_rate:float>",
"number_of_frames": "<number_of_frames:float>",
"duration": "<flow_duration:float|int|timedelta>",
"udp_src": "<udp_source_port:int>",
"udp_dest": "<udp_destination_port:int>",
"nat_keep_alive": "<activate_nat_keep_alive:bool>",
"analysis": {
"latency":"<enable_latency_analysis:bool>",
"l4s": "'marking' | 'congestion'",
"mos": "<enable_mos:bool>",
"max_threshold_latency": "<max_threshold_latency:float>",
"max_loss_percentage": "<max_loss_percentage:float>",
"quantile": "<quantile:float>",
"min_percentile": "<min_percentile:float>",
"max_percentile": "<max_percentile:float>"
}
}
Frame blasting flow |
|||
Specific parameters for frame blasting flow. The |
|||
type |
object |
||
properties |
|||
|
frame_blasting |
||
|
Name of this Flow, defaults to auto-generated name when set to |
||
type |
string |
||
|
Specifying the source of transmitted data for this flow |
||
type |
object |
||
properties |
|||
|
List of port groups specifying the transmitting ports |
||
type |
array |
||
items |
|||
additionalProperties |
False |
||
|
Specifying the destination for receiving data for this flow |
||
type |
object |
||
properties |
|||
|
List of port groups specifying the receiving ports |
||
type |
array |
||
items |
|||
additionalProperties |
False |
||
|
IP ECN |
||
Explicit Congestion Notification code point, defaults to |
|||
oneOf |
type |
number |
|
type |
string |
||
|
IP DSCP |
||
Differentiated Services Code Point, defaults to |
|||
oneOf |
type |
number |
|
type |
string |
||
|
Enables adding a flow in the reverse direction of the original flow with the same configuration, defaults to |
||
type |
string |
||
|
|
||
type |
number |
||
|
Rate at which the bits are transmitted in bits/s. Excludes the VLAN tag bytes (when applicable), mutual exclusive with |
||
type |
string |
||
|
Frame size in Bytes without CRC, defaults to |
||
type |
number |
||
|
Rate at which the frames are transmitted (in frames per second), mutual exclusive with |
||
type |
number |
||
|
Number of frames to transmit, defaults to |
||
type |
string |
||
|
Duration of the flow in seconds, defaults to |
||
type |
string |
||
|
UDP port number in range [49152,65534] , defaults to udp_dynamic_port |
||
type |
number |
||
|
UDP port number in range [49152,65534] , defaults to udp_dynamic_port |
||
type |
number |
||
|
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 We always enable the NAT/NAPT keep alive when the user asks for it, even when:
|
||
type |
boolean |
||
|
Deprecated since version v1.1.0: Use |
||
type |
boolean |
||
|
Sets latency related analysis configuration parameters |
||
oneOf |
|||
Frame loss analysis parameters |
||
Specific frame loss analysis related parameters |
||
type |
object |
|
properties |
||
|
Maximum allowed frame/byte loss in %, defaults to |
|
type |
number |
|
Latency & frame loss analysis parameters |
||
Specific latency & frame loss analysis related parameters |
||
type |
object |
|
properties |
||
|
Set to |
|
type |
bool |
|
|
Maximum allowed frame/byte loss in %, defaults to |
|
type |
number |
|
|
Maximum threshold latency |
|
Maximum allowed latency in milliseconds, defaults to |
||
type |
number |
|
|
Quantile for which the latency must be less than the given maximum latency, defaults to |
|
type |
number |
|
|
Lowest percentile boundary of outliers latencies (all latencies < min_percentile are considered as outliers), defaults to |
|
type |
number |
|
|
Highest percentile boundary of outliers latencies (all latencies > max_percentile are considered as outliers), defaults to |
|
type |
number |
|
L4S markings analysis |
||
Enables L4S markings analysis based on the ECN codepoint |
||
Note Not supported by ByteBlower Endpoint. |
||
type |
object |
|
properties |
||
|
When set, specifies the type of L4S markings to analyse, mutual exclusive with |
|
type |
string |
|