This module contains general data definitions for use in routing policy. It can be imported by modules that contain protocol- specific policy conditions and actions.
ietf-yang-types
openconfig-extensions
openconfig-yang-types
description:
Options that govern the behavior of a match statement. The
default behavior is ANY, i.e., the given value matches any
of the members of the defined set
type: enumeration
default: ANY
description:
Options that govern the behavior of a match statement. The
default behavior is ANY, i.e., the given value matches any
of the members of the defined set. Note this type is a
restricted version of the match-set-options-type.
type: enumeration
default: ANY
description:
Type for expressing route tags on a local system, including IS-IS
and OSPF; This may be expressed as either decimal or hexidecimal
integer.
type: union
type: uint32
type: yang:hex-string
type: oc-yang:hex-string-prefixed
description:
base type for supported comparison operators on route
attributes
description:
== comparison
base identity: ATTRIBUTE_COMPARISON
description:
>= comparison
base identity: ATTRIBUTE_COMPARISON
description:
<= comparison
base identity: ATTRIBUTE_COMPARISON
description:
Base type for routing protocols, including those which may
install prefixes into the RIB
description:
BGP
base identity: INSTALL_PROTOCOL_TYPE
description:
IS-IS
base identity: INSTALL_PROTOCOL_TYPE
description:
OSPFv2
base identity: INSTALL_PROTOCOL_TYPE
description:
OSPFv3
base identity: INSTALL_PROTOCOL_TYPE
description:
Locally-installed static route
base identity: INSTALL_PROTOCOL_TYPE
description:
A directly connected route
base identity: INSTALL_PROTOCOL_TYPE
description:
Locally defined aggregate route
base identity: INSTALL_PROTOCOL_TYPE
description:
Protocol Independent Multicast
base identity: INSTALL_PROTOCOL_TYPE
description:
Internet Group Management Protocol
base identity: INSTALL_PROTOCOL_TYPE
description:
gRPC Routing Information Base Interface
base identity: INSTALL_PROTOCOL_TYPE
description:
Path Computation Element Communication Protocol
base identity: INSTALL_PROTOCOL_TYPE
description:
A local route.
Local routes define a route for the one specific IP
address configured on the router interface. They are
created in association with directly connected routes.
Local routes must end with a /32 in the case of ipv4
or /128 for ipv6.
For example, when configuring an interface with the ip
address
10.244.136.79/31
the derived DIRECTLY_CONNECTED route is
10.244.136.78/31
and the derived LOCAL route is
10.244.136.79/32.
base identity: INSTALL_PROTOCOL_TYPE
This module contains general data definitions for use in BGP policy. It can be imported by modules that make use of BGP attributes
openconfig-types
openconfig-inet-types
openconfig-extensions
description:
Type to describe the direction of NLRI transmission
type: enumeration
description:
Type definition for well-known IETF community attribute
values
type: identityref
description:
Type definition for standard commmunity attributes represented as
a integer value, or a string of the form N:M where N and M are
integers between 0 and 65535.
type: union
type: uint32
type: string
description:
Type definition for extended community attributes. In the case that
common communities are utilised, they are represented as a string
of the form:
- <2b AS>:<4b value> per RFC4360 section 3.1
- <4b IPv4>:<2b value> per RFC4360 section 3.2
- <4b AS>:<2b value> per RFC5668 section 2.
- route-target:<2b AS>:<4b value> per RFC4360 section 4
- route-target:<4b IPv4>:<2b value> per RFC4360 section 4
- route-origin:<2b ASN>:<4b value> per RFC4360 section 5
- route-origin:<4b IPv4>:<2b value> per RFC4360 section 5
- color:
type: union
type: string
type: string
type: string
type: string
type: string
type: string
type: string
type: string
type: string
type: string
type: string
description:
A type definition utilised to define the extended community
in a context where the system is receiving the extended
community from an external source, such that the value may be
unknown. In the case that the received extended community is
unknown it is defined to be a 8-octet quantity formatted
according to RFC4360:
Type Field: 1 or 2 octets.
Value Field: Remaining octets.
The high-order octet of the type field is encoded such that
bit 0 indicates whether the extended community type is IANA
assigned; and bit 1 indicates whether the extended community
is transitive. The remaining bits of the high-order type
field must be interpreted to determine whether the low-order
type field should be parsed, or whether the entire remainder
of the extended community is a value.
type: union
type: bgp-ext-community-type
type: binary
description:
Type definition for communities specified as regular
expression patterns. The regular expression must be a
POSIX extended regular expression with some limitations
which are commonly found in device implementations described
in draft-ietf-idr-bgp-model.
type: oc-types:posix-eregexp
description:
Type definition for standard BGP origin attribute
type: enumeration
description:
Labels a peer or peer group as explicitly internal or
external
type: enumeration
description:
Set of options for configuring how private AS path numbers
are removed from advertisements
type: identityref
description:
Union type for route reflector cluster ids:
option 1: 4-byte number
option 2: IP address
type: union
type: uint32
type: oc-inet:ipv4-address
description:
type describing variations of community attributes:
STANDARD: standard BGP community [rfc1997]
EXTENDED: extended BGP community [rfc4360]
LARGE: large BGP community [rfc8092]
type: enumeration
description:
Defines the types of BGP AS path segments.
type: enumeration
description:
Base identity for a BGP capability
description:
Multi-protocol extensions to BGP
base identity: BGP_CAPABILITY
description:
The BGP route-refresh functionality
base identity: BGP_CAPABILITY
description:
4-byte (32-bit) AS number functionality
base identity: BGP_CAPABILITY
description:
Graceful restart functionality
base identity: BGP_CAPABILITY
description:
BGP add-paths
base identity: BGP_CAPABILITY
description:
BGP Extended Next Hop Encoding functionality
base identity: BGP_CAPABILITY
description:
Base identity type for AFI,SAFI tuples for BGP-4
description:
IPv4 unicast (AFI,SAFI = 1,1)
base identity: AFI_SAFI_TYPE
description:
IPv6 unicast (AFI,SAFI = 2,1)
base identity: AFI_SAFI_TYPE
description:
Labeled IPv4 unicast (AFI,SAFI = 1,4)
base identity: AFI_SAFI_TYPE
description:
Labeled IPv6 unicast (AFI,SAFI = 2,4)
base identity: AFI_SAFI_TYPE
description:
Unicast IPv4 MPLS L3VPN (AFI,SAFI = 1,128)
base identity: AFI_SAFI_TYPE
description:
Unicast IPv6 MPLS L3VPN (AFI,SAFI = 2,128)
base identity: AFI_SAFI_TYPE
description:
Multicast IPv4 MPLS L3VPN (AFI,SAFI = 1,129)
base identity: AFI_SAFI_TYPE
description:
Multicast IPv6 MPLS L3VPN (AFI,SAFI = 2,129)
base identity: AFI_SAFI_TYPE
description:
BGP-signalled VPLS (AFI,SAFI = 25,65)
base identity: AFI_SAFI_TYPE
description:
BGP MPLS Based Ethernet VPN (AFI,SAFI = 25,70)
base identity: AFI_SAFI_TYPE
description:
Segment Routing Traffic Engineering (SRTE) Policy
for IPv4 (AFI,SAFI = 1,73)
base identity: AFI_SAFI_TYPE
description:
Segment Routing Traffic Engineering (SRTE) Policy
for IPv6 (AFI,SAFI = 2,73)
base identity: AFI_SAFI_TYPE
description:
IPv4 dissemination of flow specification rules
(AFI,SAFI = 1,133)
base identity: AFI_SAFI_TYPE
description:
IPv4 dissemination of flow specification rules
(AFI,SAFI = 1,134)
base identity: AFI_SAFI_TYPE
description:
BGP-LS (AFI,SAFI = 16388,71)
base identity: AFI_SAFI_TYPE
description:
BGP-LS-VPN (AFI,SAFI = 16388,72)
base identity: AFI_SAFI_TYPE
description:
BGP-LS SPF (AFI,SAFI = 16388,TBD)
base identity: AFI_SAFI_TYPE
description:
Reserved communities within the standard community space
defined by RFC1997. These communities must fall within the
range 0x00000000 to 0xFFFFFFFF
description:
Do not export NLRI received carrying this community outside
the bounds of this autonomous system, or this confederation if
the local autonomous system is a confederation member AS. This
community has a value of 0xFFFFFF01.
base identity: BGP_WELL_KNOWN_STD_COMMUNITY
description:
All NLRI received carrying this community must not be
advertised to other BGP peers. This community has a value of
0xFFFFFF02.
base identity: BGP_WELL_KNOWN_STD_COMMUNITY
description:
All NLRI received carrying this community must not be
advertised to external BGP peers - including over confederation
sub-AS boundaries. This community has a value of 0xFFFFFF03.
base identity: BGP_WELL_KNOWN_STD_COMMUNITY
description:
An autonomous system receiving NLRI tagged with this community
is advised not to readvertise the NLRI to external bi-lateral
peer autonomous systems. An AS may also filter received NLRI
from bilateral peer sessions when they are tagged with this
community value
base identity: BGP_WELL_KNOWN_STD_COMMUNITY
description:
An autonomous system which supports the graceful shutdown
receiver procedure receiving NLRI tagged with this community
will set LOCAL_PREF to a low value for those NLRI. This
community has a value of 0xFFFF0000.
base identity: BGP_WELL_KNOWN_STD_COMMUNITY
description:
Base identity for options for removing private autonomous
system numbers from the AS_PATH attribute
description:
Strip all private autonmous system numbers from the AS_PATH.
This action is performed regardless of the other content of the
AS_PATH attribute, and for all instances of private AS numbers
within that attribute.
base identity: REMOVE_PRIVATE_AS_OPTION
description:
Replace all instances of private autonomous system numbers in
the AS_PATH with the local BGP speaker's autonomous system
number. This action is performed regardless of the other
content of the AS_PATH attribute, and for all instances of
private AS number within that attribute.
base identity: REMOVE_PRIVATE_AS_OPTION
description:
Indicates the error type in a BGP NOTIFICATION message
description:
Errors detected while processing the Message Header
base identity: BGP_ERROR_CODE
description:
Errors detected while processing the OPEN message
base identity: BGP_ERROR_CODE
description:
Errors detected while processing the UPDATE message
base identity: BGP_ERROR_CODE
description:
Indicates that the system did not receive successive
KEEPALIVE, UPDATE, and/or NOTIFICATION messages within the
period specified in the Hold Time field of the OPEN message
base identity: BGP_ERROR_CODE
description:
Error detected by the BGP Finite State Machine
(e.g., receipt of an unexpected event)
base identity: BGP_ERROR_CODE
description:
Sent by a BGP peer to close its BGP connection in absence of
any fatal errors. If the BGP speaker terminates its
connection with a neihbor because the number of prefixes
received exceeds the configured upper bound, the speaker must
send the neighbor a NOTIFICATION message with the Cease
error code.
base identity: BGP_ERROR_CODE
description:
The length, excluding the fixed-size message header, of the
received ROUTE-REFRESH message with Message Subtype 1 and 2 is
not 4. Applicable only when a BGP speaker has received the
'Enhanced Route Refresh Capability' from a peer
base identity: BGP_ERROR_CODE
description:
Provides more specific information about the nature of the
error reported in a NOTIFICATION message. Each Error
Code may have one or more Error Subcodes associated with it.
description:
The error subcode field is unspecific when the NOTIFICATION
message does not include any specific error subcode (i.e..,
value 0).
base identity: BGP_ERROR_SUBCODE
description:
Error subcode definitions for Message Header error
notifications
base identity: BGP_ERROR_SUBCODE
description:
Error subcode definitions for OPEN message error
notifications
base identity: BGP_ERROR_SUBCODE
description:
Error subcode definitions for UPDATE message error
notifications
base identity: BGP_ERROR_SUBCODE
description:
Error subcode definitions for BGP finite state machine
errors.
base identity: BGP_ERROR_SUBCODE
description:
Error subcode definitions for Cease notification messages
base identity: BGP_ERROR_SUBCODE
description:
Error subcode definitions for the ROUTE-REFRESH message
error
base identity: BGP_ERROR_SUBCODE
This module contains general data definitions for use in ISIS YANG model.
openconfig-extensions
description:
This type defines ISIS level types
type: enumeration
description:
This type defines ISIS level.
type: uint8
description:
This type defines ISIS adaptive timer types
type: enumeration
description:
This type defines ISIS hello padding type
type: enumeration
description:
This type defines ISIS interface types
type: enumeration
description:
This type defines ISIS metric type
type: enumeration
description:
This type defines ISIS wide metric.
type: uint32
description:
This type defines ISIS narrow metric.
type: uint8
description:
This type defines ISIS metric styles
type: enumeration
description:
This type defines the state of the interface.
type: enumeration
description:
This type defines OSI NET address. A NET should should be in
the form xx.yyyy.yyyy.yyyy.00 with up to 9 sets of yyyy.
type: string
description:
This type defines the ISIS area address.
type: string
description:
This type defines ISIS system id using pattern, system id looks
like : 0143.0438.AeF0
type: string
description:
This type defines interface circuit ID.
type: uint32
description:
This type defines ISIS LSP ID. ISIS LSP ID type should be in
the form of xxxx.xxxx.xxxx.xx-xx
type: string
description:
This type defines Subnetwork Point of Attachment format.
type: string
description:
Base identify type for triggers that reset Overload Bit
description:
Base identity type for resetting Overload Bit when BGP has converged.
base identity: OVERLOAD_RESET_TRIGGER_TYPE
description:
Base identity type for resetting Overload Bit when system resources have
been restored.
base identity: OVERLOAD_RESET_TRIGGER_TYPE
description:
Base identify type for multi-topology
description:
Base identify type for SAFI
description:
Base identify type for IPv4 Unicast address family
base identity: SAFI_TYPE
description:
Base identify type for IPv6 multicast address family
base identity: SAFI_TYPE
description:
Base identify type for AFI
description:
Base identify type for IPv4 address family
base identity: AFI_TYPE
description:
Base identify type for IPv6 address family
base identity: AFI_TYPE
description:
Base identify type for AFI/SAFI
description:
Base identify type for IPv4 Unicast address family
base identity: AFI_SAFI_TYPE
description:
Base identify type for IPv6 multicast address family
base identity: AFI_SAFI_TYPE
description:
Base identify type for IPv4 multicast address family
base identity: AFI_SAFI_TYPE
description:
Base identify type for IPv6 unicast address family
base identity: AFI_SAFI_TYPE
description:
Base identify to define the authentication mode
description:
Simple Text Authentication
base identity: AUTH_MODE
description:
HMAC-MD5 Authentication
base identity: AUTH_MODE
Type definitions for OSPF
ietf-yang-types
openconfig-extensions
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
description:
A common type that can be utilised to express an OSPF metric
type: uint16
description:
A common type used to express the type of segment identifier that is
used in LSDB entries relating to segment routing
type: enumeration
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.
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
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
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
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
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
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
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
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
description:
Sub-types of the router LSA
description:
The LSA represents a point-to-point connection to another
router
base identity: ROUTER_LSA_TYPES
description:
The LSA represents a connection to a transit network
base identity: ROUTER_LSA_TYPES
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
description:
The state of an adjacency between the local system and a remote
device
description:
The initial state of a neighbor, indicating that no recent
information has been received from the neighbor.
base identity: OSPF_NEIGHBOR_STATE
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
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
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
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
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
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
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
description:
Types of network that OSPF should consider attached to an
interface
description:
A interface that connects two routers.
base identity: OSPF_NETWORK_TYPE
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
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
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
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
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
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
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
description:
This identity is the base used for the type field of TLVs that are
included within the Traffic Engineering Opaque LSA.
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
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
description:
Attributes associted with the local system
base identity: OSPF_TE_LSA_TLV_TYPE
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
description:
This identity forms the base for sub-TLVs of the Node Attribute TLV
of the Traffic Engineering LSA
description:
The Node Attribute Sub-TLV contains a list of the IPv4 addresses of
the local system
base identity: TE_NODE_ATTRIBUTE_TLV_TYPE
description:
The Node Attribute Sub-TLV contains a list of the IPv6 addresses of
the local system
base identity: TE_NODE_ATTRIBUTE_TLV_TYPE
description:
This identity is used as the base for TLVs within the Grace LSA
description:
This sub-TLV describes the period for which adjacencies should be
maintained with the restarting system
base identity: GRACE_LSA_TLV_TYPES
description:
This sub-TLV describes the reason for the OSPF restart of the system
that is restarting
base identity: GRACE_LSA_TLV_TYPES
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
description:
This identity is used as the base for the TLVs within the Router
Information LSA
description:
Informational capabilities of the advertising system
base identity: RI_LSA_TLV_TYPES
description:
Functional capabilities of the advertising system
base identity: RI_LSA_TLV_TYPES
description:
Operator-defined administrative tags associated with the advertising
system
base identity: RI_LSA_TLV_TYPES
description:
SID or Label ranges for use with segment routing when forwarding to
the advertising system
base identity: RI_LSA_TLV_TYPES
description:
The algorithms that are supported for segment routing by the
advertising system
base identity: RI_LSA_TLV_TYPES
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
description:
The standard shortest path algorithm based on link metric,
as used by the OSPF protocol
base identity: SR_ALGORITHM
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
description:
This identity is used as a base for the sub-TLVs of the Segment
Routing SID/Label Range 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
description:
Sub-TLVs of the OSPFv2 Extended Prefix LSA as defined by
RFC7684
description:
The attributes being described relate to a range of prefixes
base identity: OSPFV2_EXTENDED_PREFIX_SUBTLV_TYPE
description:
The TLV describes a Segment Routing Prefix Segment Identifier
associated with a prefix
base identity: OSPFV2_EXTENDED_PREFIX_SUBTLV_TYPE
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
description:
Sub-TLV types carried in the SID/Label Binding Sub-TLV of
the Extended Prefix Sub-TLV
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
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
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
description:
The types of segment included within an ERO Path described
within the SID/Label binding sub-TLV
description:
The segment is specified as an IPv4 address
base identity: OSPFV2_EXTPREFIX_BINDING_ERO_PATH_SEGMENT_TYPE
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
description:
The extended link sub-TLV indicates an Adjacency SID
base identity: OSPFV2_EXTENDED_LINK_SUBTLV_TYPE
description:
Triggers which cause the maximum metric to be set for
entities advertised in OSPF
description:
Set the maximum metric when the system boots.
base identity: MAX_METRIC_TRIGGER
description:
Entities that may optionally be included when advertising
the maximum metric.
description:
Include stub networks when advertising the maximum metric.
base identity: MAX_METRIC_INCLUDE
description:
Include OSPF Type 2 external routes when advertising
the maximum metric.
base identity: MAX_METRIC_INCLUDE
This module describes a YANG model for routing policy configuration. It is a limited subset of all of the policy configuration parameters available in the variety of vendor implementations, but supports widely used constructs for managing how routes are imported, exported, and modified across different routing protocols. This module is intended to be used in conjunction with routing protocol configuration models (e.g., BGP) defined in other modules.
Route policy expression:
Policies are expressed as a set of top-level policy definitions, each of which consists of a sequence of policy statements. Policy statements consist of simple condition-action tuples. Conditions may include mutiple match or comparison operations, and similarly actions may be multitude of changes to route attributes or a final disposition of accepting or rejecting the route.
Route policy evaluation:
Policy definitions are referenced in routing protocol configurations using import and export configuration statements. The arguments are members of an ordered list of named policy definitions which comprise a policy chain, and optionally, an explicit default policy action (i.e., reject or accept).
Evaluation of each policy definition proceeds by evaluating its corresponding individual policy statements in order. When a condition statement in a policy statement is satisfied, the corresponding action statement is executed. If the action statement has a final disposition configured as policy result, either accept-route or reject-route, evaluation of the current policy definition stops, and no further policy statements are evaluated. In case there is a policy chain, no further policy definitions in the chain are evaluated.
If the action statement has the NEXT_STATEMENT policy result, all the defined actions are executed and policy evaluation proceeds to the next statement. The NEXT_STATEMENT is the default policy result action.
If the condition is not satisfied, then evaluation proceeds to the next policy statement. If none of the policy statement conditions are satisfied, then evaluation of the current policy definition stops, and the next policy definition in the chain is evaluated. When the end of the policy chain is reached, the default route disposition action is performed (i.e., reject-route unless an an alternate default action is specified for the chain).
Policy 'subroutines' (or nested policies) are supported by allowing policy statement conditions to reference another policy definition which applies conditions and actions from the referenced policy before returning to the calling policy statement and resuming evaluation. If the called policy results in an accept-route (either explicit or by default), then the subroutine returns an effective true value to the calling policy. Similarly, a reject-route action returns false. If the subroutine returns true, the calling policy continues to evaluate the remaining conditions (using a modified route if the subroutine performed any changes to the route).
If a routing protocol is defined and the related apply-policy/default-(import|export)-policy leaf is not set, the default value for the default-(import|export)-policy leaf must be applied. See RFC6020 7.6.1 which applies to this model.
openconfig-inet-types
openconfig-interfaces
openconfig-policy-types
openconfig-extensions
description:
Type used to specify route disposition in
a policy chain
type: enumeration
description:
Type used to specify route disposition in
a policy chain
type: enumeration
default: NEXT_STATEMENT
description:
Top-level container for all routing policy configuration
nodetype: container (rw)
description:
Predefined sets of attributes used in policy match
statements
nodetype: container (rw)
description:
Enclosing container
nodetype: container (rw)
description:
List of the defined prefix sets
nodetype: list (rw)
list keys: [name]
description:
Reference to prefix name list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for prefix sets
nodetype: container (rw)
description:
name / label of the prefix set -- this is used to
reference the set in match conditions
nodetype: leaf (rw)
type: string
description:
Indicates the mode of the prefix set, in terms of which
address families (IPv4, IPv6, or both) are present. The
mode provides a hint, but the device must validate that all
prefixes are of the indicated type, and is expected to
reject the configuration if there is a discrepancy. The
MIXED mode may not be supported on devices that require
prefix sets to be of only one address family.
nodetype: leaf (rw)
type: enumeration
description:
Operational state data
nodetype: container (ro)
description:
name / label of the prefix set -- this is used to
reference the set in match conditions
nodetype: leaf (ro)
type: string
description:
Indicates the mode of the prefix set, in terms of which
address families (IPv4, IPv6, or both) are present. The
mode provides a hint, but the device must validate that all
prefixes are of the indicated type, and is expected to
reject the configuration if there is a discrepancy. The
MIXED mode may not be supported on devices that require
prefix sets to be of only one address family.
nodetype: leaf (ro)
type: enumeration
description:
Enclosing container for the list of prefixes in a policy
prefix list
nodetype: container (rw)
description:
List of prefixes in the prefix set
nodetype: list (rw)
list keys: [ip-prefix] [masklength-range]
description:
Reference to the ip-prefix list key.
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to the masklength-range list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for prefix definition
nodetype: container (rw)
description:
The prefix member in CIDR notation -- while the
prefix may be either IPv4 or IPv6, most
implementations require all members of the prefix set
to be the same address family. Mixing address types in
the same prefix set is likely to cause an error.
nodetype: leaf (rw)
type: oc-inet:ip-prefix
description:
Defines a range for the masklength, or 'exact' if
the prefix has an exact length.
Example: 10.3.192.0/21 through 10.3.192.0/24 would be
expressed as prefix: 10.3.192.0/21,
masklength-range: 21..24.
Example: 10.3.192.0/21 would be expressed as
prefix: 10.3.192.0/21,
masklength-range: exact
nodetype: leaf (rw)
type: string
description:
Operational state data for prefix definition
nodetype: container (ro)
description:
The prefix member in CIDR notation -- while the
prefix may be either IPv4 or IPv6, most
implementations require all members of the prefix set
to be the same address family. Mixing address types in
the same prefix set is likely to cause an error.
nodetype: leaf (ro)
type: oc-inet:ip-prefix
description:
Defines a range for the masklength, or 'exact' if
the prefix has an exact length.
Example: 10.3.192.0/21 through 10.3.192.0/24 would be
expressed as prefix: 10.3.192.0/21,
masklength-range: 21..24.
Example: 10.3.192.0/21 would be expressed as
prefix: 10.3.192.0/21,
masklength-range: exact
nodetype: leaf (ro)
type: string
description:
Enclosing container for the list of neighbor set
definitions
nodetype: container (rw)
description:
List of defined neighbor sets for use in policies.
nodetype: list (rw)
list keys: [name]
description:
Reference to the neighbor set name list key.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for neighbor sets.
nodetype: container (rw)
description:
name / label of the neighbor set -- this is used to
reference the set in match conditions
nodetype: leaf (rw)
type: string
description:
List of IP addresses in the neighbor set
nodetype: leaf-list (rw)
type: oc-inet:ip-address
description:
Operational state data for neighbor sets.
nodetype: container (ro)
description:
name / label of the neighbor set -- this is used to
reference the set in match conditions
nodetype: leaf (ro)
type: string
description:
List of IP addresses in the neighbor set
nodetype: leaf-list (ro)
type: oc-inet:ip-address
description:
Enclosing container for the list of tag sets.
nodetype: container (rw)
description:
List of tag set definitions.
nodetype: list (rw)
list keys: [name]
description:
Reference to the tag set name list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for tag sets
nodetype: container (rw)
description:
name / label of the tag set -- this is used to reference
the set in match conditions
nodetype: leaf (rw)
type: string
description:
Value of the tag set member
nodetype: leaf-list (rw)
type: oc-pol-types:tag-type
description:
Operational state data for tag sets
nodetype: container (ro)
description:
name / label of the tag set -- this is used to reference
the set in match conditions
nodetype: leaf (ro)
type: string
description:
Value of the tag set member
nodetype: leaf-list (ro)
type: oc-pol-types:tag-type
description:
BGP-related set definitions for policy match conditions
nodetype: container (rw)
description:
Enclosing container for list of defined BGP community sets
nodetype: container (rw)
description:
List of defined BGP community sets
nodetype: list (rw)
list keys: [community-set-name]
description:
Reference to list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for BGP community sets
nodetype: container (rw)
description:
name / label of the community set -- this is used to
reference the set in match conditions
nodetype: leaf (rw)
type: string
description:
Members of the community set.
For an ADD operation these are the communities that will be
added. The regexp type is not valid in this operation.
For REMOVE or REPLACE operations then matching communities will
be removed unless match-set-options is INVERT which will
reverse this to mean that anything that does not match will be
removed.
For MATCH operations the posix-eregexp type should be evaluated
against each community associated with a prefix one community
at a time. Communities must be represented as strings in formats
conforming to oc-bgp-types:bgp-std-community-type. For example:
`1000:1000` for a standard community
nodetype: leaf-list (rw)
type: union
type: oc-bgp-types:bgp-std-community-type
type: oc-bgp-types:bgp-community-regexp-type
type: oc-bgp-types:bgp-well-known-community-type
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-type
description:
Operational state data for BGP community sets
nodetype: container (ro)
description:
name / label of the community set -- this is used to
reference the set in match conditions
nodetype: leaf (ro)
type: string
description:
Members of the community set.
For an ADD operation these are the communities that will be
added. The regexp type is not valid in this operation.
For REMOVE or REPLACE operations then matching communities will
be removed unless match-set-options is INVERT which will
reverse this to mean that anything that does not match will be
removed.
For MATCH operations the posix-eregexp type should be evaluated
against each community associated with a prefix one community
at a time. Communities must be represented as strings in formats
conforming to oc-bgp-types:bgp-std-community-type. For example:
`1000:1000` for a standard community
nodetype: leaf-list (ro)
type: union
type: oc-bgp-types:bgp-std-community-type
type: oc-bgp-types:bgp-community-regexp-type
type: oc-bgp-types:bgp-well-known-community-type
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-type
description:
Enclosing container for list of extended BGP community
sets
nodetype: container (rw)
description:
List of defined extended BGP community sets
nodetype: list (rw)
list keys: [ext-community-set-name]
description:
Reference to list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for extended BGP community sets
nodetype: container (rw)
description:
name / label of the extended community set -- this is
used to reference the set in match conditions
nodetype: leaf (rw)
type: string
description:
Members of the extended community set.
For an ADD operation these are the communities that will be added;
the regexp type is not valid in this operation.
For REMOVE or REPLACE operations then matching communities will
be removed unless match-set-options is INVERT which will
reverse this to mean that anything that does not match will be
removed.
For MATCH operations the posix-eregexp type should be evaluated
against each community associated with a prefix one community
at a time. Communities must be represented as strings in formats
conforming to oc-bgp-types:bgp-ext-community-type. For example:
`route-origin:1000:1000` for the origin type extended community,
and so on.
nodetype: leaf-list (rw)
type: union
type: oc-bgp-types:bgp-ext-community-type
type: oc-types:posix-eregexp
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-type
description:
Operational state data for extended BGP community sets
nodetype: container (ro)
description:
name / label of the extended community set -- this is
used to reference the set in match conditions
nodetype: leaf (ro)
type: string
description:
Members of the extended community set.
For an ADD operation these are the communities that will be added;
the regexp type is not valid in this operation.
For REMOVE or REPLACE operations then matching communities will
be removed unless match-set-options is INVERT which will
reverse this to mean that anything that does not match will be
removed.
For MATCH operations the posix-eregexp type should be evaluated
against each community associated with a prefix one community
at a time. Communities must be represented as strings in formats
conforming to oc-bgp-types:bgp-ext-community-type. For example:
`route-origin:1000:1000` for the origin type extended community,
and so on.
nodetype: leaf-list (ro)
type: union
type: oc-bgp-types:bgp-ext-community-type
type: oc-types:posix-eregexp
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-type
description:
Enclosing container for list of define AS path sets
nodetype: container (rw)
description:
List of defined AS path sets
nodetype: list (rw)
list keys: [as-path-set-name]
description:
Reference to list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for AS path sets
nodetype: container (rw)
description:
name of the AS path set -- this is used to reference
the set in match conditions
nodetype: leaf (rw)
type: string
description:
AS path expression -- list of ASes in the set
nodetype: leaf-list (rw)
type: string
description:
Operational state data for AS path sets
nodetype: container (ro)
description:
name of the AS path set -- this is used to reference
the set in match conditions
nodetype: leaf (ro)
type: string
description:
AS path expression -- list of ASes in the set
nodetype: leaf-list (ro)
type: string
description:
Enclosing container for the list of top-level policy
definitions
nodetype: container (rw)
description:
List of top-level policy definitions, keyed by unique
name. These policy definitions are expected to be
referenced (by name) in policy chains specified in import
or export configuration statements.
nodetype: list (rw)
list keys: [name]
description:
Reference to the list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for policy defintions
nodetype: container (rw)
description:
Name of the top-level policy definition -- this name
is used in references to the current policy
nodetype: leaf (rw)
type: string
description:
Operational state data for policy definitions
nodetype: container (ro)
description:
Name of the top-level policy definition -- this name
is used in references to the current policy
nodetype: leaf (ro)
type: string
description:
Enclosing container for policy statements
nodetype: container (rw)
description:
Policy statements group conditions and actions
within a policy definition. They are evaluated in
the order specified (see the description of policy
evaluation at the top of this module.
nodetype: list (rw)
list keys: [name]
description:
Reference to list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for policy statements
nodetype: container (rw)
description:
name of the policy statement
nodetype: leaf (rw)
type: string
description:
Operational state data for policy statements
nodetype: container (ro)
description:
name of the policy statement
nodetype: leaf (ro)
type: string
description:
Condition statements for the current policy statement
nodetype: container (rw)
description:
Configuration data for policy conditions
nodetype: container (rw)
description:
Applies the statements from the specified policy
definition and then returns control the current
policy statement. Note that the called policy may
itself call other policies (subject to
implementation limitations). This is intended to
provide a policy 'subroutine' capability. The
called policy should contain an explicit or a
default route disposition that returns an
effective true (accept-route) or false
(reject-route), otherwise the behavior may be
ambiguous and implementation dependent
nodetype: leaf (rw)
type: leafref
description:
Condition to check the protocol / method used to install
the route into the local routing table
nodetype: leaf (rw)
type: identityref
description:
Operational state data for policy conditions
nodetype: container (ro)
description:
Applies the statements from the specified policy
definition and then returns control the current
policy statement. Note that the called policy may
itself call other policies (subject to
implementation limitations). This is intended to
provide a policy 'subroutine' capability. The
called policy should contain an explicit or a
default route disposition that returns an
effective true (accept-route) or false
(reject-route), otherwise the behavior may be
ambiguous and implementation dependent
nodetype: leaf (ro)
type: leafref
description:
Condition to check the protocol / method used to install
the route into the local routing table
nodetype: leaf (ro)
type: identityref
description:
Top-level container for interface match conditions
nodetype: container (rw)
description:
Configuration data for interface match conditions
nodetype: container (rw)
description:
Reference to a base interface. If a reference to a
subinterface is required, this leaf must be specified
to indicate the base interface.
nodetype: leaf (rw)
type: leafref
description:
Reference to a subinterface -- this requires the base
interface to be specified using the interface leaf in
this container. If only a reference to a base interface
is required, this leaf should not be set.
nodetype: leaf (rw)
type: leafref
description:
Operational state data for interface match conditions
nodetype: container (ro)
description:
Reference to a base interface. If a reference to a
subinterface is required, this leaf must be specified
to indicate the base interface.
nodetype: leaf (ro)
type: leafref
description:
Reference to a subinterface -- this requires the base
interface to be specified using the interface leaf in
this container. If only a reference to a base interface
is required, this leaf should not be set.
nodetype: leaf (ro)
type: leafref
description:
Match a referenced prefix-set according to the logic
defined in the match-set-options leaf
nodetype: container (rw)
description:
Configuration data for a prefix-set condition
nodetype: container (rw)
description:
References a defined prefix set
nodetype: leaf (rw)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation. This leaf only supports matching on ANY
member of the set or inverting the match. Matching on ALL is
not supported
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-restricted-type
description:
Operational state data for a prefix-set condition
nodetype: container (ro)
description:
References a defined prefix set
nodetype: leaf (ro)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation. This leaf only supports matching on ANY
member of the set or inverting the match. Matching on ALL is
not supported
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-restricted-type
description:
Match a referenced neighbor set according to the logic
defined in the match-set-options-leaf
nodetype: container (rw)
description:
Configuration data
nodetype: container (rw)
description:
References a defined neighbor set
nodetype: leaf (rw)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation. This leaf only supports matching on ANY
member of the set or inverting the match. Matching on ALL is
not supported
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-restricted-type
description:
Operational state data
nodetype: container (ro)
description:
References a defined neighbor set
nodetype: leaf (ro)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation. This leaf only supports matching on ANY
member of the set or inverting the match. Matching on ALL is
not supported
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-restricted-type
description:
Match a referenced tag set according to the logic defined
in the match-options-set leaf
nodetype: container (rw)
description:
Configuration data for tag-set conditions
nodetype: container (rw)
description:
References a defined tag set
nodetype: leaf (rw)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation. This leaf only supports matching on ANY
member of the set or inverting the match. Matching on ALL is
not supported
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-restricted-type
description:
Operational state data tag-set conditions
nodetype: container (ro)
description:
References a defined tag set
nodetype: leaf (ro)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation. This leaf only supports matching on ANY
member of the set or inverting the match. Matching on ALL is
not supported
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-restricted-type
description:
Top-level container for protocol instance match condition
in policy statements. The protocol instance is referenced
by an identifier and name
nodetype: container (rw)
description:
Configuration data for policy matching on protocol
instance
nodetype: container (rw)
description:
The identifier (protocol type) of the
protocol instance to match on in the local network
instance.
nodetype: leaf (rw)
type: identityref
description:
The name of the protocol instance to match
on in the local network instance. The string
must match one of /network-instances/
network-instance/protocols/
protocol/name in the local network
instance.
nodetype: leaf (rw)
type: string
description:
Operational state data for policy matching on protocol instance
nodetype: container (ro)
description:
The identifier (protocol type) of the
protocol instance to match on in the local network
instance.
nodetype: leaf (ro)
type: identityref
description:
The name of the protocol instance to match
on in the local network instance. The string
must match one of /network-instances/
network-instance/protocols/
protocol/name in the local network
instance.
nodetype: leaf (ro)
type: string
description:
Top-level container
nodetype: container (rw)
description:
Configuration data for BGP-specific policy conditions
nodetype: container (rw)
description:
Condition to check if the received MED value is equal to
the specified value
nodetype: leaf (rw)
type: uint32
description:
Condition to check if the route origin is equal to the
specified value
nodetype: leaf (rw)
type: oc-bgp-types:bgp-origin-attr-type
description:
List of next hop addresses to check for in the route
update
nodetype: leaf-list (rw)
type: oc-inet:ip-address
description:
List of address families which the NLRI may be
within
nodetype: leaf-list (rw)
type: identityref
description:
Condition to check if the local pref attribute is equal to
the specified value
nodetype: leaf (rw)
type: uint32
description:
Condition to check the route type in the route update
nodetype: leaf (rw)
type: enumeration
description:
References a defined community set
nodetype: leaf (rw)
type: leafref
description:
References a defined extended community set
nodetype: leaf (rw)
type: leafref
description:
Operational state data for BGP-specific policy
conditions
nodetype: container (ro)
description:
Condition to check if the received MED value is equal to
the specified value
nodetype: leaf (ro)
type: uint32
description:
Condition to check if the route origin is equal to the
specified value
nodetype: leaf (ro)
type: oc-bgp-types:bgp-origin-attr-type
description:
List of next hop addresses to check for in the route
update
nodetype: leaf-list (ro)
type: oc-inet:ip-address
description:
List of address families which the NLRI may be
within
nodetype: leaf-list (ro)
type: identityref
description:
Condition to check if the local pref attribute is equal to
the specified value
nodetype: leaf (ro)
type: uint32
description:
Condition to check the route type in the route update
nodetype: leaf (ro)
type: enumeration
description:
References a defined community set
nodetype: leaf (ro)
type: leafref
description:
References a defined extended community set
nodetype: leaf (ro)
type: leafref
description:
Value and comparison operations for conditions based on the
number of regular communities in the route update.
nodetype: container (rw)
description:
Configuration data for regular community count condition
nodetype: container (rw)
description:
type of comparison to be performed
nodetype: leaf (rw)
type: identityref
description:
value to compare with the community count
nodetype: leaf (rw)
type: uint32
description:
Operational state data for regular community count condition
nodetype: container (ro)
description:
type of comparison to be performed
nodetype: leaf (ro)
type: identityref
description:
value to compare with the community count
nodetype: leaf (ro)
type: uint32
description:
Value and comparison operations for conditions based on the
number of extended communities in the route update.
nodetype: container (rw)
description:
Configuration data for extended community count condition
nodetype: container (rw)
description:
type of comparison to be performed
nodetype: leaf (rw)
type: identityref
description:
value to compare with the community count
nodetype: leaf (rw)
type: uint32
description:
Operational state data for extended community count condition
nodetype: container (ro)
description:
type of comparison to be performed
nodetype: leaf (ro)
type: identityref
description:
value to compare with the community count
nodetype: leaf (ro)
type: uint32
description:
Value and comparison operations for conditions based on the
length of the AS path in the route update
nodetype: container (rw)
description:
Configuration data for AS path length condition
nodetype: container (rw)
description:
type of comparison to be performed
nodetype: leaf (rw)
type: identityref
description:
value to compare with the community count
nodetype: leaf (rw)
type: uint32
description:
Operational state data for AS path length condition
nodetype: container (ro)
description:
type of comparison to be performed
nodetype: leaf (ro)
type: identityref
description:
value to compare with the community count
nodetype: leaf (ro)
type: uint32
description:
Match a referenced as-path set according to the logic
defined in the match-set-options leaf
nodetype: container (rw)
description:
Configuration data for match conditions on AS path set
nodetype: container (rw)
description:
References a defined AS path set
nodetype: leaf (rw)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-type
description:
Operational state data for match conditions on AS
path set
nodetype: container (ro)
description:
References a defined AS path set
nodetype: leaf (ro)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-type
description:
Match a referenced community set according to the logic
defined in the match-set-options leaf
nodetype: container (rw)
description:
Configuration data for match conditions on community set
nodetype: container (rw)
description:
References a defined community set
nodetype: leaf (rw)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-type
description:
Operational state data for match conditions on community set
nodetype: container (ro)
description:
References a defined community set
nodetype: leaf (ro)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-type
description:
Match a referenced extended community set according to the logic
defined in the match-set-options leaf
nodetype: container (rw)
description:
Configuration data for match conditions on extended community set
nodetype: container (rw)
description:
References a defined extended community set
nodetype: leaf (rw)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (rw)
type: oc-pol-types:match-set-options-type
description:
Operational state data for match conditions on extended
community set
nodetype: container (ro)
description:
References a defined extended community set
nodetype: leaf (ro)
type: leafref
description:
Optional parameter that governs the behaviour of the
match operation
nodetype: leaf (ro)
type: oc-pol-types:match-set-options-type
description:
Match conditions relating to the IS-IS protocol
nodetype: container (rw)
description:
Configuration parameters relating to IS-IS match
conditions
nodetype: container (rw)
description:
Match the level that the IS-IS prefix is within. This can
be used in the case that import or export policies refer
to an IS-IS instance that has multiple levels configured
within it
nodetype: leaf (rw)
type: isis-types:level-number
description:
Matches the type of the route to redistribute to INTERNAL or EXTERNAL
nodetype: leaf (rw)
type: isis-types:metric-type
description:
Operational state parameters relating to IS-IS match
conditions
nodetype: container (ro)
description:
Match the level that the IS-IS prefix is within. This can
be used in the case that import or export policies refer
to an IS-IS instance that has multiple levels configured
within it
nodetype: leaf (ro)
type: isis-types:level-number
description:
Matches the type of the route to redistribute to INTERNAL or EXTERNAL
nodetype: leaf (ro)
type: isis-types:metric-type
description:
Match conditions specific to OSPF
nodetype: container (rw)
description:
Configuration parameters relating to OSPF match conditions
nodetype: container (rw)
description:
Match prefixes which are within a particular OSPF area
nodetype: leaf (rw)
type: oc-ospf-types:ospf-area-identifier
description:
Operational state parameters relating to OSPF match conditions
nodetype: container (ro)
description:
Match prefixes which are within a particular OSPF area
nodetype: leaf (ro)
type: oc-ospf-types:ospf-area-identifier
description:
Top-level container for policy action statements
nodetype: container (rw)
description:
Configuration data for policy actions
nodetype: container (rw)
description:
Select the final disposition for the route, either
accept or reject.
nodetype: leaf (rw)
type: policy-result-type
description:
Operational state data for policy actions
nodetype: container (ro)
description:
Select the final disposition for the route, either
accept or reject.
nodetype: leaf (ro)
type: policy-result-type
description:
Policy actions associated with setting tags for a particular
route. A tag is an abstract entity which can be mapped to underlying
protocol attributes where applicable.
nodetype: container (rw)
description:
Configuration of tag application
nodetype: container (rw)
description:
This leaf controls the source of the tags that are set as a result
of the action. In the case that the INLINE value is specified, the
list of tags specified within the action is applied to matching prefixes.
In the case that the REFERENCE value is specified, a pre-defined set of
tags is utilised.
nodetype: leaf (rw)
type: enumeration
description:
Operational state related to tag application.
nodetype: container (ro)
description:
This leaf controls the source of the tags that are set as a result
of the action. In the case that the INLINE value is specified, the
list of tags specified within the action is applied to matching prefixes.
In the case that the REFERENCE value is specified, a pre-defined set of
tags is utilised.
nodetype: leaf (ro)
type: enumeration
description:
The tags specified in this container are set on a route using
the values directly. It is applicable when the mode of application
is explicitly specified as INLINE.
nodetype: container (rw)
description:
Configuration values related to in-line tag specification.
nodetype: container (rw)
description:
Set one or more tags for prefixes that match the specified condition(s)
using the specified tag values. When a tag is set it MUST be possible to
match the value set in subsequent policies on the local device. Where the
protocol that is carrying the prefix has a tag field (OSPF, and IS-IS in
particular) the tag MUST be set in the corresponding protocol advertisements
of the prefix.
nodetype: leaf-list (rw)
type: oc-pol-types:tag-type
description:
Operational state related to in-line tag specification.
nodetype: container (ro)
description:
Set one or more tags for prefixes that match the specified condition(s)
using the specified tag values. When a tag is set it MUST be possible to
match the value set in subsequent policies on the local device. Where the
protocol that is carrying the prefix has a tag field (OSPF, and IS-IS in
particular) the tag MUST be set in the corresponding protocol advertisements
of the prefix.
nodetype: leaf-list (ro)
type: oc-pol-types:tag-type
description:
This container is applicable when the mode of application is explicitly
specified to as REFERENCE. The tags set on a route are those that are
specified within the tag-set
nodetype: container (rw)
description:
Configuration values related to specifying a tag-set to be applied to
a route.
nodetype: container (rw)
description:
Use the referenced tag-set to set tags on the prefixes that match the
specified conditions. When a tag is set it MUST be possible to match the
value set in subsequent policies on the local device. where the protocol that
is carrying the prefix has a tag field (OSPF, and IS-IS for in particular)
the tag MUST be set in the corresponding protocol advertisements of the
prefix.
nodetype: leaf (rw)
type: leafref
description:
Operational state related to specifying a tag-set to be applied to a
route.
nodetype: container (ro)
description:
Use the referenced tag-set to set tags on the prefixes that match the
specified conditions. When a tag is set it MUST be possible to match the
value set in subsequent policies on the local device. where the protocol that
is carrying the prefix has a tag field (OSPF, and IS-IS for in particular)
the tag MUST be set in the corresponding protocol advertisements of the
prefix.
nodetype: leaf (ro)
type: leafref
description:
Top-level container for BGP-specific actions
nodetype: container (rw)
description:
Configuration data for BGP-specific actions
nodetype: container (rw)
description:
set the origin attribute to the specified
value
nodetype: leaf (rw)
type: oc-bgp-types:bgp-origin-attr-type
description:
set the local pref attribute on the route
update
nodetype: leaf (rw)
type: uint32
description:
set the next-hop attribute in the route update
nodetype: leaf (rw)
type: bgp-next-hop-type
description:
Set the MED metric attribute in the route update. When set, a
valid `set-med-action` must be specified.
nodetype: leaf (rw)
type: bgp-set-med-type
description:
When set-med is specified, this leaf is mandatory to set the
appropriate action on the MED metric value.
nodetype: leaf (rw)
type: bgp-set-med-action
description:
Operational state data for BGP-specific actions
nodetype: container (ro)
description:
set the origin attribute to the specified
value
nodetype: leaf (ro)
type: oc-bgp-types:bgp-origin-attr-type
description:
set the local pref attribute on the route
update
nodetype: leaf (ro)
type: uint32
description:
set the next-hop attribute in the route update
nodetype: leaf (ro)
type: bgp-next-hop-type
description:
Set the MED metric attribute in the route update. When set, a
valid `set-med-action` must be specified.
nodetype: leaf (ro)
type: bgp-set-med-type
description:
When set-med is specified, this leaf is mandatory to set the
appropriate action on the MED metric value.
nodetype: leaf (ro)
type: bgp-set-med-action
description:
Action to prepend the specified AS number to the AS-path a
specified number of times
nodetype: container (rw)
description:
Configuration data for the AS path prepend action
nodetype: container (rw)
description:
Number of times to prepend the value specified in the asn
leaf to the AS path. If no value is specified by the asn
leaf, the local AS number of the system is used. The value
should be between 1 and the maximum supported by the
implementation.
nodetype: leaf (rw)
type: uint8
description:
The AS number to prepend to the AS path. If neither this
leaf nor use-last-as leaf is specified but repeat-n is set, then
the local AS number will be used for prepending.
nodetype: leaf (rw)
type: oc-inet:as-number
description:
Indicates whether to use the last AS number, which is also the
most recent AS number, to prepend to the AS path.
If neither this leaf nor asn leaf is specified
but repeat-n is set, then the local AS number will be
used for prepending.
nodetype: leaf (rw)
type: boolean
description:
Operational state data for the AS path prepend action
nodetype: container (ro)
description:
Number of times to prepend the value specified in the asn
leaf to the AS path. If no value is specified by the asn
leaf, the local AS number of the system is used. The value
should be between 1 and the maximum supported by the
implementation.
nodetype: leaf (ro)
type: uint8
description:
The AS number to prepend to the AS path. If neither this
leaf nor use-last-as leaf is specified but repeat-n is set, then
the local AS number will be used for prepending.
nodetype: leaf (ro)
type: oc-inet:as-number
description:
Indicates whether to use the last AS number, which is also the
most recent AS number, to prepend to the AS path.
If neither this leaf nor asn leaf is specified
but repeat-n is set, then the local AS number will be
used for prepending.
nodetype: leaf (ro)
type: boolean
description:
Action to set the community attributes of the route, along
with options to modify how the community is modified.
Communities may be set using an inline list OR
reference to an existing defined set (not both).
nodetype: container (rw)
description:
Configuration data for the set-community action
nodetype: container (rw)
description:
Indicates the method used to specify the extended
communities for the set-ext-community action
nodetype: leaf (rw)
type: enumeration
description:
Options for modifying the community attribute with
the specified values. These options apply to both
methods of setting the community attribute.
nodetype: leaf (rw)
type: bgp-set-community-option-type
description:
Operational state data for the set-community action
nodetype: container (ro)
description:
Indicates the method used to specify the extended
communities for the set-ext-community action
nodetype: leaf (ro)
type: enumeration
description:
Options for modifying the community attribute with
the specified values. These options apply to both
methods of setting the community attribute.
nodetype: leaf (ro)
type: bgp-set-community-option-type
description:
Set the community values for the action inline with
a list.
nodetype: container (rw)
description:
Configuration data or inline specification of set-community
action
nodetype: container (rw)
description:
Set the community values for the update inline with
a list.
nodetype: leaf-list (rw)
type: union
type: oc-bgp-types:bgp-std-community-type
type: oc-bgp-types:bgp-well-known-community-type
description:
Operational state data or inline specification of
set-community action
nodetype: container (ro)
description:
Set the community values for the update inline with
a list.
nodetype: leaf-list (ro)
type: union
type: oc-bgp-types:bgp-std-community-type
type: oc-bgp-types:bgp-well-known-community-type
description:
Provide a reference to a defined community set for the
set-community action
nodetype: container (rw)
description:
Configuration data for referening a community-set in the
set-community action
nodetype: container (rw)
description:
References a list of defined community sets by name
nodetype: leaf-list (rw)
type: leafref
description:
References a defined community set by name
nodetype: leaf (rw)
type: leafref
description:
Operational state data for referening a community-set
in the set-community action
nodetype: container (ro)
description:
References a list of defined community sets by name
nodetype: leaf-list (ro)
type: leafref
description:
References a defined community set by name
nodetype: leaf (ro)
type: leafref
description:
Action to set the extended community attributes of the
route, along with options to modify how the community is
modified. Extended communities may be set using an inline
list OR a reference to an existing defined set (but not
both).
nodetype: container (rw)
description:
Configuration data for the set-ext-community action
nodetype: container (rw)
description:
Indicates the method used to specify the extended
communities for the set-ext-community action
nodetype: leaf (rw)
type: enumeration
description:
Options for modifying the community attribute with
the specified values. These options apply to both
methods of setting the community attribute.
nodetype: leaf (rw)
type: bgp-set-community-option-type
description:
Operational state data for the set-ext-community action
nodetype: container (ro)
description:
Indicates the method used to specify the extended
communities for the set-ext-community action
nodetype: leaf (ro)
type: enumeration
description:
Options for modifying the community attribute with
the specified values. These options apply to both
methods of setting the community attribute.
nodetype: leaf (ro)
type: bgp-set-community-option-type
description:
Set the extended community values for the action inline with
a list.
nodetype: container (rw)
description:
Configuration data or inline specification of
set-ext-community action
nodetype: container (rw)
description:
Set the extended community values for the update inline
with a list.
nodetype: leaf-list (rw)
type: union
type: oc-bgp-types:bgp-ext-community-type
type: oc-bgp-types:bgp-well-known-community-type
description:
Operational state data or inline specification of
set-ext-community action
nodetype: container (ro)
description:
Set the extended community values for the update inline
with a list.
nodetype: leaf-list (ro)
type: union
type: oc-bgp-types:bgp-ext-community-type
type: oc-bgp-types:bgp-well-known-community-type
description:
Provide a reference to an extended community set for the
set-ext-community action
nodetype: container (rw)
description:
Configuration data for referening an extended
community-set in the set-ext-community action
nodetype: container (rw)
description:
References a list of defined extended community sets by
name
nodetype: leaf-list (rw)
type: leafref
description:
References a defined extended community set by
name
nodetype: leaf (rw)
type: leafref
description:
Operational state data for referening an extended
community-set in the set-ext-community action
nodetype: container (ro)
description:
References a list of defined extended community sets by
name
nodetype: leaf-list (ro)
type: leafref
description:
References a defined extended community set by
name
nodetype: leaf (ro)
type: leafref
description:
Actions that can be performed by IS-IS within a policy
nodetype: container (rw)
description:
Configuration parameters relating to IS-IS actions
nodetype: container (rw)
description:
Set the level that a prefix is to be imported into.
nodetype: leaf (rw)
type: isis-types:level-number
description:
This leaf sets the type of metric that is to be specified
when the set-metric leaf is specified
nodetype: leaf (rw)
type: isis-types:metric-type
description:
Set the style of the metric
nodetype: leaf (rw)
type: isis-types:metric-style
description:
Set the metric of the IS-IS prefix
nodetype: leaf (rw)
type: isis-types:wide-metric
description:
Operational state associated with IS-IS actions
nodetype: container (ro)
description:
Set the level that a prefix is to be imported into.
nodetype: leaf (ro)
type: isis-types:level-number
description:
This leaf sets the type of metric that is to be specified
when the set-metric leaf is specified
nodetype: leaf (ro)
type: isis-types:metric-type
description:
Set the style of the metric
nodetype: leaf (ro)
type: isis-types:metric-style
description:
Set the metric of the IS-IS prefix
nodetype: leaf (ro)
type: isis-types:wide-metric
description:
Actions specific to OSPF
nodetype: container (rw)
description:
Configuration parameters for OSPF actions
nodetype: container (rw)
description:
Set the area for the matched route. This action is typically
used when importing prefixes into OSPF, such that a route can
be imported into a specific area within the instance.
nodetype: leaf (rw)
type: oc-ospf-types:ospf-area-identifier
description:
Operational state parameters for OSPF actions
nodetype: container (ro)
description:
Set the area for the matched route. This action is typically
used when importing prefixes into OSPF, such that a route can
be imported into a specific area within the instance.
nodetype: leaf (ro)
type: oc-ospf-types:ospf-area-identifier
description:
Configuration and state parameters relating to manipulating
the OSPF metric
nodetype: container (rw)
description:
Configuration parameters relating to setting the OSPF metric
nodetype: container (rw)
description:
Specify the type of metric which is to be set by the policy
nodetype: leaf (rw)
type: enumeration
default: EXTERNAL_TYPE_2
description:
Set the metric of the routes matching the policy to the value
specified by this leaf.
nodetype: leaf (rw)
type: oc-ospf-types:ospf-metric
description:
Operational state parameters relating to setting the OSPF
metric
nodetype: container (ro)
description:
Specify the type of metric which is to be set by the policy
nodetype: leaf (ro)
type: enumeration
default: EXTERNAL_TYPE_2
description:
Set the metric of the routes matching the policy to the value
specified by this leaf.
nodetype: leaf (ro)
type: oc-ospf-types:ospf-metric
This module defines routing policy statements (conditions and actions) for the network instance model. These statements are generally added to the routing policy model.
openconfig-extensions
openconfig-routing-policy
openconfig-policy-types
This module contains data definitions for BGP routing policy. It augments the base routing-policy module with BGP-specific options for conditions and actions.
openconfig-inet-types
openconfig-routing-policy
openconfig-policy-types
openconfig-bgp-types
openconfig-extensions
openconfig-types
description:
Type definition for options when setting the community
attribute in a policy action
type: enumeration
description:
type definition for specifying next-hop in policy actions
type: union
type: oc-inet:ip-address
type: enumeration
description:
Type definition for specifying how the BGP MED can be set in BGP
policy actions. The MED can be specified as a direct integer
value or setting it to the IGP cost. To be used in conjunction
with `bgp-set-med-action` in order to specify the appropriate
action to take on this value.
type: union
type: uint32
type: enumeration
description:
Specifies which action to take on the value specified by the
bgp-set-med-type.
type: enumeration
This module contains data definitions for ISIS routing policy. It augments the base routing-policy module with BGP-specific options for conditions and actions.
openconfig-routing-policy
openconfig-extensions
openconfig-isis-types
This module defines extensions to the OpenConfig policy model to add extensions for OSPF. This module is intended to be generic for both OSPFv2 and OSPFv3.
openconfig-routing-policy
openconfig-extensions
openconfig-ospf-types