draft-ietf-lsr-yang-isis-reverse-metric-04.txt   draft-ietf-lsr-yang-isis-reverse-metric-05.txt 
Network Working Group C. Hopps Network Working Group C. Hopps
Internet-Draft LabN Consulting, L.L.C. Internet-Draft LabN Consulting, L.L.C.
Intended status: Standards Track 24 October 2021 Intended status: Standards Track 11 December 2021
Expires: 27 April 2022 Expires: 14 June 2022
YANG Module for IS-IS Reverse Metric YANG Module for IS-IS Reverse Metric
draft-ietf-lsr-yang-isis-reverse-metric-04 draft-ietf-lsr-yang-isis-reverse-metric-05
Abstract Abstract
This document defines a YANG module for managing the reverse metric This document defines a YANG module for managing the reverse metric
extension to the Intermediate System to Intermediate System intra- extension to the Intermediate System to Intermediate System intra-
domain routeing information exchange protocol (IS-IS). domain routeing information exchange protocol (IS-IS).
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
skipping to change at page 1, line 32 skipping to change at page 1, line 32
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on 27 April 2022. This Internet-Draft will expire on 14 June 2022.
Copyright Notice Copyright Notice
Copyright (c) 2021 IETF Trust and the persons identified as the Copyright (c) 2021 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/ Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document. license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text extracted from this document must include Revised BSD License text as
as described in Section 4.e of the Trust Legal Provisions and are described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License. provided without warranty as described in the Revised BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. YANG Management . . . . . . . . . . . . . . . . . . . . . . . 2 2. YANG Management . . . . . . . . . . . . . . . . . . . . . . . 2
2.1. YANG Tree . . . . . . . . . . . . . . . . . . . . . . . . 2 2.1. YANG Tree . . . . . . . . . . . . . . . . . . . . . . . . 2
2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 3 2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 3
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8
3.1. Updates to the IETF XML Registry . . . . . . . . . . . . 8 3.1. Updates to the IETF XML Registry . . . . . . . . . . . . 8
3.2. Updates to the YANG Module Names Registry . . . . . . . . 8 3.2. Updates to the YANG Module Names Registry . . . . . . . . 8
skipping to change at page 4, line 5 skipping to change at page 4, line 5
| +--ro whole-lan? boolean | +--ro whole-lan? boolean
| +--ro allow-unreachable? boolean | +--ro allow-unreachable? boolean
+--ro te-metric? uint32 +--ro te-metric? uint32
2.2. YANG Module 2.2. YANG Module
The following is the YANG module for managing the IS-IS reverse The following is the YANG module for managing the IS-IS reverse
metric functionality defined in [RFC8500]. It imports modules from metric functionality defined in [RFC8500]. It imports modules from
the following RFCs: [RFC8349], [I-D.ietf-isis-yang-isis-cfg]. the following RFCs: [RFC8349], [I-D.ietf-isis-yang-isis-cfg].
<CODE BEGINS> file "ietf-isis-reverse-metric@2021-10-24.yang" <CODE BEGINS> file "ietf-isis-reverse-metric@2021-12-11.yang"
module ietf-isis-reverse-metric { module ietf-isis-reverse-metric {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-isis-reverse-metric"; namespace "urn:ietf:params:xml:ns:yang:ietf-isis-reverse-metric";
prefix isis-rmetric; prefix isis-rmetric;
import ietf-routing { import ietf-routing {
prefix rt; prefix rt;
reference reference
"RFC8349: "RFC8349:
A YANG Data Model for Routing Management (NMDA Version)"; A YANG Data Model for Routing Management (NMDA Version)";
skipping to change at page 4, line 28 skipping to change at page 4, line 28
prefix isis; prefix isis;
reference reference
"draft-ietf-isis-yang-isis-cfg-42: "draft-ietf-isis-yang-isis-cfg-42:
YANG Data Model for IS-IS Protocol"; YANG Data Model for IS-IS Protocol";
} }
organization organization
"IETF LSR Working Group (LSR)"; "IETF LSR Working Group (LSR)";
contact contact
"WG Web: <https://tools.ietf.org/wg/lsr/> "WG Web: <https://datatracker.ietf.org/wg/lsr/>
WG List: <mailto:lsr@ietf.org> WG List: <mailto:lsr@ietf.org>
Author: Christian Hopps Author: Christian Hopps
<mailto:chopps@chopps.org>"; <mailto:chopps@chopps.org>";
// RFC Ed.: replace XXXX with actual RFC number and // RFC Ed.: replace XXXX with actual RFC number and
// remove this note. // remove this note.
description description
"This module defines the configuration and operational state for "This module defines the configuration and operational state for
skipping to change at page 4, line 52 skipping to change at page 4, line 52
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(https://trustee.ietf.org/license-info). (https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX This version of this YANG module is part of RFC XXXX
(https://tools.ietf.org/html/rfcXXXX); see the RFC itself for (https://www.rfc-editor.org/info/rfcXXXX>); see the RFC itself
full legal notices."; for full legal notices.";
revision 2021-10-24 { revision 2021-12-11 {
description "Initial Revision"; description "Initial Revision";
reference "RFC XXXX: YANG IS-IS Reverse Metric"; reference "RFC XXXX: YANG IS-IS Reverse Metric";
} }
grouping reverse-metric-data { grouping reverse-metric-data {
description "IS-IS reverse metric data."; description "IS-IS reverse metric data.";
leaf metric { leaf metric {
type isis:wide-metric; type isis:wide-metric;
description "The reverse metric value."; description "The reverse metric value.";
reference "RFC8500, Section 2"; reference "RFC8500, Section 2";
skipping to change at page 5, line 18 skipping to change at page 5, line 18
reference "RFC XXXX: YANG IS-IS Reverse Metric"; reference "RFC XXXX: YANG IS-IS Reverse Metric";
} }
grouping reverse-metric-data { grouping reverse-metric-data {
description "IS-IS reverse metric data."; description "IS-IS reverse metric data.";
leaf metric { leaf metric {
type isis:wide-metric; type isis:wide-metric;
description "The reverse metric value."; description "The reverse metric value.";
reference "RFC8500, Section 2"; reference "RFC8500, Section 2";
} }
container flags { container flags {
description "The reverse metric flag values."; description "The reverse metric flag values.";
leaf whole-lan { leaf whole-lan {
type boolean; type boolean;
description description
"The 'whole LAN' or W-bit. If true then a DIS processing "The 'whole LAN' or W-bit. If true then a DIS processing
this reverse metric will add the metric value to all the this reverse metric will add the metric value to all the
nodes it advertises in the pseudo-node LSP for this nodes it advertises in the pseudo-node LSP for this
interface. Otherwise it will only increment the metric interface. Otherwise, it will only increment the metric
for the advertising node in the pseudo-node LSP for this for the advertising node in the pseudo-node LSP for this
interface."; interface.";
reference "RFC8500, Section 2"; reference "RFC8500, Section 2";
} }
leaf allow-unreachable { leaf allow-unreachable {
type boolean; type boolean;
description description
"The 'allow-unreachable' or U-bit. If true it allows the "The 'allow-unreachable' or U-bit. If true it allows the
neighbor to increment the overall metric up to 2^24-1 neighbor to increment the overall metric up to 2^24-1
rather than the lesser maximum of 2^24-2. If the metric rather than the lesser maximum of 2^24-2. If the metric
skipping to change at page 6, line 10 skipping to change at page 6, line 9
container reverse-metric { container reverse-metric {
description "IS-IS reverse metric data."; description "IS-IS reverse metric data.";
uses reverse-metric-data; uses reverse-metric-data;
leaf exclude-te-metric { leaf exclude-te-metric {
type boolean; type boolean;
default false; default false;
description description
"If true and there is a TE metric defined for this "If true and there is a TE metric defined for this
interface then do not send the TE metric sub-TLV in the interface then do not send the TE metric sub-TLV in the
reverse metric TLV."; reverse metric TLV.";
reference "RFC8500, Section 3.5";
reference "RFC8500, Section 2";
} }
} }
} }
grouping tlv16-reverse-metric { grouping tlv16-reverse-metric {
description "IS-IS reverse metric TLV data."; description "IS-IS reverse metric TLV data.";
container reverse-metric { container reverse-metric {
description "IS-IS reverse metric TLV data."; description "IS-IS reverse metric TLV data.";
uses reverse-metric-data; uses reverse-metric-data;
leaf te-metric { leaf te-metric {
type uint32; type uint32;
description description
"The TE metric value from the sub-TLV if present."; "The TE metric value from the sub-TLV if present.";
reference "RFC8500, Section 3.5"; reference "RFC8500, Section 2";
} }
} }
} }
augment "/rt:routing/rt:control-plane-protocols/" augment "/rt:routing/rt:control-plane-protocols/"
+"rt:control-plane-protocol/" +"rt:control-plane-protocol/"
+"isis:isis" { +"isis:isis" {
when "derived-from-or-self(../rt:type, 'isis:isis')" { when "derived-from-or-self(../rt:type, 'isis:isis')" {
description description
"This augment is only valid when routing protocol instance "This augment is only valid when routing protocol instance
skipping to change at page 6, line 48 skipping to change at page 6, line 48
description description
"The reverse metric configuration for an IS-IS instance."; "The reverse metric configuration for an IS-IS instance.";
container reverse-metric { container reverse-metric {
description "Global reverse metric configuration."; description "Global reverse metric configuration.";
leaf enable-receive { leaf enable-receive {
type boolean; type boolean;
default false; default false;
description description
"Enable handling of reverse metric announcements from "Enable handling of reverse metric announcements from
neighbors. By default reverse metric handling is disabled neighbors. By default, reverse metric handling is disabled
and must be explicitly enabled through this and must be explicitly enabled through this
configuration."; configuration.";
} }
} }
} }
augment "/rt:routing/rt:control-plane-protocols/" augment "/rt:routing/rt:control-plane-protocols/"
+"rt:control-plane-protocol/" +"rt:control-plane-protocol/"
+"isis:isis/isis:interfaces/isis:interface" { +"isis:isis/isis:interfaces/isis:interface" {
skipping to change at page 9, line 10 skipping to change at page 9, line 10
The YANG module defined in this document can enable, disable and The YANG module defined in this document can enable, disable and
modify the behavior of metrics used by routing. For the security modify the behavior of metrics used by routing. For the security
implications regarding these types of changes consult [RFC8500] which implications regarding these types of changes consult [RFC8500] which
defines the functionality. defines the functionality.
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., "config true", which is the writable/creatable/deletable (i.e., "config true", which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., edit-config) in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative to these data nodes without proper protection can have a negative
effect on network operations. effect on network operations. These YANG nodes correspond directly
to the RFC 8500 functionality and the security considerations of the
functionality are described in RFC 8500.
These are the subtrees and data nodes and their sensitivity/ These are the subtrees and data nodes:
vulnerability:
Under "/rt:routing/rt:control-plane-protocols/" + Under "/rt:routing/rt:control-plane-protocols/" +
"rt:control-plane-protocol/isis:isis" "rt:control-plane-protocol/isis:isis"
- /isis-rmetric:reverse-metric/isis-rmetric:enable-receive - /isis-rmetric:reverse-metric/isis-rmetric:enable-receive
Under "/rt:routing/rt:control-plane-protocols/" + Under "/rt:routing/rt:control-plane-protocols/" +
"rt:control-plane-protocol/isis:isis/" + "rt:control-plane-protocol/isis:isis/" +
"isis:interfaces/isis:interface/" + "isis:interfaces/isis:interface/" +
"isis-rmetric:reverse-metric" "isis-rmetric:reverse-metric"
skipping to change at page 10, line 8 skipping to change at page 10, line 8
"isis:level-2/isis-rmetric:reverse-metric" "isis:level-2/isis-rmetric:reverse-metric"
- /isis-rmetric:metric - /isis-rmetric:metric
- /isis-rmetric:flags/isis-rmetric:whole-lan - /isis-rmetric:flags/isis-rmetric:whole-lan
- /isis-rmetric:flags/isis-rmetric:allow-unreachable - /isis-rmetric:flags/isis-rmetric:allow-unreachable
- /isis-rmetric:exclude-te-metric - /isis-rmetric:exclude-te-metric
Some of the readable data nodes in this YANG module may be considered Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data notification) to these data nodes. These YANG nodes correspond
nodes and their sensitivity/vulnerability: directly to the RFC 8500 functionality and the security
considerations of the functionality are described in RFC 8500. These
All nodes are under the following subtree, so that prefix will be are the subtrees and data nodes:
assumed for each node description.
Under "/rt:routing/rt:control-plane-protocols/" + Under "/rt:routing/rt:control-plane-protocols/" +
"rt:control-plane-protocol/isis:isis/" + "rt:control-plane-protocol/isis:isis/" +
"isis:interfaces/isis:interface/" + "isis:interfaces/isis:interface/" +
"isis:adjacencies/isis:adjacency/" + "isis:adjacencies/isis:adjacency/" +
"isis-rmetric:reverse-metric" "isis-rmetric:reverse-metric"
- /isis-rmetric:metric - /isis-rmetric:metric
- /isis-rmetric:flags/isis-rmetric:whole-lan - /isis-rmetric:flags/isis-rmetric:whole-lan
- /isis-rmetric:flags/isis-rmetric:allow-unreachable - /isis-rmetric:flags/isis-rmetric:allow-unreachable
skipping to change at page 10, line 43 skipping to change at page 10, line 42
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010, DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>. <https://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018, DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>. <https://www.rfc-editor.org/info/rfc8342>.
[RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
Routing Management (NMDA Version)", RFC 8349, Routing Management (NMDA Version)", RFC 8349,
DOI 10.17487/RFC8349, March 2018, DOI 10.17487/RFC8349, March 2018,
<https://www.rfc-editor.org/info/rfc8349>. <https://www.rfc-editor.org/info/rfc8349>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
[RFC8500] Shen, N., Amante, S., and M. Abrahamsson, "IS-IS Routing [RFC8500] Shen, N., Amante, S., and M. Abrahamsson, "IS-IS Routing
with Reverse Metric", RFC 8500, DOI 10.17487/RFC8500, with Reverse Metric", RFC 8500, DOI 10.17487/RFC8500,
February 2019, <https://www.rfc-editor.org/info/rfc8500>. February 2019, <https://www.rfc-editor.org/info/rfc8500>.
[I-D.ietf-isis-yang-isis-cfg] [I-D.ietf-isis-yang-isis-cfg]
Litkowski, S., Yeung, D., Lindem, A., Zhang, J., and L. Litkowski, S., Yeung, D., Lindem, A., Zhang, J., and L.
Lhotka, "YANG Data Model for IS-IS Protocol", Work in Lhotka, "YANG Data Model for IS-IS Protocol", Work in
Progress, Internet-Draft, draft-ietf-isis-yang-isis-cfg- Progress, Internet-Draft, draft-ietf-isis-yang-isis-cfg-
42, 15 October 2019, <https://tools.ietf.org/html/draft- 42, 15 October 2019,
ietf-isis-yang-isis-cfg-42>. <https://datatracker.ietf.org/doc/html/draft-ietf-isis-
yang-isis-cfg-42>.
6. Informative References 6. Informative References
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>. <https://www.rfc-editor.org/info/rfc8340>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
Appendix A. Examples Appendix A. Examples
A.1. Example Enable XML A.1. Example Enable XML
Below is an example of XML instance data to enable reverse metric Below is an example of XML instance data to enable reverse metric
processing. processing.
<rt:routing <rt:routing
xmlns:rt="urn:ietf:params:xml:ns:yang:ietf-routing" xmlns:rt="urn:ietf:params:xml:ns:yang:ietf-routing"
xmlns:isis="urn:ietf:params:xml:ns:yang:ietf-isis" xmlns:isis="urn:ietf:params:xml:ns:yang:ietf-isis"
 End of changes. 21 change blocks. 
44 lines changed or deleted 45 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/