package apipb

optional MpGracefulRestart mp_graceful_restart = 1
optional AfiSafiConfig config = 2
optional AfiSafiState state = 3
optional ApplyPolicy apply_policy = 4
optional RouteSelectionOptions route_selection_options = 5
TODO: Support the following structures: - Ipv4Unicast - Ipv6Unicast - Ipv4LabelledUnicast - Ipv6LabelledUnicast - L3vpnIpv4Unicast - L3vpnIpv6Unicast - L3vpnIpv4Multicast - L3vpnIpv6Multicast - L2vpnVpls - L2vpnEvpn
optional UseMultiplePaths use_multiple_paths = 6
optional PrefixLimit prefix_limits = 7
optional RouteTargetMembership route_target_membership = 8
optional LongLivedGracefulRestart long_lived_graceful_restart = 9
optional AddPaths add_paths = 10

Used in: AfiSafi

optional Family family = 1
bool enabled = 2

Used in: AfiSafi

optional Family family = 1
bool enabled = 2
uint64 received = 3
uint64 accepted = 4
uint64 advertised = 5

uint32 asn = 1
string address = 2

repeated google.protobuf.Any tlvs = 1
Each TLV must be one of: - AigpTLVIGPMetric - AigpTLVUnknown

uint64 metric = 1

uint32 type = 1
bytes value = 2

Used in: AfiSafi, Global, Peer, PeerGroup

optional PolicyAssignment in_policy = 1
optional PolicyAssignment export_policy = 2
optional PolicyAssignment import_policy = 3

uint32 asn = 2
string address = 3

repeated AsSegment segments = 1

repeated AsSegment segments = 1

Used in: Conditions

AsPathLength.Type type = 1
uint32 length = 2

Used in: AsPathLength

EQ = 0
GE = 1
LE = 2

Used in: Actions

uint32 asn = 1
uint32 repeat = 2
bool use_left_most = 3

Used in: As4PathAttribute, AsPathAttribute

AsSegment.Type type = 1
repeated uint32 numbers = 2

Used in: AsSegment

UNKNOWN = 0
AS_SET = 1
AS_SEQUENCE = 2
AS_CONFED_SEQUENCE = 3
AS_CONFED_SET = 4

(message has no fields)

repeated string ids = 1

uint32 color = 1

repeated uint32 communities = 1

Used in: Actions

CommunityAction.Type type = 1
repeated string communities = 2

Used in: CommunityAction

ADD = 0
REMOVE = 1
REPLACE = 2

Used in: Conditions

CommunityCount.Type type = 1
uint32 count = 2

Used in: CommunityCount

EQ = 0
GE = 1
LE = 2

Used in: Statement

optional MatchSet prefix_set = 1
optional MatchSet neighbor_set = 2
optional AsPathLength as_path_length = 3
optional MatchSet as_path_set = 4
optional MatchSet community_set = 5
optional MatchSet ext_community_set = 6
int32 rpki_result = 7
Conditions.RouteType route_type = 8
optional MatchSet large_community_set = 9
repeated string next_hop_in_list = 10
repeated Family afi_safi_in = 11
optional CommunityCount community_count = 12
RouteOriginType origin = 13

Used in: Conditions

ROUTE_TYPE_NONE = 0
ROUTE_TYPE_INTERNAL = 1
ROUTE_TYPE_EXTERNAL = 2
ROUTE_TYPE_LOCAL = 3

Used in: Global

bool enabled = 1
uint32 identifier = 2
repeated uint32 member_as_list = 3

(message has no fields)

Used in: Global

uint32 external_route_distance = 1
uint32 internal_route_distance = 2

Used in: AddDefinedSetRequest, DeleteDefinedSetRequest, ListDefinedSetResponse, RoutingPolicy, SetPoliciesRequest

DefinedType defined_type = 1
string name = 2
repeated string list = 3
repeated Prefix prefixes = 4

Used in: DefinedSet, ListDefinedSetRequest

PREFIX = 0
NEIGHBOR = 1
TAG = 2
AS_PATH = 3
COMMUNITY = 4
EXT_COMMUNITY = 5
LARGE_COMMUNITY = 6
NEXT_HOP = 7

Used in: ListPathResponse

string prefix = 1
repeated Path paths = 2

Used in: AddDynamicNeighborRequest, ListDynamicNeighborResponse

string prefix = 1
string peer_group = 2

Used in: TunnelEncapSubTLVSRENLP

Reserved = 0
Type1 = 1
Type2 = 2
Type3 = 3
Type4 = 4

bool is_single_active = 1
uint32 label = 2

string es_import = 1

EVPNEthernetAutoDiscoveryRoute represents the NLRI for: - AFI=25, SAFI=70, RouteType=1

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
optional EthernetSegmentIdentifier esi = 2
uint32 ethernet_tag = 3
uint32 label = 4

EVPNEthernetSegmentRoute represents the NLRI for: - AFI=25, SAFI=70, RouteType=4

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
optional EthernetSegmentIdentifier esi = 2
string ip_address = 3

EVPNIPMSIRoute represents the NLRI for: - AFI=25, SAFI=70, RouteType=9

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
uint32 ethernet_tag = 2
optional google.protobuf.Any rt = 3

EVPNIPPrefixRoute represents the NLRI for: - AFI=25, SAFI=70, RouteType=5

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
optional EthernetSegmentIdentifier esi = 2
uint32 ethernet_tag = 3
string ip_prefix = 4
uint32 ip_prefix_len = 5
string gw_address = 6
uint32 label = 7

EVPNInclusiveMulticastEthernetTagRoute represents the NLRI for: - AFI=25, SAFI=70, RouteType=3

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
uint32 ethernet_tag = 2
string ip_address = 3

