FD.io VPP  v21.01.1
Vector Packet Processing
vl_api_mactime_add_del_range_t Struct Reference

configure per src-mac time ranges More...

Data Fields

u32 client_index
 client index, from api_main More...
 
u32 context
 application context More...
 
bool is_add
 add=1, del=0 More...
 
bool drop
 drop flag More...
 
bool allow
 allow flag More...
 
u8 allow_quota
 allow subject to quota More...
 
bool no_udp_10001
 drop udp to port 10001 More...
 
u64 data_quota
 max bytes this device More...
 
vl_api_mac_address_t mac_address
 src mac address More...
 
string device_name [64]
 device name More...
 
u32 count
 number of time ranges to follow More...
 
vl_api_time_range_t ranges [count]
 time ranges, in seconds since Sunday began More...
 
option vat_help = "name <devname> mac <mac-addr> allow drop allow-range Mon - Fri 9:00 - 17:00"
 

Detailed Description

configure per src-mac time ranges

Usage: to create a static allow entry: set mac_address, device_name, is_add=1, and allow=1.

to create a static drop entry: set mac_address, device_name, is_add=1, and drop=1.

to create a (time-range-based) dynamic allow entry: set mac_address, device_name, is_add=1, set allow=1. set count = number of ranges set each range start/end in seconds since Sunday began As in: start/end >= 0.0 && start/end < 7.0 *86400.0

to create a (time-range-based) dynamic allow entry with quota: Outside of stated time ranges, such entries revert to allow with no quota. previous setup, s/allow=1/allow_quota=1/

to create a (time-range-based) dynamic drop entry: Same procedure to create a dynamic allow entry, set drop=1 instead of allow=1

to delete a per src-mac entry (of any kind) set mac_address, is_add=0 note: deletes all ranges.

See mactime_test.c:api_mactime_add_del_range(...) for a working example.

Definition at line 78 of file mactime.api.

Field Documentation

◆ allow

bool vl_api_mactime_add_del_range_t::allow

allow flag

Definition at line 84 of file mactime.api.

◆ allow_quota

u8 vl_api_mactime_add_del_range_t::allow_quota

allow subject to quota

Definition at line 85 of file mactime.api.

◆ client_index

u32 vl_api_mactime_add_del_range_t::client_index

client index, from api_main

Definition at line 80 of file mactime.api.

◆ context

u32 vl_api_mactime_add_del_range_t::context

application context

Definition at line 81 of file mactime.api.

◆ count

u32 vl_api_mactime_add_del_range_t::count

number of time ranges to follow

Definition at line 90 of file mactime.api.

◆ data_quota

u64 vl_api_mactime_add_del_range_t::data_quota

max bytes this device

Definition at line 87 of file mactime.api.

◆ device_name

string vl_api_mactime_add_del_range_t::device_name[64]

device name

Definition at line 89 of file mactime.api.

◆ drop

bool vl_api_mactime_add_del_range_t::drop

drop flag

Definition at line 83 of file mactime.api.

◆ is_add

bool vl_api_mactime_add_del_range_t::is_add

add=1, del=0

Definition at line 82 of file mactime.api.

◆ mac_address

vl_api_mac_address_t vl_api_mactime_add_del_range_t::mac_address

src mac address

Definition at line 88 of file mactime.api.

◆ no_udp_10001

bool vl_api_mactime_add_del_range_t::no_udp_10001

drop udp to port 10001

Definition at line 86 of file mactime.api.

◆ ranges

vl_api_time_range_t vl_api_mactime_add_del_range_t::ranges[count]

time ranges, in seconds since Sunday began

Definition at line 92 of file mactime.api.

◆ vat_help

option vl_api_mactime_add_del_range_t::vat_help = "name <devname> mac <mac-addr> allow drop allow-range Mon - Fri 9:00 - 17:00"

Definition at line 93 of file mactime.api.


The documentation for this struct was generated from the following file: