openconfig-ospf-types

openconfig-version: 0.1.3

Description

Type definitions for OSPF

Imports

ietf-yang-types
openconfig-extensions

Defined types

ospf-area-identifier

description:
An identifier for an area with OSPF version 2 or 3. This value is expressed as either a dotted-quad, or a unsigned 32-bit number

type: union

    type: uint32

    type: yang:dotted-quad

ospf-metric

description:
A common type that can be utilised to express an OSPF metric

type: uint16

sr-sid-type

description:
A common type used to express the type of segment identifier that is used in LSDB entries relating to segment routing

type: enumeration

  • LABEL
    When the length of the SR/Label Sub-TLV is specified to be 3, then the right-most 20-bits represent a label value within the SR/Label Sub-TLV. When this leaf is set to a value of Label the first-entry leaf should be interpreted to be an MPLS label.
  • SID
    When the length of the SR/Label Sub-TLV is specified to be 4, then the value specified in the first-entry leaf should be specified to be a segment identifier.

Identities

base: OSPF_LSA_TYPE

description:
Base identity for an OSPF LSA type. This identity is intended to be used across both OSPFv2 and OSPFv3. Identity values that correspond to only one OSPF version are marked as such.

ROUTER_LSA

description:
Type 1 - ROUTER_LSA. An LSA originated by each router within the area describing the state and cost of the router's links in the area.

base identity: OSPF_LSA_TYPE

NETWORK_LSA

description:
Type 2 - NETWORK_LSA. An LSA originated for each broadcast and non-broadcast multiple access (NBMA) in the area. This LSA is originated by the designated router.

base identity: OSPF_LSA_TYPE

SUMMARY_IP_NETWORK_LSA

description:
Type 3 - SUMMARY_IP_NETWORK_LSA. An LSA originated by area border routers describing inter-area destinations. This LSA type is used when the destination is an IP network

base identity: OSPF_LSA_TYPE

SUMMARY_ASBR_LSA

description:
Type 4 - SUMMARY_ASBR_LSA. An LSA originated by an area border router describing inter-area destinations. This LSA type is used when the destination is an AS boundary router.

base identity: OSPF_LSA_TYPE

AS_EXTERNAL_LSA

description:
Type 5 - AS_EXTERNAL_LSA. This LSA type is used to describe destinations external to the autonomous system, and is originated by an AS boundary router (ASBR).

base identity: OSPF_LSA_TYPE

NSSA_AS_EXTERNAL_LSA

description:
Type 7 - NSSA_AS_EXTERNAL_LSA. This LSA type is used by systems within a not-so-stubby-area (NSSA) to inject external prefixes into the LSDB. They are translated to Type 5 LSAs at an ABR device.

base identity: OSPF_LSA_TYPE

description:
Type 9 - OSPFV2_LINK_SCOPE_OPAQUE_LSA. This LSA type is used in OSPFv2 to distribute arbitrary information via the OSPF protocol. The contents is specific to the application defining the Opaque Type specified within the LSDB. LSAs with Type 9 have a scope of the link that they are being transmitted on (and the associated network or subnetwork).

base identity: OSPF_LSA_TYPE

OSPFV2_AREA_SCOPE_OPAQUE_LSA

description:
Type 10 - OSPFV2_AREA_SCOPE_OPAQUE_LSA. This LSA type is used in OSPFv2 to distribute arbitrary information via the OSPF protocol. The contents is specific to the application defining the Opaque Type specified within the LSDB. LSAs with Type 10 have a scope of the area that they are transmitted within.

base identity: OSPF_LSA_TYPE

OSPFV2_AS_SCOPE_OPAQUE_LSA

description:
Type 11 - OSPFV2_AS_SCOPE_OPAQUE_LSA. This LSA type is used in OSPFv2 to distribute arbitrary information via the OSPF protocol. The contents is specific to the application defining the Opaque Type specified within the LSDB. LSAs with Type 11 have a scope of the autonomous system that they are transmitted within.

base identity: OSPF_LSA_TYPE

base: ROUTER_LSA_TYPES

description:
Sub-types of the router LSA

ROUTER_LSA_P2P

description:
The LSA represents a point-to-point connection to another router

base identity: ROUTER_LSA_TYPES

ROUTER_LSA_TRANSIT_NETWORK

description:
The LSA represents a connection to a transit network

base identity: ROUTER_LSA_TYPES

ROUTER_LSA_STUB_NETWORK

description:
The LSA represents a connection to a stub network

base identity: ROUTER_LSA_TYPES

description:
The LSA represents a virtual link connection

base identity: ROUTER_LSA_TYPES

