Internet DRAFT - draft-rvelucha-bfd-offload-yang
draft-rvelucha-bfd-offload-yang
Network Working Group V. Rajaguru, Ed.
Internet-Draft Cisco Systems
Intended status: Standards Track 3 April 2023
Expires: 5 October 2023
YANG Data Model for Bidirectional Forwarding Detection (BFD) Hardware
Offloaded Session
draft-rvelucha-bfd-offload-yang-06
Abstract
This document defines a extension YANG data model that can be used to
manage Hardware Offloaded Bidirectional Forwarding Detection (BFD).
This document specially talks about BFD sessions that are offloaded
to hardware.
The YANG modules in this document conform to the Network Management
Datastore Architecture (NMDA).
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 5 October 2023.
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
Rajaguru Expires 5 October 2023 [Page 1]
Internet-Draft BFD YANG April 2023
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2
1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 2
2. Design of the Data Model . . . . . . . . . . . . . . . . . . 3
3. BFD IP single-hop-ext hierarchy . . . . . . . . . . . . . . . 3
4. BFD IP multi-hop-ext hierarchy . . . . . . . . . . . . . . . 3
5. BFD Over LAG-ext hierarchy . . . . . . . . . . . . . . . . . 4
6. BFD IP single-hop ext YANG Module . . . . . . . . . . . . . . 4
7. BFD IP multi-hop ext YANG Module . . . . . . . . . . . . . . 6
8. BFD Over LAG ext YANG Module . . . . . . . . . . . . . . . . 8
9. Security Considerations . . . . . . . . . . . . . . . . . . . 9
10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 10
12. Normative References . . . . . . . . . . . . . . . . . . . . 10
Appendix A. Change log . . . . . . . . . . . . . . . . . . . . . 11
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 11
1. Introduction
This document defines an extension YANG data model to base model
[RFC9314] that can be used to manage BFD sessions that are offloaded
to hardware. BFD is a network protocol which is used for liveness
detection of arbitrary paths between systems.
1.1. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in BCP 14 [RFC2119]
[RFC8174] when, and only when, they appear in all capitals, as shown
here.
1.2. Tree Diagrams
This document uses the graphical representation of data models
defined in [RFC8340].
Rajaguru Expires 5 October 2023 [Page 2]
Internet-Draft BFD YANG April 2023
2. Design of the Data Model
This yang model which is extension to base BFD yang mode been
designed to manage BFD HW offloaded sessions. This new "bfd"
container is augmented by all the YANG modules for their respective
specific information:
1. ietf-bfd-ip-sh-ext.yang augments "/routing/control-plane-
protocols/control-plane-protocol/bfd/ip-sh/sessions/session" with
the "session-offloaded" leaf for BFD sessions over IP single-hop
extension.
2. ietf-bfd-ip-mh-ext.yang augments "/routing/control-plane-
protocols/control-plane-protocol/bfd/ip-mh/sessions-groups/
session-group" with the "session-offloaded" leaf for BFD sessions
over IP multi-hop extension.
3. ietf-bfd-lag-ext.yang augments "/routing/control-plane-protocols/
control-plane-protocol/bfd/bfd-lag/sessions/session" with the
"ession-offloaded" leaf for BFD sessions over LAG extension.
3. BFD IP single-hop-ext hierarchy
An "ip-sh-ext" node is added under "bfd" node in control-plane-
protocol. The operational state data for each BFD IP single-hop
session is under this "ip-sh-ext" node.
module: ietf-bfd-ip-sh-ext
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bfd:bfd/bfd-ip-sh:ip-sh
/bfd-ip-sh:sessions/bfd-ip-sh:session:
+--rw ip-sh-ext
+--ro session-running-ext
+--ro session-offloaded? boolean
4. BFD IP multi-hop-ext hierarchy
An "ip-mh-ext" node is added under "bfd" node in control-plane-
protocol. The operational state data for each BFD IP multi-hop
session is under this "ip-mh-ext" node.
Rajaguru Expires 5 October 2023 [Page 3]
Internet-Draft BFD YANG April 2023
module: ietf-bfd-ip-mh-ext
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bfd:bfd/bfd-ip-mh:ip-mh
/bfd-ip-mh:session-groups/bfd-ip-mh:session-group:
+rw session-offloaded? boolean
5. BFD Over LAG-ext hierarchy
An "lag-ext" node is added under "bfd" node in control-plane-
protocol. The operational state data for each BFD Over LAG session
is under this "lag-ext" node.
module: ietf-bfd-lag-ext
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bfd:bfd/bfd-lag:lag
/bfd-lag:sessions/bfd-lag:session:
+rw session-offloaded? boolean
6. BFD IP single-hop ext YANG Module
This YANG module imports "ietf-bfd-ip-sh" from RFC9314 and augments.
<CODE BEGINS> file "ietf-bfd-ip-sh-ext@2022-02-22.yang"
module ietf-bfd-ip-sh-ext {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bfd-ip-sh-ext";
prefix "bfd-ip-sh-ext";
import ietf-bfd {
prefix "bfd";
reference
"RFC 9314: A YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
}
import ietf-routing {
prefix "rt";
reference
"RFC 8349: A YANG Data Model for Routing Management
(NMDA version)";
}
import ietf-bfd-ip-sh {
Rajaguru Expires 5 October 2023 [Page 4]
Internet-Draft BFD YANG April 2023
prefix "bfd-ip-sh";
reference
"RFC 9314: A YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
}
organization "IETF BFD Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/bfd>
WG List: <rtg-bfd@ietf.org>
Editors: Rajaguru Veluchamy (rvelucha@cisco.com)";
description
"This module contains the YANG definition for BFD IP single-hop
as per RFC 5881 with some extended info.
Copyright (c) 2018 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 Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
reference
"RFC 5881: Bidirectional Forwarding Detection (BFD)
for IPv4 and IPv6 (Single Hop)
RFC 9314: YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
revision 2022-02-18 {
description "Initial revision.";
reference
"RFC XXXX: A YANG data model for BFD IP single-hop extension";
}
/*
* Augments
*/
augment "/rt:routing/rt:control-plane-protocols/"
+ "rt:control-plane-protocol/bfd:bfd/bfd-ip-sh:ip-sh/"
+ "bfd-ip-sh:sessions/bfd-ip-sh:session" {
Rajaguru Expires 5 October 2023 [Page 5]
Internet-Draft BFD YANG April 2023
description "BFD augmentation for IP single-hop-ext";
leaf session-offloaded {
type boolean;
description
"Indicates whether BFD session is running in hardware";
}
}
}
<CODE ENDS>
7. BFD IP multi-hop ext YANG Module
This YANG module imports "ietf-bfd-ip-mh" from RFC9314 and augments.
<CODE BEGINS> file "ietf-bfd-ip-mh-ext@2022-02-22.yang"
module ietf-bfd-ip-mh-ext {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bfd-ip-mh-ext";
prefix "bfd-ip-mh-ext";
import ietf-bfd {
prefix "bfd";
reference
"RFC 9314: A YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
}
import ietf-routing {
prefix "rt";
reference
"RFC 8349: A YANG Data Model for Routing Management
(NMDA version)";
}
import ietf-bfd-ip-mh {
prefix "bfd-ip-mh";
reference
"RFC 9314: A YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
}
organization "IETF BFD Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/bfd>
WG List: <rtg-bfd@ietf.org>
Editors: Rajaguru Veluchamy (rvelucha@cisco.com)";
Rajaguru Expires 5 October 2023 [Page 6]
Internet-Draft BFD YANG April 2023
description
"This module contains the YANG definition for BFD IP single-hop
as per RFC 5881 with some extended info.
Copyright (c) 2018 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 Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
reference
"RFC 5881: Bidirectional Forwarding Detection (BFD)
for IPv4 and IPv6 (Single Hop)
RFC 9314: YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
revision 2022-02-18 {
description "Initial revision.";
reference
"RFC XXXX: A YANG data model for BFD IP single-hop extension";
}
/*
* Augments
*/
augment "/rt:routing/rt:control-plane-protocols/"
+ "rt:control-plane-protocol/bfd:bfd/bfd-ip-mh:ip-mh/"
+ "bfd-ip-mh:session-groups/bfd-ip-mh:session-group" {
description "BFD augmentation for IP multi-hop-ext";
leaf session-offloaded {
type boolean;
description
"Indicates whether BFD session is running in hardware";
}
}
}
<CODE ENDS>
Rajaguru Expires 5 October 2023 [Page 7]
Internet-Draft BFD YANG April 2023
8. BFD Over LAG ext YANG Module
This YANG module imports "ietf-bfd-lag" from RFC9314 and augments.
<CODE BEGINS> file "ietf-bfd-lag-ext@2022-02-22.yang"
module ietf-bfd-lag-ext {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bfd-lag-ext";
prefix "bfd-lag-ext";
import ietf-bfd {
prefix "bfd";
reference
"RFC 9314: A YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
}
import ietf-routing {
prefix "rt";
reference
"RFC 8349: A YANG Data Model for Routing Management
(NMDA version)";
}
import ietf-bfd-lag {
prefix "bfd-lag";
reference
"RFC 9314: A YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
}
organization "IETF BFD Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/bfd>
WG List: <rtg-bfd@ietf.org>
Editors: Rajaguru Veluchamy (rvelucha@cisco.com)";
description
"This module contains the YANG definition for BFD IP single-hop
as per RFC 5881 with some extended info.
Copyright (c) 2018 IETF Trust and the persons
identified as authors of the code. All rights reserved.
Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
Rajaguru Expires 5 October 2023 [Page 8]
Internet-Draft BFD YANG April 2023
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
reference
"RFC 5881: Bidirectional Forwarding Detection (BFD)
for IPv4 and IPv6 (Single Hop)
RFC 9314: YANG Data Model for Bidirectional Forwarding
Detection (BFD)";
revision 2022-02-18 {
description "Initial revision.";
reference
"RFC XXXX: A YANG data model for BFD IP single-hop extension";
}
/*
* Augments
*/
augment "/rt:routing/rt:control-plane-protocols/"
+ "rt:control-plane-protocol/bfd:bfd/bfd-lag:lag/"
+ "bfd-lag:sessions/bfd-lag:session" {
description "BFD augmentation for LAG ext";
leaf session-offloaded {
type boolean;
description
"Indicates whether BFD session is running in hardware";
}
}
}
<CODE ENDS>
9. Security Considerations
Security considerations defined in [RFC9314] apply here too .
10. IANA Considerations
This document registers the following namespace URIs in the "IETF XML
Registry" [RFC3688] :
URI: urn:ietf:params:xml:ns:yang:ietf-bfd-ip-sh-ext
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-bfd-ip-mh-ext
Rajaguru Expires 5 October 2023 [Page 9]
Internet-Draft BFD YANG April 2023
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-bfd-lag-ext
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
This document registers the following YANG modules in the "YANG
Module Names" registry [RFC6020] :
Name: ietf-bfd-ip-sh-ext
Namespace: urn:ietf:params:xml:ns:yang:ietf-bfd-ip-sh-ext
Prefix: bfd-ip-sh
Reference: RFC 9314
Name: ietf-bfd-ip-mh-ext
Namespace: urn:ietf:params:xml:ns:yang:ietf-bfd-ip-mh-ext
Prefix: bfd-ip-mh
Reference: RFC 9314
Name: ietf-bfd-lag
Namespace: urn:ietf:params:xml:ns:yang:ietf-bfd-lag
Prefix: bfd-lag
Reference: RFC 9314
11. Acknowledgements
I would like to thank Vengada Prasad Govindan for his support and
guidance on this work.
12. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection
(BFD)", RFC 5880, DOI 10.17487/RFC5880, June 2010,
<https://www.rfc-editor.org/info/rfc5880>.
Rajaguru Expires 5 October 2023 [Page 10]
Internet-Draft BFD YANG April 2023
[RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection
(BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881,
DOI 10.17487/RFC5881, June 2010,
<https://www.rfc-editor.org/info/rfc5881>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
Routing Management (NMDA Version)", RFC 8349,
DOI 10.17487/RFC8349, March 2018,
<https://www.rfc-editor.org/info/rfc8349>.
[RFC9314] Jethanandani, M., Ed., Rahman, R., Ed., Zheng, L., Ed.,
Pallagatti, S., and G. Mirsky, "YANG Data Model for
Bidirectional Forwarding Detection (BFD)", RFC 9314,
DOI 10.17487/RFC9314, September 2022,
<https://www.rfc-editor.org/info/rfc9314>.
Appendix A. Change log
RFC Editor: Remove this section upon publication as an RFC.
Author's Address
Rajaguru Veluchamy (editor)
Cisco Systems
India
Email: rvelucha@cisco.com
Rajaguru Expires 5 October 2023 [Page 11]
