Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

apiutil

package

Go to main page

Versions in this module

v4

v4.3.0

Feb 28, 2026

v4.2.0

Jan 1, 2026

v4.1.0

Nov 30, 2025

v4.0.0

Nov 3, 2025

Changes in this version

+ func GetNativeNlri(p *api.Path) (bgp.NLRI, error)

+ func GetNativePathAttributes(p *api.Path) ([]bgp.PathAttributeInterface, error)

+ func MarshalCapabilities(values []bgp.ParameterCapabilityInterface) ([]*api.Capability, error)

+ func MarshalCapability(value bgp.ParameterCapabilityInterface) (*api.Capability, error)

+ func MarshalFlowSpecRules(values []bgp.FlowSpecComponentInterface) ([]*api.FlowSpecRule, error)

+ func MarshalLsBgpPeerSegmentSid(n *bgp.LsBgpPeerSegmentSID) (*api.LsBgpPeerSegmentSID, error)

+ func MarshalLsLinkDescriptor(n *bgp.LsLinkDescriptor) (*api.LsLinkDescriptor, error)

+ func MarshalLsLinkNLRI(n *bgp.LsLinkNLRI) (*api.LsAddrPrefix_LsNLRI, error)

+ func MarshalLsNodeDescriptor(d *bgp.LsNodeDescriptor) (*api.LsNodeDescriptor, error)

+ func MarshalLsNodeNLRI(n *bgp.LsNodeNLRI) (*api.LsAddrPrefix_LsNLRI, error)

+ func MarshalLsPrefixDescriptor(d *bgp.LsPrefixDescriptor) (*api.LsPrefixDescriptor, error)

+ func MarshalLsPrefixV4NLRI(n *bgp.LsPrefixV4NLRI) (*api.LsAddrPrefix_LsNLRI, error)

+ func MarshalLsPrefixV6NLRI(n *bgp.LsPrefixV6NLRI) (*api.LsAddrPrefix_LsNLRI, error)

+ func MarshalLsSRv6SIDNLRI(n *bgp.LsSrv6SIDNLRI) (*api.LsAddrPrefix_LsNLRI, error)

+ func MarshalLsTLVMultiTopoID(mti *bgp.LsTLVMultiTopoID) (*api.LsMultiTopologyIdentifier, error)

+ func MarshalLsTLVSrv6SIDInfo(info *bgp.LsTLVSrv6SIDInfo) (*api.LsSrv6SIDInformation, error)

+ func MarshalNLRI(value bgp.NLRI) (*api.NLRI, error)

+ func MarshalNLRIs(values []bgp.NLRI) ([]*api.NLRI, error)

+ func MarshalPathAttributes(attrList []bgp.PathAttributeInterface) ([]*api.Attribute, error)

+ func MarshalRD(rd bgp.RouteDistinguisherInterface) (*api.RouteDistinguisher, error)

+ func MarshalRT(rt bgp.ExtendedCommunityInterface) (*api.RouteTarget, error)

+ func MarshalRTs(values []bgp.ExtendedCommunityInterface) ([]*api.RouteTarget, error)

+ func MarshalSRBSID(bsid *bgp.TunnelEncapSubTLVSRBSID) (*api.SRBindingSID, error)

+ func MarshalSRSegments(segs []bgp.TunnelEncapSubTLVInterface) ([]*api.TunnelEncapSubTLVSRSegmentList_Segment, error)

+ func MarshalSRv6SubSubTLVs(tlvs []bgp.PrefixSIDTLVInterface) (map[uint32]*api.SRv6SubSubTLVs, error)

+ func MarshalSRv6SubTLVs(tlvs []bgp.PrefixSIDTLVInterface) (map[uint32]*api.SRv6SubTLVs, error)

+ func MarshalSRv6TLVs(tlvs []bgp.PrefixSIDTLVInterface) ([]*api.PrefixSID_TLV, error)

+ func NewAddPathCapability(a *bgp.CapAddPath) *api.AddPathCapability

+ func NewAggregatorAttributeFromNative(a *bgp.PathAttributeAggregator) (*api.AggregatorAttribute, error)

+ func NewAigpAttributeFromNative(a *bgp.PathAttributeAigp) (*api.AigpAttribute, error)

+ func NewAs4AggregatorAttributeFromNative(a *bgp.PathAttributeAs4Aggregator) (*api.As4AggregatorAttribute, error)

+ func NewAs4PathAttributeFromNative(a *bgp.PathAttributeAs4Path) (*api.As4PathAttribute, error)

+ func NewAsPathAttributeFromNative(a *bgp.PathAttributeAsPath) (*api.AsPathAttribute, error)

+ func NewAtomicAggregateAttributeFromNative(a *bgp.PathAttributeAtomicAggregate) (*api.AtomicAggregateAttribute, error)

+ func NewCarryingLabelInfoCapability(a *bgp.CapCarryingLabelInfo) *api.CarryingLabelInfoCapability

+ func NewClusterListAttributeFromNative(a *bgp.PathAttributeClusterList) (*api.ClusterListAttribute, error)