base: OSPF_NEIGHBOR_STATE

description:
The state of an adjacency between the local system and a remote device

DOWN

description:
The initial state of a neighbor, indicating that no recent information has been received from the neighbor.

base identity: OSPF_NEIGHBOR_STATE

ATTEMPT

description:
Utilised for neighbors that are attached to NBMA networks, it indicates that no information has been recently received from the neighbor but that Hello packets should be directly sent to that neighbor.

base identity: OSPF_NEIGHBOR_STATE

INIT

description:
Indicates that a Hello packet has been received from the neighbor but bi-directional communication has not yet been established. That is to say that the local Router ID does not appear in the list of neighbors in the remote system's Hello packet.

base identity: OSPF_NEIGHBOR_STATE

TWO_WAY

description:
Communication between the local and remote system is bi-directional such that the local system's Router ID is listed in the received remote system's Hello packet.

base identity: OSPF_NEIGHBOR_STATE

EXSTART

description:
An adjacency with the remote system is being formed. The local system is currently transmitting empty database description packets in order to establish the master/slave relationship for the adjacency.

base identity: OSPF_NEIGHBOR_STATE

EXCHANGE

description:
The local and remote systems are currently exchanging database description packets in order to determine which elements of their local LSDBs are out of date.

base identity: OSPF_NEIGHBOR_STATE

LOADING

description:
The local system is sending Link State Request packets to the remote system in order to receive the more recently LSAs that were discovered during the Exchange phase of the procedure establishing the adjacency.

base identity: OSPF_NEIGHBOR_STATE

FULL

description:
The neighboring routers are fully adjacent such that both LSDBs are synchronized. The adjacency will appear in Router and Network LSAs

base identity: OSPF_NEIGHBOR_STATE

base: OSPF_NETWORK_TYPE

description:
Types of network that OSPF should consider attached to an interface

POINT_TO_POINT_NETWORK

description:
A interface that connects two routers.

base identity: OSPF_NETWORK_TYPE

BROADCAST_NETWORK

description:
An interface that supports >2 attached routers which has the ability to address all connected systems via a single (broadcast) address.

base identity: OSPF_NETWORK_TYPE

NON_BROADCAST_NETWORK

description:
An interface that supports >2 attached rotuers which does not have the ability to address all connected systems with a broadcast address.

base identity: OSPF_NETWORK_TYPE

base: OSPF_OPAQUE_LSA_TYPE

description:
This identity is the base used for opaque LSA types. The values that extend this base are those that are described in the IANA OSPF Opaque Link-State Advertisements (LSA) Option Types registry

TRAFFIC_ENGINEERING

description:
The Traffic Engineering LSA. This type is used only with area-scope Opaque LSAs - and is used to describe routers, point-to-point links and connections to multi-access networks for traffic engineering purposes.

base identity: OSPF_OPAQUE_LSA_TYPE

GRACE_LSA

description:
Grace LSAs are announced by a system undergoing graceful-restart. A system that is attempting an OSPF graceful restart announces Grace-LSAs with a specified grace period, indicating the intention to have completed an restart within the specified period.

base identity: OSPF_OPAQUE_LSA_TYPE

ROUTER_INFORMATION

description:
The Router Information LSA is used by an OSPFv2 system to announce optional capabilities of the local system, over and above those that are included within the OSPF hello message field. The flooding scope of the LSA can be link-, area-, or AS-wide (i.e., the LSA type can be 9, 10 or 11).

base identity: OSPF_OPAQUE_LSA_TYPE

OSPFV2_EXTENDED_PREFIX

description:
The Extended Prefix LSA is used in OSPFv2 to carry a set of attributes that are to be associated with a prefix that is advertised in OSPF. The attributes are carried as one or more TLV tuples. The flooding scope of the LSA can be link-, area-, or AS-wide as specified by the advertising system. The flooding scope of the LSA may exceed the scope of the corresponding prefix.

base identity: OSPF_OPAQUE_LSA_TYPE

description:
The Extended Link LSA is used in OSPFv2 to carry a set of attributes that are to be associated with a link that is advertised in OSPF. The link attributes are carried as one or more TLV tuples. The flooding scope of the link LSA is area-local - i.e., it is carried in a Type 10 opaque LSA.

base identity: OSPF_OPAQUE_LSA_TYPE

base: OSPF_TE_LSA_TLV_TYPE

description:
This identity is the base used for the type field of TLVs that are included within the Traffic Engineering Opaque LSA.

TE_ROUTER_ADDRESS

description:
A stable IP address of the advertising router that is always reachable if the node has connectivity.

