Cisco Service Layer API Documentation

sl_bgpls_topology.proto File Reference

RPC proto file for BGP-LS Topology Subscription Service. More...

RPC Calls

rpc SLBgplsTopo::SLBgplsTopoNotifStream (SLBgplsTopoNotifReqMsg) returns(stream SLBgplsTopoNotifMsg)
 BGP-LS Topology Subscription. More...
 

Messages

message  SLBgplsTopoNotifReqMsg
 BGP-LS Topology Notification Request message. More...
 
message  SLBgplsTopoNlriMatch
 
message  SLBgplsTopoNotifMsg
 BGP-LS Topology Notification message. More...
 
message  SLBgplsTopoStartMarker
 Start marker - sent before any DATA is sent. More...
 
message  SLBgplsTopoEndMarker
 End marker - sent after all DATA are sent. More...
 
message  SLBgplsTopoNotif
 BGP-LS Topology Updates. More...
 
message  SLBgplsTopoEntry
 BGP-LS Topology Entry. More...
 
message  SLBgplsTopoData
 Messages for BGP-LS Data. More...
 
message  SLBgplsTopoInstanceId
 
message  SLBgplsTopoNodeData
 Node Data. More...
 
message  SLBgplsTopoLinkData
 Link Data. More...
 
message  SLBgplsTopoPrefixData
 Prefix Data. More...
 
message  SLBgplsTopoNode
 Messages for NLRI Objects. More...
 
message  SLBgplsTopoPrefix
 Prefix. More...
 
message  SLBgplsTopoLinkDescr
 Messages for NLRI Descriptors. More...
 
message  SLBgplsTopoPrefixDescr
 Prefix descriptor. More...
 
message  SLBgplsTopoOspfNodeId
 Messages of Node Identifiers. More...
 
message  SLBgplsTopoOspfv3NodeId
 OSPFv3 Node ID. More...
 
message  SLBgplsTopoIsisNodeId
 ISIS Node ID. More...
 
message  SLBgplsTopoBgpNodeId
 BGP Node ID. More...
 
message  SLBgplsTopoNodeAttr
 Messages of Attributes. More...
 
message  SLBgplsTopoLinkAttr
 Link Attributes. More...
 
message  SLBgplsTopoPrefixAttr
 Prefix Attributes. More...
 
message  SLBplsTopoLinkLocRemId
 Messages for Attribute definitions sorted by TLV code point. More...
 
message  SLBgplsTopoMtId
 Multi-Topology Identifier. More...
 
message  SLBgplsTopoNodeMsd
 Node MSD. More...
 
message  SLBgplsTopoLinkMsd
 Link MSD. More...
 
message  SLBgplsTopoNodeFlagBits
 Node Flag Bits. More...
 
message  SLBgplsTopoNodeOpaqueAttr
 Opaque Node Attribute. More...
 
message  SLBgplsNodeName
 Node Name. More...
 
message  SLBgplsTopoIsisAreaId
 IS-IS Area Identifier. More...
 
message  SLBgplsTopoLocalIpv4RouterId
 Local IPv4/IPv6 Router-ID. More...
 
message  SLBgplsTopoLocalIpv6RouterId
 Local IPv4/IPv6 Router-ID. More...
 
message  SLBgplsTopoRemoteIpv4RouterId
 Remote IPv4/IPv6 Router-ID. More...
 
message  SLBgplsTopoRemoteIpv6RouterId
 Remote IPv4/IPv6 Router-ID. More...
 
message  SLBgplsTopoSrgb
 SR Capabilities. More...
 
message  SLBgplsTopoSrgbIsisFlags
 Segment Routing Global Block (SRGB) ISIS flags. More...
 
message  SLBgplsTopoSrAlgorithm
 SR-Algorithm. More...
 
message  SLBgplsTopoSrlb
 SR Local Block. More...
 
message  SLBgplsTopoFad
 Flexible Algorithm Definition. More...
 