EVPNMACIPAdvertisementRoute represents the NLRI for: - AFI=25, SAFI=70, RouteType=2

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
optional EthernetSegmentIdentifier esi = 2
uint32 ethernet_tag = 3
string mac_address = 4
string ip_address = 5
repeated uint32 labels = 6

Used in: UseMultiplePaths

optional EbgpConfig config = 1
optional EbgpState state = 2

Used in: Ebgp

bool allow_multiple_asn = 1
uint32 maximum_paths = 2

Used in: Peer, PeerGroup

bool enabled = 1
uint32 multihop_ttl = 2

Used in: Ebgp

bool allow_multiple_asn = 1
uint32 maximum_paths = 2

Used in: EnableMrtRequest

UPDATES = 0
TABLE = 1

uint32 tunnel_type = 1

EncapsulationNLRI represents the NLRI for: - AFI=1, SAFI=7 - AFI=2, SAFI=7

string address = 1

(message has no fields)

Used in: EVPNEthernetAutoDiscoveryRoute, EVPNEthernetSegmentRoute, EVPNIPPrefixRoute, EVPNMACIPAdvertisementRoute

uint32 type = 1
bytes value = 2

repeated google.protobuf.Any communities = 1
Each Community must be one of: - TwoOctetAsSpecificExtended - IPv4AddressSpecificExtended - FourOctetAsSpecificExtended - OpaqueExtended - ESILabelExtended - MacMobilityExtended - RouterMacExtended - TrafficRateExtended - TrafficActionExtended - RedirectTwoOctetAsSpecificExtended - RedirectIPv4AddressSpecificExtended - RedirectFourOctetAsSpecificExtended - TrafficRemarkExtended - MUPExtended - VPLSExtended - UnknownExtended

repeated ExtendedNexthopCapabilityTuple tuples = 1

Used in: ExtendedNexthopCapability

optional Family nlri_family = 1
optional Family nexthop_family = 2
Nexthop AFI must be either gobgp.IPv4 or gobgp.IPv6.

Used in: AddPathCapabilityTuple, AfiSafiConfig, AfiSafiState, Conditions, DeletePathRequest, ExtendedNexthopCapabilityTuple, GetTableRequest, GracefulRestartCapabilityTuple, ListPathRequest, ListRpkiRequest, ListRpkiTableRequest, LongLivedGracefulRestartCapabilityTuple, MpReachNLRIAttribute, MpUnreachNLRIAttribute, MultiProtocolCapability, Path, PrefixLimit

Family.Afi afi = 1
Family.Safi safi = 2

Used in: Family

AFI_UNKNOWN = 0
AFI_IP = 1
AFI_IP6 = 2
AFI_L2VPN = 25
AFI_LS = 16388
AFI_OPAQUE = 16397

Used in: Family

SAFI_UNKNOWN = 0
SAFI_UNICAST = 1
SAFI_MULTICAST = 2
SAFI_MPLS_LABEL = 4
SAFI_ENCAPSULATION = 7
SAFI_VPLS = 65
SAFI_EVPN = 70
SAFI_LS = 71
SAFI_SR_POLICY = 73
SAFI_MUP = 85
SAFI_MPLS_VPN = 128
SAFI_MPLS_VPN_MULTICAST = 129
SAFI_ROUTE_TARGET_CONSTRAINTS = 132
SAFI_FLOW_SPEC_UNICAST = 133
SAFI_FLOW_SPEC_VPN = 134
SAFI_KEY_VALUE = 241

uint32 type = 1
repeated FlowSpecComponentItem items = 2

Used in: FlowSpecComponent

uint32 op = 1
Operator for Numeric type, Operand for Bitmask type
uint64 value = 2

uint32 type = 1
uint32 prefix_len = 2
string prefix = 3
uint32 offset = 4
IPv6 only

uint32 type = 1
string address = 2

FlowSpecNLRI represents the NLRI for: - AFI=1, SAFI=133 - AFI=2, SAFI=133

repeated google.protobuf.Any rules = 1
One of: - FlowSpecIPPrefix - FlowSpecMAC - FlowSpecComponent

uint32 asn = 1

bool is_transitive = 1
uint32 sub_type = 2
uint32 asn = 3
uint32 local_admin = 4

string host_name = 1
string domain_name = 2

Used in: GetBgpResponse, StartBgpRequest

uint32 asn = 1
string router_id = 2
int32 listen_port = 3
repeated string listen_addresses = 4
repeated uint32 families = 5
bool use_multiple_paths = 6
optional RouteSelectionOptionsConfig route_selection_options = 7
optional DefaultRouteDistance default_route_distance = 8
optional Confederation confederation = 9
optional GracefulRestart graceful_restart = 10
optional ApplyPolicy apply_policy = 11
string bind_to_device = 12

Used in: Global, Peer, PeerGroup

bool enabled = 1
uint32 restart_time = 2
bool helper_only = 3
uint32 deferral_time = 4
bool notification_enabled = 5
bool longlived_enabled = 6
uint32 stale_routes_time = 7
uint32 peer_restart_time = 8
bool peer_restarting = 9
bool local_restarting = 10
string mode = 11

uint32 flags = 1
uint32 time = 2
repeated GracefulRestartCapabilityTuple tuples = 3

Used in: GracefulRestartCapability

optional Family family = 1
uint32 flags = 2

repeated google.protobuf.Any communities = 1
Each Community must be one of: - IPv6AddressSpecificExtended - RedirectIPv6AddressSpecificExtended

IPAddressPrefix represents the NLRI for: - AFI=1, SAFI=1 - AFI=2, SAFI=1

uint32 prefix_len = 1
string prefix = 2

bool is_transitive = 1
uint32 sub_type = 2
string address = 3
uint32 local_admin = 4

bool is_transitive = 1
uint32 sub_type = 2
string address = 3
uint32 local_admin = 4