base identity: OSPF_TE_LSA_TLV_TYPE

description:
A single link within a traffic engineering topology. A set of sub-TLVs are carried within this attribute to indicate traffic engineering characteristics of the link.

base identity: OSPF_TE_LSA_TLV_TYPE

TE_ROUTER_IPV6_ADDRESS

description:
A stable IPv6 address of the advertising router that is always reachable if the node has connectivity. This TLV is used only with OSPFv3

base identity: OSPF_TE_LSA_TLV_TYPE

description:
Attributes associated with the local link by the system.

base identity: OSPF_TE_LSA_TLV_TYPE

TE_NODE_ATTRIBUTE

description:
Attributes associted with the local system

base identity: OSPF_TE_LSA_TLV_TYPE

TE_OPTICAL_NODE_PROPERTY

description:
Attributes associated with the local optical node. A set of sub-TLVs are carried within this TLV which are used within the GMPLS control plane when using OSPF

base identity: OSPF_TE_LSA_TLV_TYPE

description:
This identity is the based used for the type field for sub-TLVs of the Link TLV of the OSPF Traffic Engineering Opaque LSA

description:
The OSPF-TE Link Type sub-TLV appears exactly once per OSPF-TE Link and describes the type of the link

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE Link ID sub-TLV appears exactly once per OSPF-TE link and identifies the remote end of the link.

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE Local IP specifies a list of the interface addresses of the local system corresponding to the traffic engineering link.

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE Remote IP specifies a list of IP addresses of the remote neighbors associated with the traffic engineering link.

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE Metric specifies the link metric for traffic engineering purposes

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE Maximum Bandwidth specifies the maximum bandwidth of the link that it is associated with.

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE Maximum Reservable Bandwidth specifies the maximum bandwidth that may be reserved on the link in bytes per second

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE unreserved bandwidth indicates the amount of bandwidth at each priority level that is currently not reserved

base identity: OSPF_TE_LINK_TLV_TYPE

description:
The OSPF-TE administrative group indicates the administrative group that the is assigned to the interface

base identity: OSPF_TE_LINK_TLV_TYPE

base: TE_NODE_ATTRIBUTE_TLV_TYPE

description:
This identity forms the base for sub-TLVs of the Node Attribute TLV of the Traffic Engineering LSA

NODE_IPV4_LOCAL_ADDRESS

description:
The Node Attribute Sub-TLV contains a list of the IPv4 addresses of the local system

base identity: TE_NODE_ATTRIBUTE_TLV_TYPE

NODE_IPV6_LOCAL_ADDRESS

description:
The Node Attribute Sub-TLV contains a list of the IPv6 addresses of the local system

base identity: TE_NODE_ATTRIBUTE_TLV_TYPE

base: GRACE_LSA_TLV_TYPES

description:
This identity is used as the base for TLVs within the Grace LSA

GRACE_PERIOD

description:
This sub-TLV describes the period for which adjacencies should be maintained with the restarting system

base identity: GRACE_LSA_TLV_TYPES

GRACE_RESTART_REASON

description:
This sub-TLV describes the reason for the OSPF restart of the system that is restarting

base identity: GRACE_LSA_TLV_TYPES

GRACE_IP_INTERFACE_ADDRESS

description:
This sub-TLV specifies the restarting system's IP address on the interface via which it is advertising the Grace LSA

base identity: GRACE_LSA_TLV_TYPES

base: RI_LSA_TLV_TYPES

description:
This identity is used as the base for the TLVs within the Router Information LSA

RI_INFORMATIONAL_CAPABILITIES

description:
Informational capabilities of the advertising system

base identity: RI_LSA_TLV_TYPES

RI_FUNCTIONAL_CAPABILITIES

description:
Functional capabilities of the advertising system

base identity: RI_LSA_TLV_TYPES

RI_NODE_ADMIN_TAG

description:
Operator-defined administrative tags associated with the advertising system

base identity: RI_LSA_TLV_TYPES

RI_SR_SID_LABEL_RANGE

description:
SID or Label ranges for use with segment routing when forwarding to the advertising system

base identity: RI_LSA_TLV_TYPES

RI_SR_ALGORITHM

description:
The algorithms that are supported for segment routing by the advertising system

base identity: RI_LSA_TLV_TYPES

base: SR_ALGORITHM

description:
This identity is used as a base for the algorithms that can be supported for segment routing and are advertised by a system in the RI LSA

SPF

description:
The standard shortest path algorithm based on link metric, as used by the OSPF protocol

base identity: SR_ALGORITHM

STRICT_SPF

