FD.io VPP  v20.05-21-gb1500e9ff
Vector Packet Processing
vl_api_tap_create_v2_t Struct Reference

Initialize a new tap interface with the given parameters. More...

Data Fields

u32 client_index
 
u32 context
 
u32 id [default=0xffffffff]
 
bool use_random_mac [default=true]
 
vl_api_mac_address_t mac_address
 
u8 num_rx_queues [default=1]
 
u16 tx_ring_sz [default=256]
 
u16 rx_ring_sz [default=256]
 
bool host_mtu_set
 
u32 host_mtu_size
 
bool host_mac_addr_set
 
vl_api_mac_address_t host_mac_addr
 
bool host_ip4_prefix_set
 
vl_api_ip4_address_with_prefix_t host_ip4_prefix
 
bool host_ip6_prefix_set
 
vl_api_ip6_address_with_prefix_t host_ip6_prefix
 
bool host_ip4_gw_set
 
vl_api_ip4_address_t host_ip4_gw
 
bool host_ip6_gw_set
 
vl_api_ip6_address_t host_ip6_gw
 
vl_api_tap_flags_t tap_flags
 
bool host_namespace_set
 
string host_namespace [64]
 
bool host_if_name_set
 
string host_if_name [64]
 
bool host_bridge_set
 
string host_bridge [64]
 
string tag []
 

Detailed Description

Initialize a new tap interface with the given parameters.

Template Parameters
client_index- opaque cookie to identify the sender
context- sender context, to match reply w/ request
id- interface id, 0xffffffff means auto
use_random_mac- let the system generate a unique mac address
mac_address- mac addr to assign to the interface if use_random not set
num_rx_queues- number of rx queues
tx_ring_sz- the number of entries of TX ring, optional, default is 256 entries, must be power of 2
rx_ring_sz- the number of entries of RX ring, optional, default is 256 entries, must be power of 2
host_mtu_set- host MTU should be set
host_mtu_size- host MTU size
host_mac_addr_set- host side interface mac address should be set
host_mac_addr- host side interface mac address
host_ip4_prefix_set- host IPv4 ip address should be set
host_ip4_prefix- host IPv4 ip address
host_ip6_prefix_set- host IPv6 ip address should be set
host_ip6_prefix- host IPv6 ip address
host_ip4_gw_set- host IPv4 default gateway should be set
host_ip4_gw- host IPv4 default gateway
host_ip6_gw_set- host IPv6 default gateway should be set
host_ip6_gw- host IPv6 default gateway
tap_flags- flags for the TAP interface creation
host_if_name_set- host side interface name should be set
host_if_name- host side interface name
host_namespace_set- host namespace should be set
host_namespace- host namespace to attach interface to
host_bridge_set- host bridge should be set
host_bridge- host bridge to attach interface to
tag- tag

Definition at line 67 of file tapv2.api.

Field Documentation

◆ client_index

u32 vl_api_tap_create_v2_t::client_index

Definition at line 69 of file tapv2.api.

◆ context

u32 vl_api_tap_create_v2_t::context

Definition at line 70 of file tapv2.api.

◆ host_bridge

string vl_api_tap_create_v2_t::host_bridge[64]

Definition at line 95 of file tapv2.api.

◆ host_bridge_set

bool vl_api_tap_create_v2_t::host_bridge_set

Definition at line 94 of file tapv2.api.

◆ host_if_name

string vl_api_tap_create_v2_t::host_if_name[64]

Definition at line 93 of file tapv2.api.

◆ host_if_name_set

bool vl_api_tap_create_v2_t::host_if_name_set

Definition at line 92 of file tapv2.api.

◆ host_ip4_gw

vl_api_ip4_address_t vl_api_tap_create_v2_t::host_ip4_gw

Definition at line 86 of file tapv2.api.

◆ host_ip4_gw_set

bool vl_api_tap_create_v2_t::host_ip4_gw_set

Definition at line 85 of file tapv2.api.

◆ host_ip4_prefix

vl_api_ip4_address_with_prefix_t vl_api_tap_create_v2_t::host_ip4_prefix

Definition at line 82 of file tapv2.api.

◆ host_ip4_prefix_set

bool vl_api_tap_create_v2_t::host_ip4_prefix_set

Definition at line 81 of file tapv2.api.

◆ host_ip6_gw

vl_api_ip6_address_t vl_api_tap_create_v2_t::host_ip6_gw

Definition at line 88 of file tapv2.api.

◆ host_ip6_gw_set

bool vl_api_tap_create_v2_t::host_ip6_gw_set

Definition at line 87 of file tapv2.api.

◆ host_ip6_prefix

vl_api_ip6_address_with_prefix_t vl_api_tap_create_v2_t::host_ip6_prefix

Definition at line 84 of file tapv2.api.

◆ host_ip6_prefix_set

bool vl_api_tap_create_v2_t::host_ip6_prefix_set

Definition at line 83 of file tapv2.api.

◆ host_mac_addr

vl_api_mac_address_t vl_api_tap_create_v2_t::host_mac_addr

Definition at line 80 of file tapv2.api.

◆ host_mac_addr_set

bool vl_api_tap_create_v2_t::host_mac_addr_set

Definition at line 79 of file tapv2.api.

◆ host_mtu_set

bool vl_api_tap_create_v2_t::host_mtu_set

Definition at line 77 of file tapv2.api.

◆ host_mtu_size

u32 vl_api_tap_create_v2_t::host_mtu_size

Definition at line 78 of file tapv2.api.

◆ host_namespace

string vl_api_tap_create_v2_t::host_namespace[64]

Definition at line 91 of file tapv2.api.

◆ host_namespace_set

bool vl_api_tap_create_v2_t::host_namespace_set

Definition at line 90 of file tapv2.api.

◆ id

u32 vl_api_tap_create_v2_t::id[default=0xffffffff]

Definition at line 71 of file tapv2.api.

◆ mac_address

vl_api_mac_address_t vl_api_tap_create_v2_t::mac_address

Definition at line 73 of file tapv2.api.

◆ num_rx_queues

u8 vl_api_tap_create_v2_t::num_rx_queues[default=1]

Definition at line 74 of file tapv2.api.

◆ rx_ring_sz

u16 vl_api_tap_create_v2_t::rx_ring_sz[default=256]

Definition at line 76 of file tapv2.api.

◆ tag

string vl_api_tap_create_v2_t::tag[]

Definition at line 96 of file tapv2.api.

◆ tap_flags

vl_api_tap_flags_t vl_api_tap_create_v2_t::tap_flags

Definition at line 89 of file tapv2.api.

◆ tx_ring_sz

u16 vl_api_tap_create_v2_t::tx_ring_sz[default=256]

Definition at line 75 of file tapv2.api.

◆ use_random_mac

bool vl_api_tap_create_v2_t::use_random_mac[default=true]

Definition at line 72 of file tapv2.api.


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