Used in: UseMultiplePaths

optional IbgpConfig config = 1
optional IbgpState state = 2

Used in: Ibgp

uint32 maximum_paths = 1

Used in: Ibgp

uint32 maximum_paths = 1

LabeledIPAddressPrefix represents the NLRI for: - AFI=1, SAFI=4 - AFI=2, SAFI=4

repeated uint32 labels = 1
uint32 prefix_len = 2
string prefix = 3

LabeledVPNIPAddressPrefix represents the NLRI for: - AFI=1, SAFI=128 - AFI=2, SAFI=128

repeated uint32 labels = 1
optional google.protobuf.Any rd = 2
One of: - TwoOctetAsSpecificExtended - IPv4AddressSpecificExtended - FourOctetAsSpecificExtended
uint32 prefix_len = 3
string prefix = 4

repeated LargeCommunity communities = 1

Used in: LargeCommunitiesAttribute

uint32 global_admin = 1
uint32 local_data1 = 2
uint32 local_data2 = 3

uint32 asn = 1
float bandwidth = 2

Used in: ListBmpResponse

optional BmpStation.Conf conf = 1
optional BmpStation.State state = 2

Used in: BmpStation

string address = 1
uint32 port = 2

Used in: BmpStation

optional google.protobuf.Timestamp uptime = 1
optional google.protobuf.Timestamp downtime = 2

Used in: ListPathRequest

NONE = 0
PREFIX = 1

Used in: Actions

uint32 value = 1

uint32 local_pref = 1

Used in: AfiSafi

optional LongLivedGracefulRestartConfig config = 1
optional LongLivedGracefulRestartState state = 2

repeated LongLivedGracefulRestartCapabilityTuple tuples = 1

Used in: LongLivedGracefulRestartCapability

optional Family family = 1
uint32 flags = 2
uint32 time = 3

Used in: LongLivedGracefulRestart

bool enabled = 1
uint32 restart_time = 2

Used in: LongLivedGracefulRestart

bool enabled = 1
bool received = 2
bool advertised = 3
uint32 peer_restart_time = 4
bool peer_restart_timer_expired = 5

LsAddrPrefix represents the NLRI for: - AFI=16388, SAFI=71

LsNLRIType type = 1
optional google.protobuf.Any nlri = 2
One of: - LsNodeNLRI - LsLinkNLRI - LsPrefixV4NLRI - LsPrefixV6NLRI - LsSrv6SIDNLRI
uint32 length = 3
LsProtocolID protocol_id = 4
uint64 identifier = 5

optional LsAttributeNode node = 1
optional LsAttributeLink link = 2
optional LsAttributePrefix prefix = 3
optional LsAttributeBgpPeerSegment bgp_peer_segment = 4

Used in: LsAttribute

optional LsBgpPeerSegmentSID bgp_peer_node_sid = 1
optional LsBgpPeerSegmentSID bgp_peer_adjacency_sid = 2
optional LsBgpPeerSegmentSID bgp_peer_set_sid = 3

Used in: LsAttribute

string name = 1
string local_router_id = 2
string local_router_id_v6 = 3
string remote_router_id = 4
string remote_router_id_v6 = 5
uint32 admin_group = 6
uint32 default_te_metric = 7
uint32 igp_metric = 8
bytes opaque = 9
float bandwidth = 10
float reservable_bandwidth = 11
repeated float unreserved_bandwidth = 12
uint32 sr_adjacency_sid = 13
repeated uint32 srlgs = 14

Used in: LsAttribute

string name = 1
optional LsNodeFlags flags = 2
string local_router_id = 3
string local_router_id_v6 = 4
bytes isis_area = 5
bytes opaque = 6
optional LsSrCapabilities sr_capabilities = 7
bytes sr_algorithms = 8
optional LsSrLocalBlock sr_local_block = 9

Used in: LsAttribute

optional LsIGPFlags igp_flags = 1
bytes opaque = 2
uint32 sr_prefix_sid = 3

Used in: LsAttributeBgpPeerSegment

optional LsBgpPeerSegmentSIDFlags flags = 1
uint32 weight = 2
uint32 sid = 3

Used in: LsBgpPeerSegmentSID

bool value = 1
bool local = 2
bool backup = 3
bool persistent = 4

Used in: LsAttributePrefix

bool down = 1
bool no_unicast = 2
bool local_address = 3
bool propagate_nssa = 4

Used in: LsLinkNLRI

uint32 link_local_id = 1
uint32 link_remote_id = 2
string interface_addr_ipv4 = 3
string neighbor_addr_ipv4 = 4
string interface_addr_ipv6 = 5
string neighbor_addr_ipv6 = 6

optional LsNodeDescriptor local_node = 1
optional LsNodeDescriptor remote_node = 2
optional LsLinkDescriptor link_descriptor = 3

Used in: LsSrv6SIDNLRI

repeated uint32 multi_topo_ids = 1

Based om RFC 7752, Table 1.

Used in: LsAddrPrefix

LS_NLRI_UNKNOWN = 0
LS_NLRI_NODE = 1
LS_NLRI_LINK = 2
LS_NLRI_PREFIX_V4 = 3
LS_NLRI_PREFIX_V6 = 4
LS_NLRI_SRV6_SID = 6

Used in: LsLinkNLRI, LsNodeNLRI, LsPrefixV4NLRI, LsPrefixV6NLRI, LsSrv6SIDNLRI

uint32 asn = 1
uint32 bgp_ls_id = 2
uint32 ospf_area_id = 3
bool pseudonode = 4
string igp_router_id = 5
string bgp_router_id = 6
uint32 bgp_confederation_member = 7

Used in: LsAttributeNode

bool overload = 1
bool attached = 2
bool external = 3
bool abr = 4
bool router = 5
bool v6 = 6

optional LsNodeDescriptor local_node = 1

