BMP YANG Module

The following tree diagram provides an overview of the ietf-bmp.yang data model.

<CODE BEGINS> file "ietf-bmp@2022-01-27.yang"

WG List: Author: Camilo Cardona Author: Paolo Lucente Author: Thomas Graf Author: Benoit Claise "; description "This module specifies a structure for BMP (BGP Monitoring Protocol) configuration and monitoring. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here. Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 9196 (https://www.rfc-editor.org/info/rfc9196); see the RFC itself for full legal notices."; revision 2022-10-18 { description "initial version"; reference "RFC YYYY: BMP YANG Module RFC-EDITOR: please update YYYY with this RFC ID"; } identity bmp-peer-types-idty { description "Enum values for peer selection specific for BMP"; } identity bmp-peer-types-all-peers-idty { base bmp-peer-types-idty; description "This identify is an explicit way of defining that the device SHOULD send the updates from all peers to the station for a particular RIB/AFI."; } identity bmp-ni-types-idty { description "Enum values for network instances specific for BMP"; } identity bmp-ni-types-all-ni-idty { base bmp-ni-types-idty; description "The identify is an explicit way of defining that the device SHOULD send the updates from all network instances."; } grouping bmp-tcp-options { description "TCP options for the connection to the station"; leaf maximum-segment-size { type uint16; description "Maximum segment size for the TCP connections."; } // Taken from the bgp yang module leaf mtu-discovery { type boolean; default "true"; description "Turns path mtu discovery for the TCP sessions on (true) or off (false)."; reference "RFC 1191: Path MTU discovery."; } uses tcpcmn:tcp-common-grouping; // taken from the bgp yang module but using groupings leaf secure-session-enable { type boolean; default "false"; description "Does this session need to be secured?"; } container secure-session { when "../secure-session-enable = 'true'"; description "Container for describing how a particular BGP session is to be secured."; choice authentication { case ao { leaf ao-keychain { type key-chain:key-chain-ref; description "Reference to the key chain that will be used by this model. Applicable for TCP-AO and TCP-MD5 only"; reference "RFC 8177: YANG Key Chain."; } description "Uses TCP-AO to secure the session. Parameters for those are defined as a grouping in the TCP YANG model."; reference "RFC 5925 - The TCP Authentication Option."; } case md5 { leaf md5-keychain { type key-chain:key-chain-ref; description "Reference to the key chain that will be used by this model. Applicable for TCP-AO and TCP-MD5 only"; reference "RFC 8177: YANG Key Chain."; } description "Uses TCP-MD5 to secure the session. Parameters for those are defined as a grouping in the TCP YANG model."; reference "RFC 5925: The TCP Authentication Option."; } description "Choice of TCP authentication."; } } } grouping bmp-ip-connection { description "common elements for defining connectivity to a bmp station"; choice passive-or-active { description "Choice for active or passive connection"; case active { description "The device starts the connection to the station"; container active { description "The device starts the connection to the station"; leaf network-instance { type leafref { path "/ni:network-instances/ni:network-instance/" + "ni:name"; } mandatory true; description "Network-instance to used to reach the station."; } leaf station-address { type inet:ip-address; mandatory true; description "Destination IP address of station"; } leaf station-port { type inet:port-number; mandatory true; description "Destination port of the station"; } leaf local-address { type inet:ip-address; mandatory true; description "Local IP address to source active connection"; } leaf local-port { type inet:port-number; description "Optional Local port for active connection"; } } } case passive { description "The device waits for the connection in a local endpoint"; container passive { description "The device waits for the connection in a local endpoint"; leaf network-instance { type leafref { path "/ni:network-instances/ni:network-instance/" + "ni:name"; } mandatory true; description "Network-instance to use to reach the station."; } leaf station-address { type inet:ip-address; mandatory true; description "address of station"; } leaf station-port { type inet:port-number; description "Optional port identifying the connection, if provided it MUST match"; } leaf local-address { type inet:ip-address; description "Local IP address to wait for the connection"; } leaf local-port { type inet:port-number; description "Local port to wait for the connection"; } } } } } grouping bmp-source-configuration { description "Group containing some general characteristics for configuring a BMP source"; container filters { description "Contains containers specifying filters for deciding which routes to export to the station"; container policy-filter { description "Filter routes based on a policy"; leaf-list export-policy { type leafref { path "/rt-pol:routing-policy/" + "rt-pol:policy-definitions/" + "rt-pol:policy-definition/rt-pol:name"; require-instance true; } ordered-by user; description "List of policy names in sequence used to select routes to be exported to station."; } leaf default-export-policy { type rt-pol:default-policy-type; default "accept-route"; description "Explicitly set a default policy if no policy definition in the export policy chain is satisfied."; } } } } grouping bmp-peer-ribs-filter { description "Leaves for configuring RIBs where origin/destination peers are well defined."; leaf enabled { type boolean; description "Enables the specified RIB"; } container address-families { description "container for lists of address-families"; list address-family { key "name"; description "List of address families. The name of the address family, as defined in the BGP model is used for keying."; leaf name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/bgp:bgp/" + "bgp:global/bgp:afi-safis/bgp:afi-safi/bgp:name"; } description "Name of the address family"; } container peers { description "Identification of peers for which we send BMP data to the collector"; list peer { key "peer-id"; description "Identification of peers for which we send BMP data to the collector"; leaf peer-id { type union { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/bgp:bgp/" + "bgp:neighbors/bgp:neighbor/bgp:remote-address"; } type bt:peer-type; type identityref { base bmp-peer-types-idty; } } description "Peers can be identified by a remote-address, or by an enum value corresponding to groups of peers. This way an operator can select all external peers, all internal peers, or all peers."; } uses bmp-source-configuration; } } } } } grouping bmp-route-monitoring-sources { description "Route monitoring sources"; container network-instances { description "container for lists of network-instances"; list network-instance { key "network-instance-id"; description "Network instance to monitory using BMP."; leaf network-instance-id { type union { type leafref { path "/ni:network-instances/ni:network-instance/" + "ni:name"; } type identityref { base bmp-ni-types-all-ni-idty; } } description "Identification of a network-instance. Network instances can be identified directly by their path or one can define all of them using an identity"; } container adj-rib-in-pre { description "Configuration for the adj-rib-in pre-policy"; reference "RFC7854: BGP Monitoring Protocol (BMP), Section 2."; uses bmp-peer-ribs-filter; } container adj-rib-in-post { description "Configuration for the adj-rib-in post-policy"; reference "RFC7854: BGP Monitoring Protocol (BMP), Section 2."; uses bmp-peer-ribs-filter; } container local-rib { description "Configuration for the local-rib"; reference "RFC9069: Support for Local RIB in the BGP Monitoring Protocol (BMP), Section 3."; leaf enabled { type boolean; description "Enables the specified RIB"; } container address-families { description "List of address families to enable for local-rib."; list address-family { key "address-family-id"; description "Address family to enable for local-rib"; leaf address-family-id { type identityref { base bt:afi-safi-type; } description "Address family id to enable for local-rib"; } uses bmp-source-configuration; } } } container adj-rib-out-pre { description "Configuration for the adj-rib-out pre-policy"; uses bmp-peer-ribs-filter; reference "RFC8671: Support for Adj-RIB-Out in the BGP Monitoring Protocol (BMP) , Section 3."; } container adj-rib-out-post { description "Configuration for the adj-rib-out post-policy"; uses bmp-peer-ribs-filter; reference "RFC8671: Support for Adj-RIB-Out in the BGP Monitoring Protocol (BMP) , Section 3."; } } } } grouping bmp-session-options { description "leaves for configuration of the bmp session"; leaf initiation-message { type string; description "User defined message to append to the initiation message"; } leaf statistics-interval { type uint32; description "Default Interval for statistic message."; } } container bmp { description "Main level for BMP configuration "; container stations { description "Container for the list of BMP stations"; list station { key "id"; description "Configuration for BMP stations."; leaf id { type string; description "Identification string for the station"; } // Connection, missing tcp tuning params // like keep-alives, segment sizes, etc. container connection { description "Connection details for the station"; uses bmp-ip-connection; uses bmp-tcp-options; leaf initial-delay { type uint32; units "seconds"; default 0; description "Initial delay of the connection to the station"; } container backoff { description "Configures the backoff strategy after a connection retry"; choice backoff-options { description "Options for backoff strategies"; case simple-exponential { description "Simple exponential backoff with limits."; container simple-exponential { description "Simple exponential backoff with limits. Starts with the initial backoff and doubles the backoff of every retry until reaching the maximum backoff"; leaf initial-backoff { type uint32; units "seconds"; default 30; description "Initial backoff time"; } leaf maximum-backoff { type uint32; units "seconds"; default 720; description "Maximum backoff time"; } } } } } } container bmp-session { description "BMP session options for the station"; uses bmp-session-options; } container bmp-sources { description "Configuration of the data sources for the station"; container bmp-route-monitoring { description "Configuration of the data sources for route-monitoring messages"; uses bmp-route-monitoring-sources; } } container session-stats { description "stats and operational values for the station"; leaf discontinuity-time { type yang:date-and-time; mandatory true; description "The time on the most recent occasion at which any one or more of this station's counters suffered a discontinuity. If no such discontinuities have occurred since the last re-initialization of the local management subsystem, then this node contains the time the local management subsystem re-initialized itself."; } leaf established-session { type boolean; config false; description "Value indicating if the session is currently established"; } leaf total-route-monitoring-messages { type uint64; config false; description "Number of route-monitoring messages sent since last successful connection"; } leaf total-statistics-messages { type uint64; config false; description "Number of statistics messages sent since last successful connection"; } leaf total-peer-down-messages { type uint64; config false; description "Number of peer-down messages sent since last successful connection"; } leaf total-peer-up-messages { type uint64; config false; description "Number of peer-up messages sent since last successful connection"; } leaf total-initiation-messages { type uint64; config false; description "Number of initiation messages sent since last successful connection"; } leaf total-route-mirroring-messages { type uint64; config false; description "Number of route-mirroring messages sent since last successful connection"; } } } container actions { nacm:default-deny-all; description "Container with the actions for the BMP operation"; action session-reset { description "Resets the session for a station."; output { choice outcome { description "Output of the reset operation. Either a success or failure. For the latter, the reason for the error is provided."; leaf success { type empty; description "Reset successful"; } leaf failure { type string; description "Reset could not be performed. Reason is included in the field"; } } } } } } } } ]]> <CODE ENDS>