message  SLBgplsTopoPrefixFAPM
 Flexible Algorithm Prefix metric. More...
 
message  SLBgplsTopoFadUnsuppTlv
 Unsupported Flexible Algorithm Definition (FAD) TLVs. TLV 1046. More...
 
message  SLBgplsTopoFadExcMaxDelay
 Flexible Algorithm Exclude Maximum Delay. TLV 1050. More...
 
message  SLBgplsTopoLinkMaxBandwidth
 Maximum Link Bandwidth. More...
 
message  SLBgplsTopoLinkMaxResvBandwidth
 Maximum Reservable Link Bandwidth. More...
 
message  SLBgplsTopoLinkUnresvBandwidth
 Unreserved Link Bandwidth. More...
 
message  SLBgplsTopoLinkTeDefaultMetric
 TE Default Metric. More...
 
message  SLBgplsTopoLinkProtectionType
 Link Protection Type. More...
 
message  SLBgplsTopoLinkMplsProtoMask
 MPLS Proto Mask. More...
 
message  SLBgplsTopoLinkIgpMetric
 IGP Metric. More...
 
message  SLBgplsTopoLinkSrlg
 Shared Risk Link Group. More...
 
message  SLBgplsTopoLinkOpaqueAttr
 Opaque Link Attribute. More...
 
message  SLBgplsTopoLinkName
 Link Name. More...
 
message  SLBgplsTopoAdjSid
 Adjacency SID. More...
 
message  SLBgplsTopoLanAdjSid
 LAN Adjacency SID. More...
 
message  SLBgplsTopoBgpPeerNodeSid
 BGP Peer Node SID. More...
 
message  SLBgplsTopoBgpPeerAdjSid
 BGP Peer Adjacency SID. More...
 
message  SLBgplsTopoBgpPeerSetSid
 BGP Peer Set SID. More...
 
message  SLBgpLsTopoNeighborId
 Neighbor ID used in Adjacency SID and SRv6 EndX SID. More...
 
message  SLBgplsTopoUniLinkDelay
 Unidirectional Link Delay. More...
 
message  SLBgplsTopoMinMaxUniLinkDelay
 Min/Max Unidirectional Link Delay. More...
 
message  SLBgplsTopoUniDelayVar
 Unidirectional Delay Variation. More...
 
message  SLBgplsTopoUniLinkLoss
 Unidirectional Link Loss. More...
 
message  SLBgplsTopoUniResBandwidth
 Unidirectional Residual Bandwidth. More...
 
message  SLBgplsTopoUniAvailBandwidth
 Unidirectional Available Bandwidth. More...
 
message  SLBgplsTopoUniUtilBandwidth
 Unidirectional Utilized Bandwidth. More...
 
message  SLBgplsTopoAslaAttr
 ASLA Attributes. More...
 
message  SLBgplsTopoPrefixIgpFlags
 IGP Flags. More...
 
message  SLBgplsTopoPrefixIgpRouteTag
 IGP Route Tag. More...
 
message  SLBgplsTopoPrefixIgpExtRouteTag
 IGP Extended Route Tag. More...
 
message  SLBgplsTopoPrefixMetric
 Prefix Metric. More...
 
message  SLBgplsTopoPrefixOspfFwdAddr
 OSPF Forwarding Address. More...
 
message  SLBgplsTopoPrefixOpaqueAttr
 Opaque Prefix Attribute. More...
 
message  SLBgplsTopoPrefixSid
 Prefix SID. More...
 
message  SLBgplsTopoPrefixRange
 Prefix Range. More...
 
message  SLBgplsTopoPrefixAttrFlags
 Prefix Attribute Flags. More...
 
message  SLBgplsTopoPrefixSrcRouterId
 Source Route Identifier. More...
 
message  SLBgplsTopoL2BundleMemberAttr
 L2 Bundle Member Attribute. More...
 
message  SLBgplsTopoExtAdminGroup
 Extended Administrative Group. More...
 