Used in: LsPrefixDescriptor

LS_OSPF_ROUTE_TYPE_UNKNOWN = 0
LS_OSPF_ROUTE_TYPE_INTRA_AREA = 1
LS_OSPF_ROUTE_TYPE_INTER_AREA = 2
LS_OSPF_ROUTE_TYPE_EXTERNAL1 = 3
LS_OSPF_ROUTE_TYPE_EXTERNAL2 = 4
LS_OSPF_ROUTE_TYPE_NSSA1 = 5
LS_OSPF_ROUTE_TYPE_NSSA2 = 6

Used in: LsPrefixV4NLRI, LsPrefixV6NLRI

repeated string ip_reachability = 1
LsOspfRouteType ospf_route_type = 2

optional LsNodeDescriptor local_node = 1
optional LsPrefixDescriptor prefix_descriptor = 2

optional LsNodeDescriptor local_node = 1
optional LsPrefixDescriptor prefix_descriptor = 2

Used in: LsAddrPrefix

LS_PROTOCOL_UNKNOWN = 0
LS_PROTOCOL_ISIS_L1 = 1
LS_PROTOCOL_ISIS_L2 = 2
LS_PROTOCOL_OSPF_V2 = 3
LS_PROTOCOL_DIRECT = 4
LS_PROTOCOL_STATIC = 5
LS_PROTOCOL_OSPF_V3 = 6

Used in: LsAttributeNode

bool ipv4_supported = 1
bool ipv6_supported = 2
repeated LsSrRange ranges = 3

Used in: LsAttributeNode

repeated LsSrRange ranges = 1

Used in: LsSrCapabilities, LsSrLocalBlock

uint32 begin = 1
uint32 end = 2

https://tools.ietf.org/html/rfc9552

Used in: LsSrv6SIDNLRI

repeated string sids = 1

optional LsNodeDescriptor local_node = 1
optional LsSrv6SIDInformation srv6_sid_information = 2
optional LsMultiTopologyIdentifier multi_topo_id = 3

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
string address = 2

uint32 sub_type = 1
uint32 segment_id2 = 2
uint32 segment_id4 = 3

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
string prefix = 2

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
uint32 prefix_length = 2
string prefix = 3
uint32 teid = 4
uint32 qfi = 5
uint32 endpoint_address_length = 6
string endpoint_address = 7
uint32 source_address_length = 8
string source_address = 9

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
uint32 endpoint_address_length = 2
string endpoint_address = 3
uint32 teid = 4

bool is_sticky = 1
uint32 sequence_num = 2

Used in: Conditions

MatchSet.Type type = 1
string name = 2

Used in: MatchSet

ANY = 0
ALL = 1
INVERT = 2

Used in: Actions

MedAction.Type type = 1
int64 value = 2

Used in: MedAction

MOD = 0
REPLACE = 1

Used in: Messages

uint64 notification = 1
uint64 update = 2
uint64 open = 3
uint64 keepalive = 4
uint64 refresh = 5
uint64 discarded = 6
uint64 total = 7
uint64 withdraw_update = 8
uint64 withdraw_prefix = 9

Used in: PeerState

optional Message received = 1
optional Message sent = 2

Used in: AfiSafi

optional MpGracefulRestartConfig config = 1
optional MpGracefulRestartState state = 2

Used in: MpGracefulRestart

bool enabled = 1

Used in: MpGracefulRestart

bool enabled = 1
bool received = 2
bool advertised = 3
bool end_of_rib_received = 4
bool end_of_rib_sent = 5

optional Family family = 1
repeated string next_hops = 2
repeated google.protobuf.Any nlris = 3
Each NLRI must be one of: - IPAddressPrefix - LabeledIPAddressPrefix - EncapsulationNLRI - EVPNEthernetAutoDiscoveryRoute - EVPNMACIPAdvertisementRoute - EVPNInclusiveMulticastEthernetTagRoute - EVPNEthernetSegmentRoute - EVPNIPPrefixRoute - EVPNIPMSIRoute - LabeledVPNIPAddressPrefix - RouteTargetMembershipNLRI - FlowSpecNLRI - VPNFlowSpecNLRI - OpaqueNLRI - LsAddrPrefix - SR Policy NLRI - MUPInterworkSegmentDiscoveryRoute - MUPDirectSegmentDiscoveryRoute - MUPType1SessionTransformedRoute - MUPType2SessionTransformedRoute

optional Family family = 1
repeated google.protobuf.Any nlris = 3
The same as NLRI field of MpReachNLRIAttribute

uint32 med = 1

optional Family family = 1

string next_hop = 1

Used in: Actions

string address = 1
bool self = 2
bool unchanged = 3
bool peer_address = 4

bool is_transitive = 1
bytes value = 3

OpaqueNLRI represents the NLRI for: - AFI=16397, SAFI=241

bytes key = 1
bytes value = 2

Used in: Actions

RouteOriginType origin = 1

uint32 origin = 1

string id = 1

Used in: AddPathRequest, AddPathStreamRequest, DeletePathRequest, Destination, WatchEventResponse.TableEvent