+ func NewCommunitiesAttributeFromNative(a *bgp.PathAttributeCommunities) (*api.CommunitiesAttribute, error)

+ func NewEnhancedRouteRefreshCapability(a *bgp.CapEnhancedRouteRefresh) *api.EnhancedRouteRefreshCapability

+ func NewEthernetSegmentIdentifierFromNative(a *bgp.EthernetSegmentIdentifier) (*api.EthernetSegmentIdentifier, error)

+ func NewExtendedCommunitiesAttributeFromNative(a *bgp.PathAttributeExtendedCommunities) (*api.ExtendedCommunitiesAttribute, error)

+ func NewExtendedNexthopCapability(a *bgp.CapExtendedNexthop) *api.ExtendedNexthopCapability

+ func NewFQDNCapability(a *bgp.CapFQDN) *api.FqdnCapability

+ func NewFourOctetASNumberCapability(a *bgp.CapFourOctetASNumber) *api.FourOctetASNCapability

+ func NewGracefulRestartCapability(a *bgp.CapGracefulRestart) *api.GracefulRestartCapability

+ func NewIP6ExtendedCommunitiesAttributeFromNative(a *bgp.PathAttributeIP6ExtendedCommunities) (*api.IP6ExtendedCommunitiesAttribute, error)

+ func NewLargeCommunitiesAttributeFromNative(a *bgp.PathAttributeLargeCommunities) (*api.LargeCommunitiesAttribute, error)

+ func NewLocalPrefAttributeFromNative(a *bgp.PathAttributeLocalPref) (*api.LocalPrefAttribute, error)

+ func NewLongLivedGracefulRestartCapability(a *bgp.CapLongLivedGracefulRestart) *api.LongLivedGracefulRestartCapability

+ func NewLsAttributeFromNative(a *bgp.PathAttributeLs) (*api.LsAttribute, error)

+ func NewMpReachNLRIAttributeFromNative(a *bgp.PathAttributeMpReachNLRI) (*api.MpReachNLRIAttribute, error)

+ func NewMpUnreachNLRIAttributeFromNative(a *bgp.PathAttributeMpUnreachNLRI) (*api.MpUnreachNLRIAttribute, error)

+ func NewMultiExitDiscAttributeFromNative(a *bgp.PathAttributeMultiExitDisc) (*api.MultiExitDiscAttribute, error)

+ func NewMultiProtocolCapability(a *bgp.CapMultiProtocol) *api.MultiProtocolCapability

+ func NewNextHopAttributeFromNative(a *bgp.PathAttributeNextHop) (*api.NextHopAttribute, error)

+ func NewOriginAttributeFromNative(a *bgp.PathAttributeOrigin) (*api.OriginAttribute, error)

+ func NewOriginatorIdAttributeFromNative(a *bgp.PathAttributeOriginatorId) (*api.OriginatorIdAttribute, error)

+ func NewPath(family bgp.Family, nlri bgp.NLRI, isWithdraw bool, ...) (*api.Path, error)

+ func NewPmsiTunnelAttributeFromNative(a *bgp.PathAttributePmsiTunnel) (*api.PmsiTunnelAttribute, error)

+ func NewPrefixSIDAttributeFromNative(a *bgp.PathAttributePrefixSID) (*api.PrefixSID, error)

+ func NewRouteRefreshCapability(a *bgp.CapRouteRefresh) *api.RouteRefreshCapability

+ func NewRouteRefreshCiscoCapability(a *bgp.CapRouteRefreshCisco) *api.RouteRefreshCiscoCapability

+ func NewSoftwareVersionCapability(a *bgp.CapSoftwareVersion) *api.SoftwareVersionCapability

+ func NewTunnelEncapAttributeFromNative(a *bgp.PathAttributeTunnelEncap) (*api.TunnelEncapAttribute, error)

+ func NewUnknownAttributeFromNative(a *bgp.PathAttributeUnknown) (*api.UnknownAttribute, error)

+ func NewUnknownCapability(a *bgp.CapUnknown) *api.UnknownCapability

+ func StringToNetIPLsTLVSrv6SIDInfo(s []string) ([]netip.Addr, uint16, error)

+ func ToApiFamily(afi uint16, safi uint8) *api.Family

+ func ToFamily(f *api.Family) bgp.Family

+ func UnmarshalAttribute(attr *api.Attribute) (bgp.PathAttributeInterface, error)

+ func UnmarshalCapabilities(values []*api.Capability) ([]bgp.ParameterCapabilityInterface, error)

+ func UnmarshalFlowSpecRules(values []*api.FlowSpecRule) ([]bgp.FlowSpecComponentInterface, error)

+ func UnmarshalLsAttribute(a *api.LsAttribute) (*bgp.LsAttribute, error)

+ func UnmarshalLsBgpPeerSegmentSid(a *api.LsBgpPeerSegmentSID) (*bgp.LsBgpPeerSegmentSID, error)