message  SLBgplsTopoUnknownAttr
 Unknown Attribute. More...
 

Enumerations

enum  SLBgplsTopoOperation { SL_BGPLS_TOPO_OPERATION_RESERVED = 0, SL_BGPLS_TOPO_OPERATION_UPDATE = 1, SL_BGPLS_TOPO_OPERATION_DELETE = 2 }
 BGP-LS Topology Operation.
 
enum  SLBgplsTopoNlriType {
  SL_BGPLS_TOPO_NLRI_TYPE_RESERVED = 0, SL_BGPLS_TOPO_NLRI_TYPE_NODE = 1, SL_BGPLS_TOPO_NLRI_TYPE_LINK = 2, SL_BGPLS_TOPO_NLRI_TYPE_IPV4_PREFIX = 3,
  SL_BGPLS_TOPO_NLRI_TYPE_IPV6_PREFIX = 4
}
 NLRI type.
 
enum  SLBgplsTopoProtocol {
  SL_BGPLS_TOPO_PROTOCOL_RESERVED = 0, SL_BGPLS_TOPO_PROTOCOL_ISIS_L1 = 1, SL_BGPLS_TOPO_PROTOCOL_ISIS_L2 = 2, SL_BGPLS_TOPO_PROTOCOL_OSPFv2 = 3,
  SL_BGPLS_TOPO_PROTOCOL_DIRECT = 4, SL_BGPLS_TOPO_PROTOCOL_STATIC = 5, SL_BGPLS_TOPO_PROTOCOL_OSPFv3 = 6, SL_BGPLS_TOPO_PROTOCOL_BGP = 7,
  SL_BGPLS_TOPO_PROTOCOL_RSVP_TE = 8, SL_BGPLS_TOPO_PROTOCOL_SR = 9
}
 Protocols.
 
enum  SLBgplsTopoOspfRouteType {
  SL_BGPLS_TOPO_OSPF_ROUTE_TYPE_RESERVED = 0, SL_BGPLS_TOPO_OSPF_ROUTE_TYPE_INTRA_AREA = 1, SL_BGPLS_TOPO_OSPF_ROUTE_TYPE_INTER_AREA = 2, SL_BGPLS_TOPO_OSPF_ROUTE_TYPE_EXTERN_1 = 3,
  SL_BGPLS_TOPO_OSPF_ROUTE_TYPE_EXTERN_2 = 4, SL_BGPLS_TOPO_OSPF_ROUTE_TYPE_NSSA_1 = 5, SL_BGPLS_TOPO_OSPF_ROUTE_TYPE_NSSA_2 = 6
}
 OSPF Route types.
 
enum  SLBgplsTopoSidFormat { SL_BGPLS_TOPO_SID_FORMAT_RESERVED = 0, SL_BGPLS_TOPO_SID_FORMAT_LABEL = 1, SL_BGPLS_TOPO_SID_FORMAT_INDEX = 2, SL_BGPLS_TOPO_SID_FORMAT_V6_ADDR = 3 }
 BGP-LS Topology SID Formats. More...
 
enum  SLBgplsTopoPrefixSidFormat { SL_BGPLS_TOPO_PREFIX_SID_FORMAT_RESERVED = 0, SL_BGPLS_TOPO_PREFIX_SID_FORMAT_LABEL = 1, SL_BGPLS_TOPO_PREFIX_SID_FORMAT_INDEX = 2 }
 BGP-LS Topology Prefix SID Formats. More...
 

Attributes

 syntax = "proto3"
 
package service_layer
 
option go_package ="github.com/Cisco-service-layer/service-layer-objmodel/grpc/protos;service_layer"
 

Detailed Description

RPC proto file for BGP-LS Topology Subscription Service.

The RPCs and messages defined here are experimental and subject to change without notice and such changes can break backwards compatibility.


Copyright (c) 2024 by Cisco Systems, Inc.

All rights reserved.