optional google.protobuf.Any nlri = 1
One of the following defined in "api/attribute.proto": - IPAddressPrefix - LabeledIPAddressPrefix - EncapsulationNLRI - VPLSNLRI - EVPNEthernetAutoDiscoveryRoute - EVPNMACIPAdvertisementRoute - EVPNInclusiveMulticastEthernetTagRoute - EVPNEthernetSegmentRoute - EVPNIPPrefixRoute - EVPNIPMSIRoute - LabeledVPNIPAddressPrefix - RouteTargetMembershipNLRI - FlowSpecNLRI - VPNFlowSpecNLRI - OpaqueNLRI - LsAddrPrefix - SRPolicyNLRI - MUPInterworkSegmentDiscoveryRoute - MUPDirectSegmentDiscoveryRoute - MUPType1SessionTransformedRoute - MUPType2SessionTransformedRoute
repeated google.protobuf.Any pattrs = 2
Each attribute must be one of *Attribute defined in "api/attribute.proto".
optional google.protobuf.Timestamp age = 3
bool best = 4
bool is_withdraw = 5
optional Validation validation = 7
bool no_implicit_withdraw = 8
optional Family family = 9
uint32 source_asn = 10
string source_id = 11
bool filtered = 12
bool stale = 13
bool is_from_external = 14
string neighbor_ip = 15
bytes uuid = 16
only paths installed by AddPath API have this
bool is_nexthop_invalid = 17
uint32 identifier = 18
uint32 local_identifier = 19
bytes nlri_binary = 20
repeated bytes pattrs_binary = 21
bool send_max_filtered = 22

Used in: AddPeerRequest, ListPeerResponse, UpdatePeerRequest, WatchEventResponse.PeerEvent

optional ApplyPolicy apply_policy = 1
optional PeerConf conf = 2
optional EbgpMultihop ebgp_multihop = 3
optional RouteReflector route_reflector = 4
optional PeerState state = 5
optional Timers timers = 6
optional Transport transport = 7
optional RouteServer route_server = 8
optional GracefulRestart graceful_restart = 9
repeated AfiSafi afi_safis = 10
optional TtlSecurity ttl_security = 11

Used in: Peer

string auth_password = 1
string description = 2
uint32 local_asn = 3
string neighbor_address = 4
uint32 peer_asn = 5
string peer_group = 6
PeerType type = 7
RemovePrivate remove_private = 8
bool route_flap_damping = 9
uint32 send_community = 10
string neighbor_interface = 11
string vrf = 12
uint32 allow_own_asn = 13
bool replace_peer_asn = 14
bool admin_down = 15
bool send_software_version = 16
bool allow_aspath_loop_local = 17

Used in: AddPeerGroupRequest, ListPeerGroupResponse, UpdatePeerGroupRequest

optional ApplyPolicy apply_policy = 1
optional PeerGroupConf conf = 2
optional EbgpMultihop ebgp_multihop = 3
optional RouteReflector route_reflector = 4
optional PeerGroupState info = 5
optional Timers timers = 6
optional Transport transport = 7
optional RouteServer route_server = 8
optional GracefulRestart graceful_restart = 9
repeated AfiSafi afi_safis = 10
optional TtlSecurity ttl_security = 11

Used in: PeerGroup

string auth_password = 1
string description = 2
uint32 local_asn = 3
uint32 peer_asn = 4
string peer_group_name = 5
PeerType type = 6
RemovePrivate remove_private = 7
bool route_flap_damping = 8
uint32 send_community = 9
bool send_software_version = 10

Used in: PeerGroup

string auth_password = 1
string description = 2
uint32 local_asn = 3
uint32 peer_asn = 4
string peer_group_name = 5
PeerType type = 6
RemovePrivate remove_private = 7
bool route_flap_damping = 8
uint32 send_community = 9
uint32 total_paths = 10
uint32 total_prefixes = 11

Used in: Peer

string auth_password = 1
string description = 2
uint32 local_asn = 3
optional Messages messages = 4
string neighbor_address = 5
uint32 peer_asn = 6
string peer_group = 7
PeerType type = 8
optional Queues queues = 9
RemovePrivate remove_private = 10
bool route_flap_damping = 11
uint32 send_community = 12
PeerState.SessionState session_state = 13
PeerState.AdminState admin_state = 15
uint32 out_q = 16
uint32 flops = 17
repeated google.protobuf.Any remote_cap = 18
Each attribute must be one of *Capability defined in "api/capability.proto".
repeated google.protobuf.Any local_cap = 19
string router_id = 20

Used in: PeerState

UP = 0
DOWN = 1
PFX_CT = 2
prefix counter over limit

Used in: PeerState

UNKNOWN = 0
IDLE = 1
CONNECT = 2
ACTIVE = 3
OPENSENT = 4
OPENCONFIRM = 5
ESTABLISHED = 6

Used in: PeerConf, PeerGroupConf, PeerGroupState, PeerState

INTERNAL = 0
EXTERNAL = 1

uint32 flags = 1
uint32 type = 2
uint32 label = 3
bytes id = 4

Used in: AddPolicyRequest, DeletePolicyRequest, ListPolicyResponse, PolicyAssignment, RoutingPolicy, SetPoliciesRequest

string name = 1
repeated Statement statements = 2

Used in: AddPolicyAssignmentRequest, ApplyPolicy, DeletePolicyAssignmentRequest, ListPolicyAssignmentResponse, SetPoliciesRequest, SetPolicyAssignmentRequest

string name = 1
PolicyDirection direction = 2
repeated Policy policies = 4
RouteAction default_action = 5

Used in: ListPolicyAssignmentRequest, PolicyAssignment

UNKNOWN = 0
IMPORT = 1
EXPORT = 2

Used in: DefinedSet

string ip_prefix = 1
uint32 mask_length_min = 2
uint32 mask_length_max = 3

Used in: AfiSafi

optional Family family = 1
uint32 max_prefixes = 2
uint32 shutdown_threshold_pct = 3

https://tools.ietf.org/html/rfc8669

repeated google.protobuf.Any tlvs = 1
tlv is one of: - IndexLabelTLV Type 1 (not yet implemented) - OriginatorSRGBTLV Type 3 (not yet implemented) - SRv6L3ServiceTLV Type 5 - SRv6L2ServiceTLV Type 6

Used in: PeerState

uint32 input = 1
uint32 output = 2

Used in: Roa, Rpki

string address = 1
uint32 remote_port = 2

Used in: Rpki

