FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
gbp.api File Reference

Go to the source code of this file.

Data Structures

struct  vl_api_gbp_bridge_domain_add_t
 
struct  vl_api_gbp_bridge_domain_del_t
 
struct  vl_api_gbp_bridge_domain_dump_t
 
struct  vl_api_gbp_bridge_domain_details_t
 
struct  vl_api_gbp_route_domain_add_t
 
struct  vl_api_gbp_route_domain_del_t
 
struct  vl_api_gbp_route_domain_dump_t
 
struct  vl_api_gbp_route_domain_details_t
 
struct  vl_api_gbp_endpoint_add_t
 
struct  vl_api_gbp_endpoint_add_reply_t
 
struct  vl_api_gbp_endpoint_del_t
 
struct  vl_api_gbp_endpoint_dump_t
 
struct  vl_api_gbp_endpoint_details_t
 
struct  vl_api_gbp_endpoint_group_add_t
 
struct  vl_api_gbp_endpoint_group_del_t
 
struct  vl_api_gbp_endpoint_group_dump_t
 
struct  vl_api_gbp_endpoint_group_details_t
 
struct  vl_api_gbp_recirc_add_del_t
 
struct  vl_api_gbp_recirc_dump_t
 
struct  vl_api_gbp_recirc_details_t
 
struct  vl_api_gbp_subnet_add_del_t
 
struct  vl_api_gbp_subnet_dump_t
 
struct  vl_api_gbp_subnet_details_t
 
struct  vl_api_gbp_contract_add_del_t
 
struct  vl_api_gbp_contract_add_del_reply_t
 
struct  vl_api_gbp_contract_dump_t
 
struct  vl_api_gbp_contract_details_t
 
struct  vl_api_gbp_vxlan_tunnel_add_t
 
struct  vl_api_gbp_vxlan_tunnel_add_reply_t
 
struct  vl_api_gbp_vxlan_tunnel_del_t
 
struct  vl_api_gbp_vxlan_tunnel_dump_t
 
struct  vl_api_gbp_vxlan_tunnel_details_t
 
struct  vl_api_gbp_ext_itf_add_del_t
 
struct  vl_api_gbp_ext_itf_dump_t
 
struct  vl_api_gbp_ext_itf_details_t
 

Typedefs

typedef u16 gbp_scope
 

Enumerations

enum  gbp_bridge_domain_flags {
  GBP_BD_API_FLAG_NONE = 0, GBP_BD_API_FLAG_DO_NOT_LEARN = 1, GBP_BD_API_FLAG_UU_FWD_DROP = 2, GBP_BD_API_FLAG_MCAST_DROP = 4,
  GBP_BD_API_FLAG_UCAST_ARP = 8
}
 
enum  gbp_endpoint_flags {
  GBP_API_ENDPOINT_FLAG_NONE = 0, GBP_API_ENDPOINT_FLAG_BOUNCE = 0x1, GBP_API_ENDPOINT_FLAG_REMOTE = 0x2, GBP_API_ENDPOINT_FLAG_LEARNT = 0x4,
  GBP_API_ENDPOINT_FLAG_EXTERNAL = 0x8
}
 Endpoint. More...
 
enum  gbp_subnet_type {
  GBP_API_SUBNET_TRANSPORT, GBP_API_SUBNET_STITCHED_INTERNAL, GBP_API_SUBNET_STITCHED_EXTERNAL, GBP_API_SUBNET_L3_OUT,
  GBP_API_SUBNET_ANON_L3_OUT
}
 
enum  gbp_hash_mode { GBP_API_HASH_MODE_SRC_IP, GBP_API_HASH_MODE_DST_IP, GBP_API_HASH_MODE_SYMMETRIC }
 
enum  gbp_rule_action { GBP_API_RULE_PERMIT, GBP_API_RULE_DENY, GBP_API_RULE_REDIRECT }
 