description:
The standard shortest path algorithm based on link metric, with the requirement that all nodes along the path honor the SPF decision. That is to say that the SPF decision cannot be altered by local policy at the node

base identity: SR_ALGORITHM

base: OSPF_RI_SR_SID_LABEL_TLV_TYPES

description:
This identity is used as a base for the sub-TLVs of the Segment Routing SID/Label Range TLV

SR_SID_LABEL_TLV

description:
A range of SID/Label values used by the local system

base identity: OSPF_RI_SR_SID_LABEL_TLV_TYPES

description:
OSPFv2 Router Link Types as per the IANA registry defined in RFC2740

description:
The link is a point-to-point connection to another router

base identity: OSPFV2_ROUTER_LINK_TYPE

description:
The link is a connection to a transit network

base identity: OSPFV2_ROUTER_LINK_TYPE

description:
The link is a connection to a stub network

base identity: OSPFV2_ROUTER_LINK_TYPE

description:
The link is a virtual connection to another router

base identity: OSPFV2_ROUTER_LINK_TYPE

base: OSPFV2_EXTENDED_PREFIX_SUBTLV_TYPE

description:
Sub-TLVs of the OSPFv2 Extended Prefix LSA as defined by RFC7684

EXTENDED_PREFIX_RANGE

description:
The attributes being described relate to a range of prefixes

base identity: OSPFV2_EXTENDED_PREFIX_SUBTLV_TYPE

PREFIX_SID

description:
The TLV describes a Segment Routing Prefix Segment Identifier associated with a prefix

base identity: OSPFV2_EXTENDED_PREFIX_SUBTLV_TYPE

SID_LABEL_BINDING

description:
The TLV describes a binding of a SID to a path to the prefix, which may have associated path characteristics

base identity: OSPFV2_EXTENDED_PREFIX_SUBTLV_TYPE

base: OSPFV2_EXTENDED_PREFIX_SID_LABEL_BINDING_SUBTLV_TYPE

description:
Sub-TLV types carried in the SID/Label Binding Sub-TLV of the Extended Prefix Sub-TLV

SID_MPLS_LABEL_BINDING

description:
This sub-TLV indicates a binding between an SR SID and an MPLS label and must be present in the sub-TLV

base identity: OSPFV2_EXTENDED_PREFIX_SID_LABEL_BINDING_SUBTLV_TYPE

ERO_METRIC

description:
This sub-TLV indicates the cost of the ERO path being advertised in the SID/Label TLV

base identity: OSPFV2_EXTENDED_PREFIX_SID_LABEL_BINDING_SUBTLV_TYPE

ERO_PATH

description:
This sub-TLV indicates the path associated with an ERO being advertised in the SID/Label TLV

base identity: OSPFV2_EXTENDED_PREFIX_SID_LABEL_BINDING_SUBTLV_TYPE

base: OSPFV2_EXTPREFIX_BINDING_ERO_PATH_SEGMENT_TYPE

description:
The types of segment included within an ERO Path described within the SID/Label binding sub-TLV

IPV4_SEGMENT

description:
The segment is specified as an IPv4 address

base identity: OSPFV2_EXTPREFIX_BINDING_ERO_PATH_SEGMENT_TYPE

UNNUMBERED_INTERFACE_SEGMENT

description:
The segment is specified as an unnumbered interface of a remote system

base identity: OSPFV2_EXTPREFIX_BINDING_ERO_PATH_SEGMENT_TYPE

description:
Sub-TLVs of the Extended Link TLV for OSPFv2

ADJACENCY_SID

description:
The extended link sub-TLV indicates an Adjacency SID

base identity: OSPFV2_EXTENDED_LINK_SUBTLV_TYPE

base: MAX_METRIC_TRIGGER

description:
Triggers which cause the maximum metric to be set for entities advertised in OSPF

MAX_METRIC_ON_SYSTEM_BOOT

description:
Set the maximum metric when the system boots.

base identity: MAX_METRIC_TRIGGER

base: MAX_METRIC_INCLUDE

description:
Entities that may optionally be included when advertising the maximum metric.

MAX_METRIC_INCLUDE_STUB

description:
Include stub networks when advertising the maximum metric.

base identity: MAX_METRIC_INCLUDE

MAX_METRIC_INCLUDE_TYPE2_EXTERNAL

description:
Include OSPF Type 2 external routes when advertising the maximum metric.

base identity: MAX_METRIC_INCLUDE

Data elements

openconfig-ospfv2

openconfig-version: 0.4.0

Description

An OpenConfig model for Open Shortest Path First (OSPF) version 2

Imports

openconfig-extensions

Data elements