optional google.protobuf.Timestamp uptime = 1
optional google.protobuf.Timestamp downtime = 2
bool up = 3
uint32 record_ipv4 = 4
uint32 record_ipv6 = 5
uint32 prefix_ipv4 = 6
uint32 prefix_ipv6 = 7
uint32 serial = 8
int64 received_ipv4 = 9
int64 received_ipv6 = 10
int64 serial_notify = 11
int64 cache_reset = 12
int64 cache_response = 13
int64 end_of_data = 14
int64 error = 15
int64 serial_query = 16
int64 reset_query = 17

uint32 asn = 1
uint32 local_admin = 2

string address = 1
uint32 local_admin = 2

string address = 1
uint32 local_admin = 2

uint32 asn = 1
uint32 local_admin = 2

Used in: PeerConf, PeerGroupConf, PeerGroupState, PeerState

REMOVE_NONE = 0
REMOVE_ALL = 1
REPLACE = 2

Used in: ResetPeerRequest

IN = 0
OUT = 1
BOTH = 2

Used in: ListRpkiTableResponse, Validation

uint32 asn = 1
uint32 prefixlen = 2
uint32 maxlen = 3
string prefix = 4
optional RPKIConf conf = 5

Used in: Actions, PolicyAssignment

NONE = 0
ACCEPT = 1
REJECT = 2

uint32 admin = 1
uint32 assigned = 2

string admin = 1
uint32 assigned = 2

uint32 admin = 1
uint32 assigned = 2

Used in: Conditions, OriginAction

ORIGIN_NONE = 0
ORIGIN_IGP = 1
ORIGIN_EGP = 2
ORIGIN_INCOMPLETE = 3

Used in: Peer, PeerGroup

bool route_reflector_client = 1
string route_reflector_cluster_id = 2

(message has no fields)

Used in: AfiSafi

optional RouteSelectionOptionsConfig config = 1
optional RouteSelectionOptionsState state = 2

Used in: Global, RouteSelectionOptions

bool always_compare_med = 1
bool ignore_as_path_length = 2
bool external_compare_router_id = 3
bool advertise_inactive_routes = 4
bool enable_aigp = 5
bool ignore_next_hop_igp_metric = 6
bool disable_best_path_selection = 7

Used in: RouteSelectionOptions

bool always_compare_med = 1
bool ignore_as_path_length = 2
bool external_compare_router_id = 3
bool advertise_inactive_routes = 4
bool enable_aigp = 5
bool ignore_next_hop_igp_metric = 6
bool disable_best_path_selection = 7

Used in: Peer, PeerGroup

bool route_server_client = 1
bool secondary_route = 2

Used in: AfiSafi

optional RouteTargetMembershipConfig config = 1
optional RouteTargetMembershipState state = 2

Used in: RouteTargetMembership

uint32 deferral_time = 1

RouteTargetMembershipNLRI represents the NLRI for: - AFI=1, SAFI=132

uint32 asn = 1
optional google.protobuf.Any rt = 2
One of: - TwoOctetAsSpecificExtended - IPv4AddressSpecificExtended - FourOctetAsSpecificExtended

Used in: RouteTargetMembership

uint32 deferral_time = 1

string mac = 1

repeated DefinedSet defined_sets = 1
repeated Policy policies = 2

Used in: ListRpkiResponse

optional RPKIConf conf = 1
optional RPKIState state = 2

bool s_flag = 1
bool i_flag = 2
bytes sid = 3

SRPolicyNLRI represents the NLRI for: - AFI=1, SAFI=73 - AFI=2, SAFI=73

uint32 length = 1
length field carries the length of NLRI portion expressed in bits
uint32 distinguisher = 2
distinguisher field carries 4-octet value uniquely identifying the policy in the context of <color, endpoint> tuple.
uint32 color = 3
color field carries 4-octet value identifying (with the endpoint) the policy. The color is used to match the color of the destination prefixes to steer traffic into the SR Policy
bytes endpoint = 4
endpoint field identifies the endpoint of a policy. The Endpoint may represent a single node or a set of nodes (e.g., an anycast address). The Endpoint is an IPv4 (4-octet) address or an IPv6 (16-octet) address according to the AFI of the NLRI.

Used in: TunnelEncapSubTLVSRSegmentList

uint32 flags = 1
uint32 weight = 2

Used in: SRv6EndPointBehavior

RESERVED = 0
END = 1
END_WITH_PSP = 2
END_WITH_USP = 3
END_WITH_PSP_USP = 4
ENDX = 5
ENDX_WITH_PSP = 6
ENDX_WITH_USP = 7
ENDX_WITH_PSP_USP = 8
ENDT = 9
ENDT_WITH_PSP = 10
ENDT_WITH_USP = 11
ENDT_WITH_PSP_USP = 12
END_B6_ENCAPS = 14
END_BM = 15
END_DX6 = 16
END_DX4 = 17
END_DT6 = 18
END_DT4 = 19
END_DT46 = 20
END_DX2 = 21
END_DX2V = 22
END_DT2U = 23
END_DT2M = 24
END_B6_ENCAPS_Red = 27
END_WITH_USD = 28
END_WITH_PSP_USD = 29
END_WITH_USP_USD = 30
END_WITH_PSP_USP_USD = 31
ENDX_WITH_USD = 32
ENDX_WITH_PSP_USD = 33
ENDX_WITH_USP_USD = 34
ENDX_WITH_PSP_USP_USD = 35
ENDT_WITH_USD = 36
ENDT_WITH_PSP_USD = 37
ENDT_WITH_USP_USD = 38
ENDT_WITH_PSP_USP_USD = 39
ENDM_GTP6D = 69
0x0045
ENDM_GTP6DI = 70
0x0046
ENDM_GTP6E = 71
0x0047
ENDM_GTP4E = 72
0x0048