enum  gbp_vxlan_tunnel_mode { GBP_VXLAN_TUNNEL_MODE_L2, GBP_VXLAN_TUNNEL_MODE_L3 }
 Configure a 'base' tunnel from which learned tunnels are permitted to derive A base tunnel consists only of the VNI, any src,dst IP pair is thus allowed. More...
 
enum  gbp_ext_itf_flags { GBP_API_EXT_ITF_F_NONE = 0, GBP_API_EXT_ITF_F_ANON = 1 }
 

Variables

option version = "2.0.0"
 
import vnet ip ip_types api
 
typedef gbp_bridge_domain
 
u32 rd_id
 
vl_api_gbp_bridge_domain_flags_t flags
 
vl_api_interface_index_t bvi_sw_if_index
 
vl_api_interface_index_t uu_fwd_sw_if_index
 
vl_api_interface_index_t bm_flood_sw_if_index
 
typedef gbp_route_domain
 
u32 ip4_table_id
 
u32 ip6_table_id
 
vl_api_interface_index_t ip4_uu_sw_if_index
 
vl_api_interface_index_t ip6_uu_sw_if_index
 
vl_api_gbp_scope_t scope
 
typedef gbp_endpoint_tun
 
vl_api_address_t dst
 
typedef gbp_endpoint
 
u16 sclass
 
vl_api_mac_address_t mac
 
vl_api_gbp_endpoint_tun_t tun
 
u8 n_ips
 
vl_api_address_t ips [n_ips]
 
typedef gbp_endpoint_retention
 
typedef gbp_endpoint_group
 
u32 bd_id
 
vl_api_interface_index_t uplink_sw_if_index
 
vl_api_gbp_endpoint_retention_t retention
 
typedef gbp_recirc
 
bool is_ext
 
typedef gbp_subnet
 
vl_api_interface_index_t sw_if_index
 
vl_api_gbp_subnet_type_t type
 
vl_api_prefix_t prefix
 
typedef gbp_next_hop
 
typedef gbp_next_hop_set
 
u8 n_nhs
 
vl_api_gbp_next_hop_t nhs [8]
 
typedef gbp_rule
 
vl_api_gbp_next_hop_set_t nh_set
 
typedef gbp_contract
 
u16 dclass
 
u32 acl_index
 
u8 n_ether_types
 
u16 allowed_ethertypes [16]
 
u8 n_rules
 
vl_api_gbp_rule_t rules [n_rules]
 
typedef gbp_vxlan_tunnel
 
vl_api_gbp_vxlan_tunnel_mode_t mode
 
u32 bd_rd_id
 
vl_api_ip4_address_t src
 
typedef gbp_ext_itf
 

Typedef Documentation

◆ gbp_scope

typedef u16 gbp_scope

Definition at line 69 of file gbp.api.

Enumeration Type Documentation

◆ gbp_bridge_domain_flags

Enumerator
GBP_BD_API_FLAG_NONE 
GBP_BD_API_FLAG_DO_NOT_LEARN 
GBP_BD_API_FLAG_UU_FWD_DROP 
GBP_BD_API_FLAG_MCAST_DROP 
GBP_BD_API_FLAG_UCAST_ARP 

Definition at line 23 of file gbp.api.

◆ gbp_endpoint_flags

Endpoint.

Template Parameters
client_index- opaque cookie to identify the sender
context- sender context, to match reply w/ request
Enumerator
GBP_API_ENDPOINT_FLAG_NONE 
GBP_API_ENDPOINT_FLAG_BOUNCE 
GBP_API_ENDPOINT_FLAG_REMOTE 
GBP_API_ENDPOINT_FLAG_LEARNT 
GBP_API_ENDPOINT_FLAG_EXTERNAL 

Definition at line 113 of file gbp.api.

◆ gbp_ext_itf_flags

Enumerator
GBP_API_EXT_ITF_F_NONE 
GBP_API_EXT_ITF_F_ANON 

Definition at line 429 of file gbp.api.

◆ gbp_hash_mode

Enumerator
GBP_API_HASH_MODE_SRC_IP 
GBP_API_HASH_MODE_DST_IP 
GBP_API_HASH_MODE_SYMMETRIC 