+ func UnmarshalLsLinkDescriptor(ld *api.LsLinkDescriptor) (*bgp.LsLinkDescriptor, error)

+ func UnmarshalLsNodeDescriptor(nd *api.LsNodeDescriptor) (*bgp.LsNodeDescriptor, error)

+ func UnmarshalLsPrefixDescriptor(*api.LsPrefixDescriptor) (*bgp.LsPrefixDescriptor, error)

+ func UnmarshalLsTLVMultiTopoID(mti *api.LsMultiTopologyIdentifier) (*bgp.LsTLVMultiTopoID, error)

+ func UnmarshalLsTLVSrv6SIDInfo(ssi *api.LsSrv6SIDInformation) (*bgp.LsTLVSrv6SIDInfo, error)

+ func UnmarshalNLRI(rf bgp.Family, an *api.NLRI) (bgp.NLRI, error)

+ func UnmarshalNLRIs(rf bgp.Family, values []*api.NLRI) ([]bgp.NLRI, error)

+ func UnmarshalPathAttributes(values []*api.Attribute) ([]bgp.PathAttributeInterface, error)

+ func UnmarshalPrefixDescriptor(pd *api.LsPrefixDescriptor) (*bgp.LsPrefixDescriptor, error)

+ func UnmarshalPrefixSID(psid *api.PrefixSID) (*bgp.PathAttributePrefixSID, error)

+ func UnmarshalRD(rd *api.RouteDistinguisher) (bgp.RouteDistinguisherInterface, error)

+ func UnmarshalRT(rt *api.RouteTarget) (bgp.ExtendedCommunityInterface, error)

+ func UnmarshalRTs(values []*api.RouteTarget) ([]bgp.ExtendedCommunityInterface, error)

+ func UnmarshalSRBSID(bsid *api.TunnelEncapSubTLVSRBindingSID) (bgp.TunnelEncapSubTLVInterface, error)

+ func UnmarshalSRSegments(s []*api.TunnelEncapSubTLVSRSegmentList_Segment) ([]bgp.TunnelEncapSubTLVInterface, error)

+ func UnmarshalSubSubTLVs(stlvs map[uint32]*api.SRv6SubSubTLVs) (uint16, []bgp.PrefixSIDTLVInterface, error)

+ func UnmarshalSubTLVs(stlvs map[uint32]*api.SRv6SubTLVs) (uint16, []bgp.PrefixSIDTLVInterface, error)

+ type AddPathRequest struct

+ Paths []*Path

+ VRFID string

+ type AddPathResponse struct

+ Error error

+ UUID uuid.UUID

+ type DeletePathRequest struct

+ DeleteAll bool

+ DeleteFamily *bgp.Family

+ Paths []*Path

+ UUIDs []uuid.UUID

+ VRFID string

+ type Destination struct

+ Paths []*Path

+ func NewDestination(dst *api.Destination) *Destination

+ func (d *Destination) MarshalJSON() ([]byte, error)

+ type ListPathRequest struct

+ EnableFiltered bool

+ Family bgp.Family

+ Name string

+ Prefixes []*LookupPrefix

+ SortType api.ListPathRequest_SortType

+ TableType api.TableType

+ type LookupOption uint8

+ const LOOKUP_EXACT

+ const LOOKUP_LONGER

+ const LOOKUP_SHORTER

+ type LookupPrefix struct

+ Prefix string

+ RD string

+ type Path struct

+ Age int64

+ Attrs []bgp.PathAttributeInterface

+ Best bool

+ Family bgp.Family

+ Filtered bool

+ IsFromExternal bool

+ IsNexthopInvalid bool

+ LocalID uint32

+ Nlri bgp.NLRI

+ NoImplicitWithdraw bool

+ PeerASN uint32

+ PeerAddress netip.Addr

+ PeerID netip.Addr

+ RemoteID uint32

+ SendMaxFiltered bool

+ Stale bool

+ Validation *api.Validation

+ Withdrawal bool

+ type Peer struct

+ Conf PeerConf

+ State PeerState

+ Transport Transport

+ type PeerConf struct

+ LocalASN uint32

+ NeighborAddress netip.Addr

+ NeighborInterface string

+ PeerASN uint32

+ type PeerEventType uint32

+ const PEER_EVENT_END_OF_INIT

+ const PEER_EVENT_INIT

+ const PEER_EVENT_STATE

+ const PEER_EVENT_UNKNOWN

+ type PeerState struct

+ AdminState api.PeerState_AdminState

+ DisconnectMessage string

+ DisconnectReason api.PeerState_DisconnectReason

+ LocalASN uint32

+ NeighborAddress netip.Addr

+ PeerASN uint32

+ RemoteCap []bgp.ParameterCapabilityInterface

+ RouterID netip.Addr

+ SessionState bgp.FSMState

+ type Transport struct

+ LocalAddress netip.Addr

+ LocalPort uint32

+ RemotePort uint32

+ type WatchEventMessage_PeerEvent struct

+ Peer Peer

+ Type PeerEventType

Other modules containing this package

github.com/osrg/gobgp/v3