bool s_flag = 1
bool i_flag = 2
bool b_flag = 3
bytes sid = 4
optional SRv6EndPointBehavior endpoint_behavior_structure = 5

Used in: SRv6BindingSID, SegmentTypeB

SRv6Behavior behavior = 1
uint32 block_len = 2
uint32 node_len = 3
uint32 func_len = 4
uint32 arg_len = 5

https://tools.ietf.org/html/draft-dawra-bess-srv6-services-02#section-2.1.1

bytes sid = 1
optional SRv6SIDFlags flags = 2
uint32 endpoint_behavior = 3
map<uint32, SRv6TLV> sub_sub_tlvs = 4
SRv6TLV is one of: - SRv6StructureSubSubTLV

https://www.rfc-editor.org/rfc/rfc9252.html#section-2

map<uint32, SRv6TLV> sub_tlvs = 1
SRv6TLV is one of: - SRv6InformationSubTLV

https://www.rfc-editor.org/rfc/rfc9252.html#section-2

map<uint32, SRv6TLV> sub_tlvs = 1
SRv6TLV is one of: - SRv6InformationSubTLV

Used in: SRv6InformationSubTLV

bool flag_1 = 1
Placeholder for future sid flags

https://www.rfc-editor.org/rfc/rfc9252.html#section-3.2.1

uint32 locator_block_length = 1
uint32 locator_node_length = 2
uint32 function_length = 3
uint32 argument_length = 4
uint32 transposition_length = 5
uint32 transposition_offset = 6

Used in: SRv6InformationSubTLV, SRv6L2ServiceTLV, SRv6L3ServiceTLV

repeated google.protobuf.Any tlv = 1

Used in: SegmentTypeA, SegmentTypeB

bool v_flag = 1
bool a_flag = 2
bool s_flag = 3
bool b_flag = 4

optional SegmentFlags flags = 1
uint32 label = 2

optional SegmentFlags flags = 1
bytes sid = 2
optional SRv6EndPointBehavior endpoint_behavior_structure = 3

Used in: SetLogLevelRequest

PANIC = 0
FATAL = 1
ERROR = 2
WARN = 3
INFO = 4
DEBUG = 5
TRACE = 6

string software_version = 1

Used in: AddStatementRequest, DeleteStatementRequest, ListStatementResponse, Policy

string name = 1
optional Conditions conditions = 2
optional Actions actions = 3

API representation of table.LookupPrefix

Used in: ListPathRequest

string prefix = 1
TableLookupPrefix.Type type = 2
string rd = 3

API representation of table.LookupOption

Used in: TableLookupPrefix

EXACT = 0
LONGER = 1
SHORTER = 2

Used in: AddPathRequest, AddPathStreamRequest, DeletePathRequest, GetTableRequest, ListPathRequest

GLOBAL = 0
LOCAL = 1
ADJ_IN = 2
ADJ_OUT = 3
VRF = 4

Used in: Peer, PeerGroup

optional TimersConfig config = 1
optional TimersState state = 2

Used in: Timers

uint64 connect_retry = 1
uint64 hold_time = 2
uint64 keepalive_interval = 3
uint64 minimum_advertisement_interval = 4
uint64 idle_hold_time_after_reset = 5

Used in: Timers

uint64 connect_retry = 1
uint64 hold_time = 2
uint64 keepalive_interval = 3
uint64 minimum_advertisement_interval = 4
uint64 negotiated_hold_time = 5
optional google.protobuf.Timestamp uptime = 6
optional google.protobuf.Timestamp downtime = 7

bool terminal = 1
bool sample = 2

uint32 asn = 1
float rate = 2

uint32 dscp = 1

Used in: Peer, PeerGroup

string local_address = 1
uint32 local_port = 2
bool mtu_discovery = 3
bool passive_mode = 4
string remote_address = 5
uint32 remote_port = 6
uint32 tcp_mss = 7
string bind_interface = 8

Used in: Peer, PeerGroup

bool enabled = 1
uint32 ttl_min = 2

repeated TunnelEncapTLV tlvs = 1

uint32 color = 1

string address = 1

uint32 key = 1
bytes cookie = 2

uint32 protocol = 1

optional google.protobuf.Any bsid = 1
bsid must be one of: - SRBindingSID - SRv6BindingSID

string candidate_path_name = 1

uint32 flags = 1
ENLPType enlp = 2

uint32 flags = 1
uint32 preference = 2

uint32 priority = 1

optional SRWeight weight = 1
repeated google.protobuf.Any segments = 2
segments must be one of: - SegmentTypeA - SegmentTypeB

uint32 port = 1

uint32 type = 1
bytes value = 2

Used in: TunnelEncapAttribute

uint32 type = 1
repeated google.protobuf.Any tlvs = 2
Each TLV must be one of: - TunnelEncapSubTLVEncapsulation - TunnelEncapSubTLVProtocol - TunnelEncapSubTLVColor - TunnelEncapSubTLVSRPolicy - TunnelEncapSubTLVUnknown

bool is_transitive = 1
uint32 sub_type = 2
uint32 asn = 3
uint32 local_admin = 4

uint32 flags = 1
uint32 type = 2
bytes value = 3

uint32 code = 1
bytes value = 2

uint32 type = 1
bytes value = 2

Used in: AfiSafi

optional UseMultiplePathsConfig config = 1
optional UseMultiplePathsState state = 2
optional Ebgp ebgp = 3
optional Ibgp ibgp = 4

Used in: UseMultiplePaths

bool enabled = 1

Used in: UseMultiplePaths

bool enabled = 1

uint32 control_flags = 1
uint32 mtu = 2

VPLSNLRI represents the NLRI for: - AFI=25, SAFI=65

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetASN - RouteDistinguisherIPAddress - RouteDistinguisherFourOctetASN
uint32 ve_id = 2
uint32 ve_block_offset = 3
uint32 ve_block_size = 4
uint32 label_block_base = 5

