Documentation ¶
Index ¶
- Constants
- Variables
- type AdvertiseAction
- type AreaAggregateConf
- type AreaAggregateState
- type AreaConf
- type AreaId
- type AreaRangeConf
- type AreaRangeEffect
- type AreaRangeState
- type AreaState
- type AreaSummary
- type AsLsdbState
- type AuthType
- type BigMetric
- type DesignatedRouterPriority
- type ExtLsdbState
- type GlobalConf
- type GlobalState
- type HelloRange
- type HostConf
- type HostState
- type IfMetricConf
- type IfMetricState
- type IfState
- type IfType
- type ImportAsExtern
- type InterfaceConf
- type InterfaceIndexOrZero
- type InterfaceState
- type IpAddress
- type LocalLsdbState
- type LsaType
- type LsdbState
- type Metric
- type MetricType
- type MulticastForwarding
- type NbmaNbrPermanence
- type NbrConf
- type NbrEvent
- type NbrRestartHelperStatus
- type NbrState
- type NeighborState
- type NssaTranslatorRole
- type NssaTranslatorState
- type OspfAreaLsaCountState
- type OspfEventState
- type OspfIPv4Route
- type PositiveInteger
- type RestartExitReason
- type RestartStatus
- type RestartSupport
- type RouterId
- type Status
- type StubAreaConf
- type StubAreaState
- type TosType
- type UpToMaxAge
- type VirtIfConf
- type VirtIfState
- type VirtLocalLsdbState
- type VirtNbrState
Constants ¶
const ( MaxAge uint16 = 3600 //60 min LSRefreshTime uint32 = 1800 // 30min AllSPFRouters string = "224.0.0.5" AllDRouters string = "224.0.0.6" McastMAC string = "01:00:5e:00:00:05" )
Architectural constants
const ( ADJACENCY string = "ADJACENCY" INTF string = "INTF" RIB string = "RIB" FLOOD string = "FLOOD" AREA string = "AREA" SPF string = "SPF" LSA string = "LSA" )
Event types
Variables ¶
var IfTypeList = []string{
"Undefined",
"Broadcast",
"Nbma",
"NumberedP2P",
"UnnumberedP2P",
"PointToMultipoint",
"Stub"}
var NbrStateList = []string{
"Undef",
"NbrDown",
"NbrAttempt",
"NbrInit",
"NbrTwoWay",
"NbrExchangeStart",
"NbrExchange",
"NbrLoading",
"NbrFull"}
Functions ¶
This section is empty.
Types ¶
type AdvertiseAction ¶
type AdvertiseAction int
const ( DoNotAdvertise AdvertiseAction = 1 Advertise AdvertiseAction = 2 )
type AreaAggregateConf ¶
type AreaAggregateConf struct { AreaAggregateAreaId AreaId AreaAggregateLsdbType LsaType AreaAggregateNet IpAddress AreaAggregateMask IpAddress AreaAggregateEffect AreaRangeEffect AreaAggregateExtRouteTag int }
OSPF Area Aggregate Table Replaces OSPF Area Summary Table Indexed By AreaAggregateAreaId, AreaAggregateLsdbType, AreaAggregateNet, AreaAggregateMask
type AreaAggregateState ¶
type AreaConf ¶
type AreaConf struct { AreaId AreaId AuthType AuthType ImportAsExtern ImportAsExtern AreaSummary AreaSummary StubDefaultCost int32 AreaNssaTranslatorRole NssaTranslatorRole }
Indexed By AreaId
type AreaRangeConf ¶
type AreaRangeConf struct { RangeAreaId AreaId AreaRangeNet IpAddress ArearangeMask IpAddress AreaRangeEffect AreaRangeEffect }
Indexed By RangeAreaId, RangeNet
type AreaRangeEffect ¶
type AreaRangeEffect int
const ( AdvertiseMatching AreaRangeEffect = 1 DoNotAdvertiseMatching AreaRangeEffect = 2 )
type AreaRangeState ¶
type AreaRangeState struct { RangeAreaId AreaId AreaRangeNet IpAddress ArearangeMask IpAddress AreaRangeEffect AreaRangeEffect }
type AreaSummary ¶
type AreaSummary int
const ( NoAreaSummary AreaSummary = 1 SendAreaSummary AreaSummary = 2 )
type AsLsdbState ¶
type AsLsdbState struct { AsLsdbType LsaType AsLsdbLsid IpAddress AsLsdbRouterId RouterId AsLsdbSequence int AsLsdbAge int AsLsdbChecksum int AsLsdbAdvertisement string }
Link State Database, AS - scope Indexed AsLsdbType, AsLsdbLsid, AsLsdbRouterId
type DesignatedRouterPriority ¶
type DesignatedRouterPriority int // 0x0 to 0xff
type ExtLsdbState ¶
type ExtLsdbState struct { ExtLsdbType LsaType ExtLsdbLsid IpAddress ExtLsdbRouterId RouterId ExtLsdbSequence int ExtLsdbAge int ExtLsdbChecksum int ExtLsdbAdvertisement string }
External LSA link State - Deprecated Indexed by ExtLsdbType, ExtLsdbLsid, ExtLsdbRouterId
type GlobalConf ¶
type GlobalState ¶
type GlobalState struct { RouterId RouterId VersionNumber int32 AreaBdrRtrStatus bool ExternLsaCount int32 ExternLsaChecksum int32 OriginateNewLsas int32 RxNewLsas int32 OpaqueLsaSupport bool RestartStatus RestartStatus RestartAge int32 RestartExitReason RestartExitReason AsLsaCount int32 AsLsaCksumSum int32 StubRouterSupport bool //DiscontinuityTime string DiscontinuityTime int32 //This should be string }
type HelloRange ¶
type HelloRange int // 0x1 to 0xffff
type HostConf ¶
type HostConf struct { HostIpAddress IpAddress HostTOS TosType HostMetric Metric HostCfgAreaID AreaId }
Indexed By HostIpAddress, HostTOS
type IfMetricConf ¶
type IfMetricConf struct { IfMetricIpAddress IpAddress IfMetricAddressLessIf InterfaceIndexOrZero IfMetricTOS TosType IfMetricValue Metric }
Indexed By IfMetricIpAddress, IfMetricAddressLessIf, IfMetricTOS
type IfMetricState ¶
type IfMetricState struct { IfMetricIpAddress IpAddress IfMetricAddressLessIf InterfaceIndexOrZero IfMetricTOS TosType IfMetricValue Metric }
type ImportAsExtern ¶
type ImportAsExtern int
const ( ImportExternal ImportAsExtern = 1 ImportNoExternal ImportAsExtern = 2 ImportNssa ImportAsExtern = 3 )
type InterfaceConf ¶
type InterfaceConf struct { IfIpAddress IpAddress AddressLessIf InterfaceIndexOrZero IfAreaId AreaId IfType IfType IfAdminStat Status IfRtrPriority DesignatedRouterPriority IfTransitDelay UpToMaxAge IfRetransInterval UpToMaxAge IfHelloInterval HelloRange IfRtrDeadInterval PositiveInteger IfPollInterval PositiveInteger IfAuthKey string IfAuthType AuthType }
type InterfaceIndexOrZero ¶
type InterfaceIndexOrZero int
type InterfaceState ¶
type LocalLsdbState ¶
type LocalLsdbState struct { LocalLsdbIpAddress IpAddress LocalLsdbAddressLessIf InterfaceIndexOrZero LocalLsdbType LsaType LocalLsdbLsid IpAddress LocalLsdbRouterId RouterId LocalLsdbSequence int LocalLsdbAge int LocalLsdbChecksum int LocalLsdbAdvertisement string }
Link local link state database for non-virtual links Indexed by LocalLsdbIpAddress, LocalLsdbAddressLessIf, LocalLsdbType, LocalLsdbLsid, LocalLsdbRouterId
type LsdbState ¶
type LsdbState struct { LsdbAreaId AreaId LsdbType LsaType LsdbLsid IpAddress LsdbRouterId RouterId LsdbSequence int LsdbAge int LsdbCheckSum int LsdbAdvertisement string }
Indexed by LsdbAreaId, LsdbType, LsdbLsid, LsdbRouterId
type MetricType ¶
type MetricType int
const ( OspfMetric MetricType = 1 ComparableCost MetricType = 2 NonComparable MetricType = 3 )
type MulticastForwarding ¶
type MulticastForwarding int
const ( Blocked MulticastForwarding = 1 Multicast MulticastForwarding = 2 Unicast MulticastForwarding = 3 )
type NbmaNbrPermanence ¶
type NbmaNbrPermanence int
const ( DynamicNbr NbmaNbrPermanence = 1 PermanentNbr NbmaNbrPermanence = 2 )
type NbrConf ¶
type NbrConf struct { NbrIpAddress IpAddress NbrAddressLessIndex InterfaceIndexOrZero NbrPriority DesignatedRouterPriority }
Indexed by NbrIpAddress, NbrAddressLessIndex
type NbrRestartHelperStatus ¶
type NbrRestartHelperStatus int
const ( NotHelping NbrRestartHelperStatus = 1 Helping NbrRestartHelperStatus = 2 )
type NeighborState ¶
type NeighborState struct { NbrIpAddress IpAddress NbrAddressLessIndex int NbrRtrId string NbrOptions int NbrPriority uint8 NbrState string NbrEvents int NbrLsRetransQLen int NbmaNbrPermanence int NbrHelloSuppressed bool NbrRestartHelperStatus int NbrRestartHelperAge uint32 NbrRestartHelperExitReason int }
type NssaTranslatorRole ¶
type NssaTranslatorRole int
const ( Always NssaTranslatorRole = 1 Candidate NssaTranslatorRole = 2 )
type NssaTranslatorState ¶
type NssaTranslatorState int
const ( NssaTranslatorEnabled NssaTranslatorState = 1 NssaTranslatorElected NssaTranslatorState = 2 NssaTranslatorDisabled NssaTranslatorState = 3 )
type OspfAreaLsaCountState ¶
type OspfAreaLsaCountState struct { AreaLsaCountAreaId AreaId AreaLsaCountLsaType LsaType AreaLsaCountNumber int }
Area LSA Counter Table Indexed By AreaLsaCountAreaId, AreaLsaCountLsaType
type OspfEventState ¶
type OspfIPv4Route ¶
type PositiveInteger ¶
type PositiveInteger int32 // 0x0 to 0x7fffffff
type RestartExitReason ¶
type RestartExitReason int
const ( NoAttempt RestartExitReason = 1 InProgress RestartExitReason = 2 Completed RestartExitReason = 3 TimeedOut RestartExitReason = 4 TopologyChanged RestartExitReason = 5 )
type RestartStatus ¶
type RestartStatus int
const ( NotRestarting RestartStatus = 1 PlannedRestart RestartStatus = 2 UnplannedRestart RestartStatus = 3 )
type RestartSupport ¶
type RestartSupport int
const ( None RestartSupport = 1 PlannedOnly RestartSupport = 2 PlannedAndUnplanned RestartSupport = 3 )
type StubAreaConf ¶
type StubAreaConf struct { StubAreaId AreaId StubTOS TosType StubMetric BigMetric StubMetricType MetricType }
Indexed by StubAreaId and StubTOS
type StubAreaState ¶
type StubAreaState struct { StubAreaId AreaId StubTOS TosType StubMetric BigMetric StubMetricType MetricType }
type UpToMaxAge ¶
type UpToMaxAge int // 0x0 to 3600
type VirtIfConf ¶
type VirtIfConf struct { VirtIfAreaId AreaId VirtIfNeighbor RouterId VirtIfTransitDelay UpToMaxAge VirtIfRetransInterval UpToMaxAge VirtIfHelloInterval HelloRange VirtIfRtrDeadInterval PositiveInteger VirtIfAuthKey string VirtIfAuthType AuthType }
Indexed By VirtIfAreaId, VirtIfNeighbor
type VirtIfState ¶
type VirtIfState struct { VirtIfAreaId AreaId VirtIfNeighbor RouterId VirtIfTransitDelay UpToMaxAge VirtIfRetransInterval UpToMaxAge VirtIfHelloInterval HelloRange VirtIfRtrDeadInterval PositiveInteger VirtIfState IfState VirtIfEvents int VirtIfAuthKey string VirtIfAuthType AuthType VirtIfLsaCount int VirtIfLsaCksumSum int }
type VirtLocalLsdbState ¶
type VirtLocalLsdbState struct { VirtLocalLsdbTransitArea AreaId VirtLocalLsdbNeighbor RouterId VirtLocalLsdbType LsaType VirtLocalLsdbLsid IpAddress VirtLocalLsdbRouterId RouterId VirtLocalLsdbSequence int VirtLocalLsdbAge int VirtLocalLsdbChecksum int VirtLocalLsdbAdvertisement string }
Link State Database, link-local for Virtual Links Indexed By VirtLocalLsdbTransitArea, VirtLocalLsdbTransitArea, VirtLocalLsdbType, VirtLocalLsdbLsid, VirtLocalLsdbRouterId
type VirtNbrState ¶
type VirtNbrState struct { VirtNbrArea AreaId VirtNbrRtrId RouterId VirtNbrIpAddress IpAddress VirtNbrOptions int VirtNbrState NbrState VirtNbrEvents int VirtNbrLsRetransQLen int VirtNbrHelloSuppressed bool VirtNbrRestartHelperStatus NbrRestartHelperStatus VirtNbrRestartHelperAge uint32 VirtNbrRestartHelperExitReason RestartExitReason }
Virtual Neighbor Table (Read Only) OSPF Virtual Neighbor Entry Indexed By VirtNbrArea, VirtNbrRtrId