Definition at line 302 of file gbp.api.

◆ gbp_rule_action

Enumerator
GBP_API_RULE_PERMIT 
GBP_API_RULE_DENY 
GBP_API_RULE_REDIRECT 

Definition at line 316 of file gbp.api.

◆ gbp_subnet_type

Enumerator
GBP_API_SUBNET_TRANSPORT 
GBP_API_SUBNET_STITCHED_INTERNAL 
GBP_API_SUBNET_STITCHED_EXTERNAL 
GBP_API_SUBNET_L3_OUT 
GBP_API_SUBNET_ANON_L3_OUT 

Definition at line 253 of file gbp.api.

◆ gbp_vxlan_tunnel_mode

Configure a 'base' tunnel from which learned tunnels are permitted to derive A base tunnel consists only of the VNI, any src,dst IP pair is thus allowed.

Enumerator
GBP_VXLAN_TUNNEL_MODE_L2 
GBP_VXLAN_TUNNEL_MODE_L3 

Definition at line 377 of file gbp.api.

Variable Documentation

◆ acl_index

u32 acl_index

Definition at line 334 of file gbp.api.

◆ allowed_ethertypes

u16 allowed_ethertypes[16]

Definition at line 336 of file gbp.api.

◆ api

import vnet interface_types api

Definition at line 19 of file gbp.api.

◆ bd_id

u32 bd_id

Definition at line 188 of file gbp.api.

◆ bd_rd_id

u32 bd_rd_id

Definition at line 387 of file gbp.api.

◆ bm_flood_sw_if_index

vl_api_interface_index_t bm_flood_sw_if_index

Definition at line 39 of file gbp.api.

◆ bvi_sw_if_index

vl_api_interface_index_t bvi_sw_if_index

Definition at line 37 of file gbp.api.

◆ dclass

u16 dclass

Definition at line 333 of file gbp.api.

◆ dst

vl_api_address_t dst

Definition at line 125 of file gbp.api.

◆ flags

vl_api_gbp_ext_itf_flags_t flags

Definition at line 36 of file gbp.api.

◆ gbp_bridge_domain