VPNFlowSpecNLRI represents the NLRI for: - AFI=1, SAFI=134 - AFI=2, SAFI=134 - AFI=25, SAFI=134

optional google.protobuf.Any rd = 1
One of: - RouteDistinguisherTwoOctetAS - RouteDistinguisherIPAddressAS - RouteDistinguisherFourOctetAS
repeated google.protobuf.Any rules = 2
One of: - FlowSpecIPPrefix - FlowSpecMAC - FlowSpecComponent

Used in: Path

Validation.State state = 1
Validation.Reason reason = 2
repeated Roa matched = 3
repeated Roa unmatched_asn = 4
repeated Roa unmatched_length = 5

Used in: Validation

REASON_NONE = 0
REASON_ASN = 1
REASON_LENGTH = 2

Used in: Validation

STATE_NONE = 0
STATE_NOT_FOUND = 1
STATE_VALID = 2
STATE_INVALID = 3

uint32 state = 1

Used in: AddVrfRequest, ListVrfResponse

string name = 1
optional google.protobuf.Any rd = 2
Route Distinguisher must be one of RouteDistinguisherTwoOctetAS, RouteDistinguisherIPAddressAS, or RouteDistinguisherFourOctetAS.
repeated google.protobuf.Any import_rt = 3
List of the Import Route Targets. Each must be one of TwoOctetAsSpecificExtended, IPv4AddressSpecificExtended, or FourOctetAsSpecificExtended.
repeated google.protobuf.Any export_rt = 4
List of the Export Route Targets. Each must be one of TwoOctetAsSpecificExtended, IPv4AddressSpecificExtended, or FourOctetAsSpecificExtended.
uint32 id = 5

Used in: WatchEventRequest

(message has no fields)

Used in: WatchEventRequest

repeated Table.Filter filters = 1

Used in: Table

Filter.Type type = 1
bool init = 2
string peer_address = 3
string peer_group = 4

Used in: Filter

BEST = 0
ADJIN = 1
POST_POLICY = 2
EOR = 3

Used in: WatchEventResponse

PeerEvent.Type type = 1
optional Peer peer = 2

Used in: PeerEvent

UNKNOWN = 0
INIT = 1
END_OF_INIT = 2
STATE = 3

Used in: WatchEventResponse

repeated Path paths = 2

package apipb

service GobgpApi

rpc StartBgp (StartBgpRequest, google.protobuf.Empty)

message StartBgpRequest

optional Global global = 1

rpc StopBgp (StopBgpRequest, google.protobuf.Empty)

message StopBgpRequest

rpc GetBgp (GetBgpRequest, GetBgpResponse)

message GetBgpRequest

message GetBgpResponse

optional Global global = 1

rpc WatchEvent (WatchEventRequest, stream WatchEventResponse)

message WatchEventRequest

optional WatchEventRequest.Peer peer = 1

optional WatchEventRequest.Table table = 2

uint32 batch_size = 3

message WatchEventResponse

oneof event

WatchEventResponse.PeerEvent peer = 2

WatchEventResponse.TableEvent table = 3

rpc AddPeer (AddPeerRequest, google.protobuf.Empty)

message AddPeerRequest

optional Peer peer = 1

rpc DeletePeer (DeletePeerRequest, google.protobuf.Empty)

message DeletePeerRequest

string address = 1

string interface = 2

rpc ListPeer (ListPeerRequest, stream ListPeerResponse)

message ListPeerRequest

string address = 1

bool enableAdvertised = 2

message ListPeerResponse

optional Peer peer = 1

rpc UpdatePeer (UpdatePeerRequest, UpdatePeerResponse)

message UpdatePeerRequest

optional Peer peer = 1

bool do_soft_reset_in = 2

message UpdatePeerResponse

bool needs_soft_reset_in = 1

rpc ResetPeer (ResetPeerRequest, google.protobuf.Empty)

message ResetPeerRequest

string address = 1

string communication = 2

bool soft = 3

ResetPeerRequest.SoftResetDirection direction = 4

rpc ShutdownPeer (ShutdownPeerRequest, google.protobuf.Empty)

message ShutdownPeerRequest

string address = 1

string communication = 2

rpc EnablePeer (EnablePeerRequest, google.protobuf.Empty)

message EnablePeerRequest

string address = 1

rpc DisablePeer (DisablePeerRequest, google.protobuf.Empty)

message DisablePeerRequest

string address = 1

string communication = 2

rpc AddPeerGroup (AddPeerGroupRequest, google.protobuf.Empty)

message AddPeerGroupRequest

optional PeerGroup peer_group = 1

rpc DeletePeerGroup (DeletePeerGroupRequest, google.protobuf.Empty)

message DeletePeerGroupRequest

string name = 1

rpc ListPeerGroup (ListPeerGroupRequest, stream ListPeerGroupResponse)

message ListPeerGroupRequest

string peer_group_name = 1

message ListPeerGroupResponse

optional PeerGroup peer_group = 1

rpc UpdatePeerGroup (UpdatePeerGroupRequest, UpdatePeerGroupResponse)

message UpdatePeerGroupRequest

optional PeerGroup peer_group = 1

bool do_soft_reset_in = 2

message UpdatePeerGroupResponse

bool needs_soft_reset_in = 1

rpc AddDynamicNeighbor (AddDynamicNeighborRequest, google.protobuf.Empty)

message AddDynamicNeighborRequest

optional DynamicNeighbor dynamic_neighbor = 1

rpc ListDynamicNeighbor (ListDynamicNeighborRequest, stream ListDynamicNeighborResponse)

message ListDynamicNeighborRequest

string peer_group = 1

message ListDynamicNeighborResponse