module ietf-detnet{
namespace "urn:ietf:params:xml:ns:yang:ietf-detnet";
//yang-version 1.1;
prefix "detnet-flow";
import ietf-yang-types {
prefix "yang";
}
import ietf-interfaces {
prefix "if";
}
import ietf-inet-types{
prefix "inet";
}
/* import ietf-ethertypes {
prefix "eth";
}*/
import ietf-routing-types {
prefix "rt-types";
}
organization "IETF DetNet Working Group";
contact
"WG Web:
WG List:
WG Chair: Lou Berger
Janos Farkas
Editor: Xuesong Geng
Editor: Mach Chen
Editor: Zhenqiang Li
Editor: Reshad Rahman
";
description
"This YANG module describes the parameters needed
for DetNet flow configuration and flow status
reporting.";
revision "2018-09-10" {
description "initial revision";
reference "RFC XXXX: draft-geng-detnet-config-yang-05";
}
feature ipv4-tunnel {
description
"This feature means that a node support
IPv4 tunnel encapsulation capability.";
}
feature ipv6-tunnel {
description
"This feature means that a node support
IPv6 tunnel encapsulation capability.";
}
feature mpls-tunnel {
description
"This feature means that a node support
MPLS tunnel encapsulation capability.";
}
feature mpls-over-udp-tunnel {
description
"This feature means that a node supports
MPLS over UDP tunnel encapsulation
capability.";
}
feature detnet-mpls-dp-sol {
description
"This feature means that MPLS data plane
solution is supported.";
}
identity detnet-node-role {
description
"base detnet-node-role";
}
identity end-station {
base detnet-node-role;
description
"Commonly called a 'host' in IETF documents,
and an 'end station' is IEEE 802 documents.
End systems of interest to this document
are either sources or destinations of DetNet
flows. And end system may or may not be
DetNet transport layer aware or DetNet
service layer aware.";
}
identity edge-node {
base detnet-node-role;
description
"An instance of a DetNet relay node that
includes either a DetNet service layer proxy
function for DetNet service protection (e.g.
the addition or removal of packet sequencing
information) for one or more end systems, or
starts or terminate congestion protection at
the DetNet transport layer,analogous to a
Label Edge Router (LER).";
}
identity relay-node {
base detnet-node-role;
description
"A DetNet node including a service layer
function that interconnects different DetNet
transport layer paths to provide service
protection. A DetNet relay node can be a bridge,
a router, a firewall, or any other system that
participates in the DetNet service layer. It
typically incorporates DetNet transport layer
functions as well, in which case it is
collocated with a transit node.";
}
identity transit-node {
base detnet-node-role;
description
"A node operating at the DetNet transport layer,
that utilizes link layer and/or network layer
switching across multiple links and/or
sub-networks to provide paths for DetNet
service layer functions. Optionally provides
congestion protection over those paths. An MPLS
LSR is an example of a DetNet transit node.";
}
identity tunnel-decap-action {
description
"Base identify from which all tunnel decap
actions are derived.
Tunnel decap actions include:
ipv4-decap - to decap an IPv4 tunnel,
ipv6-decap - to decap an IPv6 tunnel.";
}
identity ipv4-decap {
base "tunnel-decap-action";
description
"IPv4 tunnel decap.";
}
identity ipv6-decap {
base "tunnel-decap-action";
description
"IPv4 tunnel decap.";
}
typedef tunnel-decap-action-def {
type identityref {
base "tunnel-decap-action";
}
description
"Tunnel decap def.";
}
identity ttl-action {
description
"Base identity from which all TTL
actions are derived.";
}
identity no-action {
base "ttl-action";
description
"Do nothing regarding the TTL.";
}
identity copy-to-inner {
base "ttl-action";
description
"Copy the TTL of the outer header
to the inner header.";
}
identity decrease-and-copy-to-inner {
base "ttl-action";
description
"Decrease TTL by one and copy the TTL
to the inner header.";
}
typedef ttl-action-def {
type identityref {
base "ttl-action";
}
description
"TTL action definition.";
}
identity hop-limit-action {
description
"Base identity from which all hop limit
actions are derived.";
}
typedef hop-limit-action-def {
type identityref {
base "hop-limit-action";
}
description
"hop limit action definition.";
}
identity mpls-label-action {
description
"Base identity from which all MPLS label
operations are derived.
The MPLS label stack operations include:
push - to add a new label to a label stack,
pop - to pop the top label from a label stack,
swap - to exchange the top label of a label
stack with new label.";
}
identity label-push {
base "mpls-label-action";
description
"MPLS label stack operation: push.";
}
identity label-pop {
base "mpls-label-action";
description
"MPLS label stack operation: pop.";
}
identity label-swap {
base "mpls-label-action";
description
"MPLS label stack operation: swap.";
}
typedef mpls-label-action-def {
type identityref {
base "mpls-label-action";
}
description
"MPLS label action definition.";
}
identity detnet-transport-layer {
description
"The layer that optionally provides congestion
protection for DetNet flows over paths provided
by the underlying network.";
}
identity detnet-service-layer {
description
"The layer at which service protection is
provided, either packet sequencing, replication,
and elimination or packet encoding";
}
typedef service-function-type {
type enumeration {
enum null {
description
"No service function is enabled.";
}
enum replication {
description
"A Packet Replication Function (PRF) replicates
DetNet flow packets and forwards them to one or
more next hops in the DetNet domain. The number
of packet copies sent to each next hop is a
DetNet flow specific parameter at the node doing
the replication. PRF can be implemented by an
edge node, a relay node, or an end system";
}
enum elimination {
description
"A Packet Elimination Function (PEF) eliminates
duplicate copies of packets to prevent excess
packets flooding the network or duplicate
packets being sent out of the DetNet domain.
PEF can be implemented by an edge node, a relay
node, or an end system.";
}
enum ordering {
description
"A Packet Ordering Function (POF) re-orders
packets within a DetNet flow that are received
out of order. This function can be implemented
by an edge node, a relay node, or an end system.";
}
enum elimination-ordering {
description
"A combination of PEF and POF that can be
implemented by an edge node, a relay node, or
an end system.";
}
enum elimination-replication {
description
"A combination of PEF and PRF that can be
implemented by an edge node, a relay node, or
an end system";
}
enum elimination-ordering-replicaiton {
description
"A combination of PEF, POF and PRF that can be
implemented by an edge node, a relay node, or
an end system";
}
}
description
"DetNet service function and function combination
types.";
}
typedef sequence-number-generation {
type enumeration {
enum "copy-from-app-flow" {
description
"DetNet flow sequence number is copied
from application flow.";
}
enum "generated-by-edge-node" {
description
"DetNet flow sequence number is generated
by DetNet edge node.";
}
}
description
"DetNet sequence number generation types.";
}
grouping detnet-sequence-number {
description
"DetNet sequence number.";
leaf sequence-number-generation-type {
type sequence-number-generation;
description
"The way on how sequence number is generated.";
}
leaf sequence-number-length {
type uint8;
description
"DetNet sequence number length.";
}
}
grouping detnet-transport-identifier {
description
"DetNet transport identifier";
}
grouping detnet-transport-qos {
//Editor notes: this will be defined in a separate
// YANG model (detnet-transport-qos).
// More inputs and discussions are needed here.
description
"DetNet transport tunnel QoS attributes.";
uses traffic-specification;
}
grouping ipv4-header {
description
"The IPv4 header encapsulation information.";
leaf src-ipv4-address {
type inet:ipv4-address;
mandatory true;
description
"The source IP address of the header.";
}
leaf dest-ipv4-address {
type inet:ipv4-address;
mandatory true;
description
"The destination IP address of the header.";
}
leaf protocol {
type uint8;
mandatory true;
description
"The protocol id of the header.";
}
leaf ttl {
type uint8;
description
"The TTL of the header.";
}
leaf dscp {
type uint8;
description
"The DSCP field of the header.";
}
}
grouping ipv6-header {
description
"The IPv6 header encapsulation information.";
leaf src-ipv6-address {
type inet:ipv6-address;
mandatory true;
description
"The source IP address of the header.";
}
leaf dest-ipv6-address {
type inet:ipv6-address;
mandatory true;
description
"The destination IP address of the header.";
}
leaf next-header {
type uint8;
mandatory true;
description
"The next header of the IPv6 header.";
}
leaf traffic-class {
type uint8;
description
"The traffic class value of the header.";
}
leaf flow-label {
type inet:ipv6-flow-label;
description
"The flow label of the header.";
}
leaf hop-limit {
type uint8 {
range "1..255";
}
description
"The hop limit of the header.";
}
}
grouping mpls-header {
description
"The MPLS encapsulation header information.";
list label-operations {
key "label-oper-id";
description
"Label operations.";
leaf label-oper-id {
type uint32;
description
"An optional identifier that points
to a label operation.";
}
choice label-actions {
description
"Label action options.";
case label-push {
container label-push {
description
"Label push operation.";
leaf label {
type uint32;
mandatory true;
description
"The label to be pushed.";
}
leaf s-bit {
type boolean;
description
"The s-bit of the label to be pushed.";
}
leaf tc-value {
type uint8;
description
"The traffic class value of the label
to be pushed.";
}
leaf ttl-value {
type uint8;
description
"The TTL value of the label to be
pushed.";
}
}
}
case label-swap {
container label-swap {
description
"Label swap operation.";
leaf out-label {
type uint32;
mandatory true;
description
"The out MPLS label.";
}
leaf ttl-action {
type ttl-action-def;
description
"The label ttl actions:
- No-action, or
- Copy to inner label,or
- Decrease (the in label) by 1 and
copy to the out label.";
}
}
}
}
}
}
grouping mpls-detnet-header {
description
"The MPLS DetNet encapsulation header information.";
leaf service-label {
type uint32;
mandatory true;
description
"The service label of the DetNet header.";
}
leaf control-word {
type uint32;
description
"The control word of the DetNet header.";
}
}
grouping udp-header {
description
"UDP header.";
leaf source-port {
type inet:port-number;
description
"The source port number.";
}
leaf destination-port {
type inet:port-number;
description
"The destination port number.";
}
}
grouping transport-tunnel-encap {
description
"Defines the transport tunnel encapsulation
header.";
choice tunnel-type {
description
"Tunnel type includes: IPv4, IPv6, MPLS,
MPLS over UDP tunnels.";
case IPv4 {
if-feature ipv4-tunnel;
description
"IPv4 tunnel.";
container ipv4-encapsulation {
description
"IPv4 encapsulation.";
uses ipv4-header;
}
}
case IPv6 {
if-feature ipv6-tunnel;
description
"IPv6 tunnel.";
container ipv6-encapsulation {
description
"IPv6 encapsulation.";
uses ipv6-header;
}
}
case MPLS {
if-feature mpls-tunnel;
description
"MPLS tunnel.";
container mpls-encapsulation {
description
"MPLS encapsulation.";
uses mpls-header;
}
}
case MPLS-over-UDP {
if-feature mpls-over-udp-tunnel;
description
"MPLS over UDP tunnel.";
container mpls-over-udp-encaplustion {
description
"MPLS over udp encapsulation.";
uses mpls-header;
uses udp-header;
choice address-family {
description
"According to IP address family(IPv4 and IPv6)
to apply corresponding IP header.";
case IPv4 {
description
"IPv4 address family.";
uses ipv4-header;
}
case IPv6 {
description
"IPv6 address family.";
uses ipv6-header;
}
}
}
}
}
}
grouping transport-tunnel-decap {
description
"Tunnel decapsulation inforamtion.";
choice tunnel-type {
description
"Nexthop tunnel type options.";
case ipv4 {
if-feature ipv4-tunnel;
container ipv4-decap {
description
"IPv4 decap.";
leaf ipv4-decap {
type tunnel-decap-action-def;
mandatory true;
description
"IPv4 decap operations.";
}
leaf ttl-action {
type ttl-action-def;
description
"The ttl actions:
no-action or copy to inner header.";
}
}
}
case ipv6 {
if-feature ipv6-tunnel;
container ipv6-decap {
description
"IPv6 decap.";
leaf ipv6-decap {
type tunnel-decap-action-def;
mandatory true;
description
"IPv6 decap operations.";
}
leaf hop-limit-action {
type hop-limit-action-def;
description
"The hop limit actions:
no-action or copy to inner header.";
}
}
}
case mpls {
if-feature mpls-tunnel;
container label-pop {
description
"MPLS decap.";
leaf label-pop {
type mpls-label-action-def;
mandatory true;
description
"Pop a label from the label stack.";
}
leaf ttl-action {
type ttl-action-def;
description
"The label ttl actions:
no-action or copy to inner label/header.";
}
}
}
}
}
grouping detnet-transport-instance {
description
"An instance of the DetNet transport layer, which
depends on the specific data plane that is used
as the underlay tunnel.";
uses transport-tunnel-encap;
uses detnet-transport-qos;
}
grouping ipv6-flow-identification {
description
"IPv6 flow identification.";
leaf src-ipv6-address {
type inet:ipv6-address;
description
"The source IP address of the header.";
}
leaf dest-ipv6-address {
type inet:ipv6-address;
description
"The destination IP address of the header.";
}
leaf traffic-class {
type uint8;
description
"The traffic class value of the header.";
}
leaf flow-label {
type inet:ipv6-flow-label;
description
"The flow label of the header.";
}
leaf source-port {
type inet:port-number;
description
"The source port number.";
}
leaf destination-port {
type inet:port-number;
description
"The destination port number.";
}
leaf protocol {
type uint8;
description
"The protocol id of the header.";
}
}
grouping ipv4-flow-identification {
description
"IPv4 flow identification.";
leaf src-ipv4-address {
type inet:ipv4-address;
description
"The source IP address of the header of
a DetNet flow.";
}
leaf dest-ipv4-address {
type inet:ipv4-address;
description
"The destination IP address of the header
of a DetNet flow.";
}
leaf dscp {
type uint8;
description
"The DSCP field of the header of a DetNet flow..";
}
leaf source-port {
type inet:port-number;
description
"The source port number.";
}
leaf destination-port {
type inet:port-number;
description
"The destination port number.";
}
leaf protocol {
type uint8;
description
"The protocol id of the header of a DetNet flow..";
}
}
grouping ip-flow-identification {
description
"IP flow identification.";
choice ip-flow-type {
description
"IP flow types: IPv4, IPv6.";
case ipv4 {
description
"IPv4 flow identification.";
leaf src-ipv4-address {
type inet:ipv4-address;
description
"The source IP address of the header.";
}
leaf dest-ipv4-address {
type inet:ipv4-address;
description
"The destination IP address of the header.";
}
leaf dscp {
type uint8;
description
"The DSCP field of the header.";
}
}
case ipv6 {
description
"IPv6 flow identification.";
leaf src-ipv6-address {
type inet:ipv6-address;
description
"The source IP address of the header.";
}
leaf dest-ipv6-address {
type inet:ipv6-address;
description
"The destination IP address of the header.";
}
leaf traffic-class {
type uint8;
description
"The traffic class value of the header.";
}
leaf flow-label {
type inet:ipv6-flow-label;
description
"The flow label of the header.";
}
}
}
leaf source-port {
type inet:port-number;
description
"The source port number.";
}
leaf destination-port {
type inet:port-number;
description
"The destination port number.";
}
leaf protocol {
type uint8;
description
"The protocol id of the header.";
}
}
grouping l3-flow-identification {
description
"Layer 3 flow identification in a DetNet
domain.";
choice flow-type {
description
"L3 DetNet flow types: IP and MPLS.";
case IP {
description
"IP (IPv4 or IPv6) flow identification.";
uses ip-flow-identification;
}
case MPLS {
description
"MPLS flow identification.";
leaf service-label {
type uint32;
mandatory true;
description
"The service label of a DetNet flow.";
}
}
}
} //l3-flow-identification
grouping in-segments {
description
"From a receiving node point of view, In-segments
are a set of instances of a DetNet flow at the
receiving node. This occurs when Packet Replication
Function (PRF) is enabled at an upstream node or
multiple flows map/aggregate to a single DetNet
flow.";
list in-segment {
key "in-segment-id";
description
"A list of in segments, there will be
multiple in-segments for a DetNet flow
when PRF and PEF enabled.";
leaf in-segment-id {
type uint32;
description
"in-segment identifier.";
}
uses l3-flow-identification;
leaf service-function {
type service-function-type;
description
"DetNet service function indication.";
}
}
}
grouping out-segments {
description
"Out-segments are a set of instances of
a DetNet flow, this occurs when implement
packet replication function, where an
in-segment of a DetNet flow is replicated
to multiple out-segments.";
list out-segment {
key "out-segment-id";
description
"A list of segments, there will be multiple
out-segments when perform PRF.";
leaf out-segment-id {
type uint32;
description
"The out-segment identifier";
}
container detnet-service-encapsulation {
description
"Only MPLS based DetNet defines DetNet
service layer. The service encapsulation
includes service label and control word.";
uses mpls-detnet-header;
}
container detnet-transport-encapsulation {
description
"Each out-segment corresponds to a
transport instance.";
uses detnet-transport-instance;
}
}
}
grouping detnet-service-instance {
description
"An end-2-end DetNet service is consisted of
multiple segments. The concept of segment is
similar to PW segment. For DetNet, since the
existing of PREOF, there could be three cases:
1 - One in-segment maps to multiple
out-segments, when implement PRF;
2 - Multiple in-segments map to one
out-segment, when implement PEF;
3 - Multiple in-segments map to multiple
out-segments, when implement a combination
of PEF and PRF.";
leaf name {
type string;
description
"The name of the service instance. This MUST
be unique across all service instances in
a given network device.";
}
leaf service-rank {
type boolean;
description
"Service rank is used by the network to decide
which services can and cannot exist when network
resources reach their limit. Rank is used to help
to determine which services can be dropped (i.e.,
removed from node configuration) if a port of a
node becomes oversubscribed (e.g., due to network
reconfiguration). The true value is more important
than the false value (i.e., services with false
are dropped first).";
reference
"draft-ietf-detnet-flow-information-model";
}
uses in-segments;
uses out-segments;
}
grouping l2-flow-identification-at-uni {
description
"Layer 2 flow identification at UNI.";
leaf source-mac-address {
type yang:mac-address;
description
"The source MAC address used for
flow identification.";
}
leaf destination-mac-address {
type yang:mac-address;
description
"The destination MAC address used for
flow identification.";
}
/* leaf ethertype {
type eth:ethertype;
description
"The Ethernet Type (or Length) value represented
in the canonical order defined by IEEE 802.
The canonical representation uses lowercase
characters.";
reference
"IEEE 802-2014 Clause 9.2";
}
*/
leaf vlan-id {
type uint16 {
range "1..4094";
}
description
"Vlan Identifier used for L2 flow identification.";
}
container pcp {
//Todo
description
"PCP used for L2 flow identification.";
}
}
grouping l3-flow-identification-at-uni {
description
"Layer 3 flow identification at UNI.";
uses ip-flow-identification;
}
grouping traffic-specification {
description
"traffic-specification specifies how the Source
transmits packets for the flow. This is the
promise/request of the Source to the network.
The network uses this traffic specification
to allocate resources and adjust queue
parameters in network nodes.";
reference
"draft-ietf-detnet-flow-information-model";
leaf interval {
type uint32;
description
"The period of time in which the traffic
specification cannot be exceeded";
}
leaf max-packets-per-interval {
type uint32;
description
"The maximum number of packets that the
source will transmit in one Interval.";
}
leaf max-payload-size {
type uint32;
description
"The maximum payload size that the source
will transmit.";
}
leaf average-packets-per-interval {
type uint32;
description
"The average number of packets that the
source will transmit in one Interval";
}
leaf average-payload-size {
type uint32;
description
"The average payload size that the
source will transmit.";
}
}
grouping client-flows-at-uni {
description
"The attributes of the client flow at UNI. When
flow aggregation is enabled at ingress, multiple
client flows map to a DetNet service instance.";
list client-flow {
key "flow-id";
description
"A list of client flows.";
leaf flow-id {
type uint32;
description
"Flow identifier that is unique in a network
device for client flow identification";
}
leaf flow-rank {
type boolean;
description
"Flow rank is used by the network
to decide which flows can and cannot exist
when network resources reach their limit.
Rank is used to help to determine which flows
can be dropped (i.e., removed from node
configuration) if a port of a node becomes
oversubscribed (e.g., due to network
reconfiguration). The true value is more
important than the false value (i.e., flows
with false are dropped first).";
reference
"draft-ietf-detnet-flow-information-model";
}
choice flow-type {
description
"Client flow type: layer 2 flow, layer 3
flow.";
case l2-flow {
description
"Ethernet flow identification.";
uses l2-flow-identification-at-uni;
}
case l3-flow {
description
"Layer 3 flow identification, including
IPv4,IPv6 and MPLS.";
uses l3-flow-identification-at-uni;
}
}
container traffic-specification {
description
"The traffic specification of the client flow.";
uses traffic-specification;
}
}
}
grouping detnet-service-decap {
description
"DetNet service decapsulation inforamtion.";
leaf service-label-pop {
type mpls-label-action-def;
mandatory true;
description
"Pop the DetNet service label.";
}
leaf ttl-action {
type ttl-action-def;
description
"The label ttl actions:
no-action or copy to inner label/header.";
}
}
grouping detnet-service-proxy-instance {
description
"Mapping between App-flows and DetNet flows.";
choice edge-node-type {
description
"There are two types of edge node: ingress node and
egress node";
case ingress-node {
uses client-flows-at-uni;
leaf service-function {
type service-function-type;
description
"DetNet service function indication.";
}
uses detnet-sequence-number;
uses out-segments;
}
case egress-node {
uses in-segments;
uses transport-tunnel-decap;
uses detnet-service-decap;
}
}
}
container detnet-flow {
description
"DetNet flow configuration and status reporting.";
choice detnet-node-role{
description
"Depends on the role of a node to configure
corresponding flow parameters.";
case transit-node {
description
"DetNet flow configuration parameters for
transit nodes.";
container transit-node {
description
"Transit node container.";
uses detnet-transport-qos;
}
}
case relay-node {
if-feature detnet-mpls-dp-sol;
description
"DetNet flow configuration parameters for
relay nodes.";
container relay-node {
description
"Relay node container.";
uses detnet-service-instance;
}
}
case edge-node {
if-feature detnet-mpls-dp-sol;
description
"DetNet flow configuration parameters for
edge nodes.";
container edge-node {
description
"Edge node container.";
uses detnet-service-proxy-instance;
}
}
case end-station {
description
"DetNet flow configuration parameters for
end stations.";
container end-station {
description
"End station container.";
uses detnet-service-proxy-instance;
}
}
}
}
}