typedef gbp_bridge_domain
Initial value:
{
unsigned int u32
Definition: types.h:88
u32 bd_id
Definition: gbp.api:188

Definition at line 33 of file gbp.api.

◆ gbp_contract

typedef gbp_contract
Initial value:
{
vl_api_gbp_scope_t scope
vl_api_gbp_scope_t scope
Definition: gbp.api:78

Definition at line 330 of file gbp.api.

◆ gbp_endpoint

typedef gbp_endpoint
Initial value:
{
vl_api_interface_index_t sw_if_index
vl_api_interface_index_t sw_if_index
Definition: gbp.api:265

Definition at line 129 of file gbp.api.

◆ gbp_endpoint_group

typedef gbp_endpoint_group
Initial value:
{
u32 vnid
unsigned int u32
Definition: types.h:88

Definition at line 185 of file gbp.api.

◆ gbp_endpoint_retention

typedef gbp_endpoint_retention
Initial value:
{
u32 remote_ep_timeout
unsigned int u32
Definition: types.h:88

Definition at line 180 of file gbp.api.

◆ gbp_endpoint_tun

typedef gbp_endpoint_tun
Initial value:
{
vl_api_address_t src
vl_api_ip4_address_t src
Definition: gbp.api:388

Definition at line 123 of file gbp.api.

◆ gbp_ext_itf

typedef gbp_ext_itf
Initial value:
{
vl_api_interface_index_t sw_if_index
vl_api_interface_index_t sw_if_index
Definition: gbp.api:265

Definition at line 436 of file gbp.api.

◆ gbp_next_hop

typedef gbp_next_hop
Initial value:
{
vl_api_address_t ip
vl_api_address_t ip
Definition: l2.api:501

Definition at line 295 of file gbp.api.

◆ gbp_next_hop_set

typedef gbp_next_hop_set
Initial value:
{
vl_api_gbp_hash_mode_t hash_mode

Definition at line 310 of file gbp.api.

◆ gbp_recirc

typedef gbp_recirc
Initial value:
{
vl_api_interface_index_t sw_if_index
vl_api_interface_index_t sw_if_index
Definition: gbp.api:265

Definition at line 224 of file gbp.api.

◆ gbp_route_domain

typedef gbp_route_domain
Initial value:
{
u32 rd_id
Definition: gbp.api:35
unsigned int u32
Definition: types.h:88

Definition at line 72 of file gbp.api.

◆ gbp_rule

typedef gbp_rule
Initial value:
{
vl_api_gbp_rule_action_t action
vl_api_mac_event_action_t action
Definition: l2.api:181

Definition at line 324 of file gbp.api.

◆ gbp_subnet

typedef gbp_subnet
Initial value:
{
u32 rd_id
Definition: gbp.api:35
unsigned int u32
Definition: types.h:88

Definition at line 263 of file gbp.api.

◆ gbp_vxlan_tunnel

typedef gbp_vxlan_tunnel
Initial value:
{
u16 vni
Definition: flow_types.api:160
unsigned int u32
Definition: types.h:88

Definition at line 384 of file gbp.api.

◆ ip4_table_id

u32 ip4_table_id

Definition at line 74 of file gbp.api.

◆ ip4_uu_sw_if_index

vl_api_interface_index_t ip4_uu_sw_if_index

Definition at line 76 of file gbp.api.

◆ ip6_table_id

u32 ip6_table_id

Definition at line 75 of file gbp.api.

◆ ip6_uu_sw_if_index

vl_api_interface_index_t ip6_uu_sw_if_index

Definition at line 77 of file gbp.api.

◆ ips

vl_api_address_t ips[n_ips]

Definition at line 136 of file gbp.api.

◆ is_ext

bool is_ext

Definition at line 227 of file gbp.api.

◆ mac

vl_api_mac_address_t mac

Definition at line 133 of file gbp.api.

◆ mode

vl_api_gbp_vxlan_tunnel_mode_t mode

Definition at line 386 of file gbp.api.

◆ n_ether_types

u8 n_ether_types

Definition at line 335 of file gbp.api.

◆ n_ips

u8 n_ips

Definition at line 135 of file gbp.api.

◆ n_nhs

u8 n_nhs

Definition at line 312 of file gbp.api.

◆ n_rules

u8 n_rules

Definition at line 337 of file gbp.api.

◆ nh_set

vl_api_gbp_next_hop_set_t nh_set

Definition at line 326 of file gbp.api.

◆ nhs

vl_api_gbp_next_hop_t nhs[8]

Definition at line 313 of file gbp.api.

◆ prefix

vl_api_prefix_t prefix

Definition at line 268 of file gbp.api.

◆ rd_id

u32 rd_id

Definition at line 35 of file gbp.api.

◆ retention

vl_api_gbp_endpoint_retention_t retention

Definition at line 191 of file gbp.api.

◆ rules

vl_api_gbp_rule_t rules[n_rules]

Definition at line 338 of file gbp.api.

◆ sclass

u16 sclass

Definition at line 131 of file gbp.api.

◆ scope

vl_api_gbp_scope_t scope

Definition at line 78 of file gbp.api.

◆ src

vl_api_ip4_address_t src

Definition at line 388 of file gbp.api.

◆ sw_if_index

vl_api_interface_index_t sw_if_index

Definition at line 265 of file gbp.api.

◆ tun

vl_api_gbp_endpoint_tun_t tun

Definition at line 134 of file gbp.api.

◆ type

vl_api_gbp_subnet_type_t type

Definition at line 267 of file gbp.api.

◆ uplink_sw_if_index

vl_api_interface_index_t uplink_sw_if_index

Definition at line 190 of file gbp.api.

◆ uu_fwd_sw_if_index

vl_api_interface_index_t uu_fwd_sw_if_index

Definition at line 38 of file gbp.api.

◆ version

option version = "2.0.0"

Definition at line 17 of file gbp.api.