ospf

Documentation

Overview

This YANG module defines the generic configuration data for OSPF, which is common across all of the vendor implementations of the protocol. It is intended that the module will be extended by vendors to define vendor-specific OSPF configuration parameters and policies, for example route maps or route policies.

Terms and Acronyms

OSPF (ospf): Open Shortest Path First

IP (ip): Internet Protocol

IPv4 (ipv4):Internet Protocol Version 4

IPv6 (ipv6): Internet Protocol Version 6

MTU (mtu) Maximum Transmission Unit

Index

• type AreaType
  • func (id AreaType) String() string
• type IfLinkType
  • func (id IfLinkType) String() string
• type IfLinkTypeNormal
  • func (id IfLinkTypeNormal) String() string
• type IfLinkTypeShamLink
  • func (id IfLinkTypeShamLink) String() string
• type IfLinkTypeVirtualLink
  • func (id IfLinkTypeVirtualLink) String() string
• type IfStateType
• type NbrStateType
• type Normal
  • func (id Normal) String() string
• type Nssa
  • func (id Nssa) String() string
• type NssaTranslatorStateType
• type OperationMode
  • func (id OperationMode) String() string
• type Ospf
  • func (id Ospf) String() string
• type Ospfv2
  • func (id Ospfv2) String() string
• type Ospfv3
  • func (id Ospfv3) String() string
• type PacketType
• type RestartExitReasonType
• type RestartHelperStatusType
• type RestartStatusType
• type ShipsInTheNight
  • func (id ShipsInTheNight) String() string
• type Stub
  • func (id Stub) String() string

Types

type AreaType

type AreaType struct {
}

func (AreaType) String

func (id AreaType) String() string

type IfLinkType

type IfLinkType struct {
}

func (IfLinkType) String

func (id IfLinkType) String() string

type IfLinkTypeNormal

type IfLinkTypeNormal struct {
}

func (IfLinkTypeNormal) String

func (id IfLinkTypeNormal) String() string

type IfLinkTypeShamLink

type IfLinkTypeShamLink struct {
}

func (IfLinkTypeShamLink) String

func (id IfLinkTypeShamLink) String() string

type IfLinkTypeVirtualLink

type IfLinkTypeVirtualLink struct {
}

func (IfLinkTypeVirtualLink) String

func (id IfLinkTypeVirtualLink) String() string

type IfStateType

type IfStateType string

IfStateType represents OSPF interface state type.

const (
	// Interface down state
	IfStateType_Down IfStateType = "Down"

	// Interface loopback state
	IfStateType_Loopback IfStateType = "Loopback"

	// Interface waiting state
	IfStateType_Waiting IfStateType = "Waiting"

	// Interface point-to-point state
	IfStateType_Point_to_Point IfStateType = "Point-to-Point"

	// Interface Designated Router (DR) state
	IfStateType_DR IfStateType = "DR"

	// Interface Backup Designated Router (BDR) state
	IfStateType_BDR IfStateType = "BDR"

	// Interface Other Designated Router state
	IfStateType_DR_Other IfStateType = "DR-Other"
)

type NbrStateType

type NbrStateType string

NbrStateType represents OSPF neighbor state type.

const (
	// Neighbor down state
	NbrStateType_Down NbrStateType = "Down"

	// Neighbor attempt state
	NbrStateType_Attempt NbrStateType = "Attempt"

	// Neighbor init state
	NbrStateType_Init NbrStateType = "Init"

	// Neighbor 2-Way state
	NbrStateType_Y_2_Way NbrStateType = "2-Way"

	// Neighbor exchange start state
	NbrStateType_ExStart NbrStateType = "ExStart"

	// Neighbor exchange state
	NbrStateType_Exchange NbrStateType = "Exchange"

	// Neighbor loading state
	NbrStateType_Loading NbrStateType = "Loading"

	// Neighbor full state
	NbrStateType_Full NbrStateType = "Full"
)

type Normal

type Normal struct {
}

func (Normal) String

func (id Normal) String() string

type Nssa

type Nssa struct {
}

func (Nssa) String

func (id Nssa) String() string

type NssaTranslatorStateType

type NssaTranslatorStateType string

NssaTranslatorStateType represents OSPF NSSA translator state type.

const (
	// NSSA translator enabled state.
	NssaTranslatorStateType_Enabled NssaTranslatorStateType = "Enabled"

	// NSSA translator elected state.
	NssaTranslatorStateType_Elected NssaTranslatorStateType = "Elected"

	// NSSA translator disabled state.
	NssaTranslatorStateType_Disabled NssaTranslatorStateType = "Disabled"
)

type OperationMode

type OperationMode struct {
}

func (OperationMode) String

func (id OperationMode) String() string

type Ospf

type Ospf struct {
}

func (Ospf) String

func (id Ospf) String() string

type Ospfv2

type Ospfv2 struct {
}

func (Ospfv2) String

func (id Ospfv2) String() string

type Ospfv3

type Ospfv3 struct {
}

func (Ospfv3) String

func (id Ospfv3) String() string

type PacketType

type PacketType string

PacketType represents OSPF packet type.

const (
	// OSPF hello packet.
	PacketType_Hello PacketType = "Hello"

	// OSPF database description packet.
	PacketType_Database_Descripton PacketType = "Database-Descripton"

	// OSPF link state request packet.
	PacketType_Link_State_Request PacketType = "Link-State-Request"

	// OSPF link state update packet.
	PacketType_Link_State_Update PacketType = "Link-State-Update"

	// OSPF link state acknowlegement packet.
	PacketType_Link_State_Ack PacketType = "Link-State-Ack"
)

type RestartExitReasonType

type RestartExitReasonType string

RestartExitReasonType represents as a helper.

const (
	// Not attempted.
	RestartExitReasonType_None RestartExitReasonType = "None"

	// Restart in progress.
	RestartExitReasonType_InProgress RestartExitReasonType = "InProgress"

	// Successfully completed.
	RestartExitReasonType_Completed RestartExitReasonType = "Completed"

	// Timed out.
	RestartExitReasonType_TimedOut RestartExitReasonType = "TimedOut"

	// Aborted due to topology change.
	RestartExitReasonType_TopologyChanged RestartExitReasonType = "TopologyChanged"
)

type RestartHelperStatusType

type RestartHelperStatusType string

RestartHelperStatusType represents Restart helper status type.

const (
	// Restart helper status not helping.
	RestartHelperStatusType_Not_Helping RestartHelperStatusType = "Not-Helping"

	// Restart helper status helping.
	RestartHelperStatusType_Helping RestartHelperStatusType = "Helping"
)

type RestartStatusType

type RestartStatusType string

RestartStatusType represents OSPF graceful restart status type.

const (
	// Router is not restarting.
	RestartStatusType_Not_Restarting RestartStatusType = "Not-Restarting"

	// Router is going through planned restart.
	RestartStatusType_Planned_Restart RestartStatusType = "Planned-Restart"

	// Router is going through unplanned restart.
	RestartStatusType_Unplanned_Restart RestartStatusType = "Unplanned-Restart"
)

type ShipsInTheNight

type ShipsInTheNight struct {
}

func (ShipsInTheNight) String

func (id ShipsInTheNight) String() string

type Stub

type Stub struct {
}

func (Stub) String

func (id Stub) String() string