FD.io VPP  v20.01-9-g24064d02a
Vector Packet Processing
qos.api File Reference

This file defines QoS record, store and mark API messages which are generally called through a shared memory interface. More...

Go to the source code of this file.

Data Structures

struct  vl_api_qos_store_enable_disable_t
 Enable/Disable QoS storing The QoS bits from the packet at the specified input layer are copied into the packet. More...
 
struct  vl_api_qos_store_dump_t
 Dump the QoS store configs. More...
 
struct  vl_api_qos_store_details_t
 Details of QoS recording configs. More...
 
struct  vl_api_qos_record_enable_disable_t
 Enable/Disable QoS recording The QoS bits from the packet at the specified input layer are copied into the packet. More...
 
struct  vl_api_qos_record_dump_t
 Dump the QoS record configs. More...
 
struct  vl_api_qos_record_details_t
 Details of QoS recording configs. More...
 
struct  vl_api_qos_egress_map_update_t
 Update a QoS Map A QoS map, translates from the QoS value in the packet set by the 'record' feature, to the value used for output in the 'mark' feature. More...
 
struct  vl_api_qos_egress_map_delete_t
 Delete a Qos Map. More...
 
struct  vl_api_qos_egress_map_dump_t
 Dump the QoS egress maps. More...
 
struct  vl_api_qos_egress_map_details_t
 QoS map details. More...
 
struct  vl_api_qos_mark_enable_disable_t
 Enable/Disable QoS marking. More...
 
struct  vl_api_qos_mark_dump_t
 Dump QoS marking configs. More...
 
struct  vl_api_qos_mark_details_t
 QoS marking details. More...
 

Enumerations

enum  qos_source : u8 { QOS_API_SOURCE_EXT = 0, QOS_API_SOURCE_VLAN = 1, QOS_API_SOURCE_MPLS = 2, QOS_API_SOURCE_IP = 3 }
 

Variables

option version = "1.1.1"
 
import vnet ip ip_types api
 
typedef qos_store
 QoS store. More...
 
vl_api_qos_source_t input_source
 
u8 value
 
typedef qos_record
 QoS recording. More...
 
typedef qos_egress_map_row
 A row within a QoS map Each value translates from an input value to an output. More...
 
typedef qos_egress_map
 QoS Translation Map. More...
 
vl_api_qos_egress_map_row_t rows [4]
 
typedef qos_mark
 QoS marking Cponfiguration The QoS bits from the buffer are mapped (using the desired egress map) into the header of the 'output-source'. More...
 
u32 map_id
 
vl_api_qos_source_t output_source
 

Detailed Description

This file defines QoS record, store and mark API messages which are generally called through a shared memory interface.

Definitions of verbs: store: write a QoS value into the buffer meta-data record: Extract a QoS value from a packet header and store it. mark: Make a change to the content of a packet header by writing a stored QoS value

Definition in file qos.api.

Enumeration Type Documentation

◆ qos_source

enum qos_source : u8
Enumerator
QOS_API_SOURCE_EXT 
QOS_API_SOURCE_VLAN 
QOS_API_SOURCE_MPLS 
QOS_API_SOURCE_IP 

Definition at line 33 of file qos.api.

Variable Documentation

◆ api

import vnet interface_types api

Definition at line 30 of file qos.api.

◆ input_source

vl_api_qos_source_t input_source

Definition at line 53 of file qos.api.

◆ map_id

u32 map_id

Definition at line 214 of file qos.api.

◆ output_source

vl_api_qos_source_t output_source

Definition at line 215 of file qos.api.

◆ qos_egress_map

typedef qos_egress_map
Initial value:
{
u32 id
unsigned int u32
Definition: types.h:88

QoS Translation Map.

Template Parameters
id- client provided identifier for the map
rows- one row (per-input source) of output values

Definition at line 151 of file qos.api.

◆ qos_egress_map_row

typedef qos_egress_map_row
Initial value:
{
u8 outputs[256]
unsigned char u8
Definition: types.h:56

A row within a QoS map Each value translates from an input value to an output.

Definition at line 140 of file qos.api.

◆ qos_mark

typedef qos_mark
Initial value:
{
vl_api_interface_index_t sw_if_index
Definition: gre.api:59
unsigned int u32
Definition: types.h:88

QoS marking Cponfiguration The QoS bits from the buffer are mapped (using the desired egress map) into the header of the 'output-source'.

Marking should be used in conjunction with recording

Template Parameters
sw_if_index- The interface on which recording is enabled.
output_source- The output source/layer at which the QoS bits are written into the packet. See qos_source_t.
map_id- The ID of the MAP in which the translation from input to output is performed.

Definition at line 212 of file qos.api.

◆ qos_record

typedef qos_record
Initial value:
{
vl_api_interface_index_t sw_if_index
vl_api_interface_index_t sw_if_index
Definition: gre.api:59

QoS recording.

Template Parameters
sw_if_index- The interface on which recording is enabled.
input_source- The input source/layer at which the QoS bits are copied from the packet. See qos_source_t.

Definition at line 97 of file qos.api.

◆ qos_store

typedef qos_store
Initial value:
{
vl_api_interface_index_t sw_if_index
vl_api_interface_index_t sw_if_index
Definition: gre.api:59

QoS store.

Template Parameters
sw_if_index- The interface on which store is enabled.
input_source- The input source/layer at which the QoS bits are stored See qos_source_t. This determines what packets have a value stored. i.e. If IP is seleted this affects on IP packets.
value- The value to store.

Definition at line 51 of file qos.api.

◆ rows

vl_api_qos_egress_map_row_t rows[4]

Definition at line 153 of file qos.api.

◆ value

u8 value

Definition at line 54 of file qos.api.

◆ version

option version = "1.1.1"

Definition at line 28 of file qos.api.