openconfig-aft
HTML
openconfig-aft@2019-11-07
module openconfig-aft { yang-version 1; namespace "http://openconfig.net/yang/aft"; prefix oc-aft; import openconfig-extensions { prefix oc-ext; } include openconfig-aft-ipv4; include openconfig-aft-ipv6; include openconfig-aft-mpls; include openconfig-aft-pf; include openconfig-aft-ethernet; include openconfig-aft-common; organization "OpenConfig working group"; contact "OpenConfig working group www.openconfig.net"; description "A model describing the forwarding entries installed on a network element. It should be noted that this model is not expected to align 1:1 with the underlying structure used directly by a forwarding element (e.g., linecard), but rather provide an abstraction that can be consumed by an NMS to observe, and in some cases manipulate, the internal forwarding database in a simplified manner. Since the underlying model of the forwarding table is not expected to align with this model, the structure described herein is referred to as an Abstract Forwarding Table (AFT), rather than the FIB."; revision "2019-11-07" { description "Move lsp-name leaf out of aft-common-entry-nexthop-state group."; reference "0.4.1"; } revision "2019-08-02" { description "Add installing protocol for IPv[46] unicast entries. Add the ability to describe conditional next-hop groups outside of the policy forwarding module to allow for efficient handling of CBTS, where many prefixes may share the same next-hop criteria."; reference "0.4.0"; } revision "2019-08-01" { description "Add lsp-name leaf to AFT next-hop."; reference "0.3.3"; } revision "2018-11-21" { description "Add OpenConfig module metadata extensions."; reference "0.3.2"; } revision "2017-08-24" { description "Formatting fixes"; reference "0.3.1"; } revision "2017-05-10" { description "Refactor to provide concretised per-AF schemas per AFT."; reference "0.3.0"; } oc-ext:openconfig-version "0.4.1"; oc-ext:regexp-posix; oc-ext:catalog-organization "openconfig"; oc-ext:origin "openconfig"; grouping aft-top { description "Top-level grouping allowing per-protocol instantiation of the AFT."; container afts { description "The abstract forwarding tables (AFTs) that are associated with the network instance. An AFT is instantiated per-protocol running within the network-instance - such that one exists for IPv4 Unicast, IPv6 Unicast, MPLS, L2 forwarding entries, etc. A forwarding entry within the FIB has a set of next-hops, which may be a reference to an entry within another table - e.g., where a Layer 3 next-hop has an associated Layer 2 forwarding entry."; container ipv4-unicast { description "The abstract forwarding table for IPv4 unicast. Entries within this table are uniquely keyed on the IPv4 unicast destination prefix which is matched by ingress packets. The data set represented by the IPv4 Unicast AFT is the set of entries from the IPv4 unicast RIB that have been selected for installation into the FIB of the device exporting the data structure."; uses aft-ipv4-unicast-structural; } // container ipv4-unicast container ipv6-unicast { description "The abstract forwarding table for IPv6 unicast. Entries within this table are uniquely keyed on the IPv6 unicast destination prefix which is matched by ingress packets. The data set represented by the IPv6 Unicast AFTis the set of entries within the IPv6 RIB that "; uses aft-ipv6-unicast-structural; } // container ipv6-unicast container policy-forwarding { description "The abstract forwarding table for policy-based forwarding entries. Since multiple match criteria can be utilised within a policy-based forwarding rule, this AFT provides a flexible match criteria, and is indexed based on an arbitrary 64-bit index. Entries within the AFT may match on multiple field types (e.g., L4 header fields, as well as L2 fields). Examples of entries within this table are: - IPv4 policy-based routing based on DSCP. - MPLS policy-based forwarding entries."; uses aft-pf-structural; } // container policy-forwarding container mpls { description "The abstract forwarding table for MPLS label based forwarding entries. Entries within the table are keyed based on the top-most MPLS label in the stack on the ingress packet."; uses aft-mpls-structural; } // container mpls container ethernet { description "The abstract forwarding table for Ethernet based forwarding entries. Entries within the table are keyed based on the destination MAC address on the ingress packet."; uses aft-ethernet-structural; } // container ethernet uses aft-next-hop-groups-structural; uses aft-nhop-structural; } // container afts } // grouping aft-top } // module openconfig-aft
Summary
openconfig-aft-ipv4 | |
Organization | OpenConfig working group |
Submodule | openconfig-aft-ipv4 |
Version | 2019-11-07 |
File | openconfig-aft-ipv4.yang |
Cooked | /cookedmodules/openconfig-aft-ipv4/2019-11-07 |
YANG | /src/openconfig-aft-ipv4@2019-11-07.yang |
XSD | /xsd/openconfig-aft-ipv4@2019-11-07.xsd |
Abstract | Submodule containing definitions of groupings for the abstract forwarding tables for IPv4. |
Contact | OpenConfig working group www.openconfig.net |
openconfig-aft-common | |
Organization | OpenConfig working group |
Submodule | openconfig-aft-common |
Version | 2019-11-07 |
File | openconfig-aft-common.yang |
Cooked | /cookedmodules/openconfig-aft-common/2019-11-07 |
YANG | /src/openconfig-aft-common@2019-11-07.yang |
XSD | /xsd/openconfig-aft-common@2019-11-07.xsd |
Abstract | Submodule containing definitions of groupings that are re-used across multiple contexts within the AFT model. |
Contact | OpenConfig working group www.openconfig.net |
openconfig-aft | |
Organization | OpenConfig working group |
Module | openconfig-aft |
Version | 2019-11-07 |
File | openconfig-aft.yang |
Prefix | oc-aft |
Namespace | http://openconfig.net/yang/aft |
Cooked | /cookedmodules/openconfig-aft/2019-11-07 |
YANG | /src/openconfig-aft@2019-11-07.yang |
XSD | /xsd/openconfig-aft@2019-11-07.xsd |
Abstract | A model describing the forwarding entries installed on a network element. It should be noted that this model is not expected to ... |
Contact | OpenConfig working group www.openconfig.net |
openconfig-aft-mpls | |
Organization | OpenConfig working group |
Submodule | openconfig-aft-mpls |
Version | 2019-11-07 |
File | openconfig-aft-mpls.yang |
Cooked | /cookedmodules/openconfig-aft-mpls/2019-11-07 |
YANG | /src/openconfig-aft-mpls@2019-11-07.yang |
XSD | /xsd/openconfig-aft-mpls@2019-11-07.xsd |
Abstract | Submodule containing definitions of groupings for the abstract forwarding table for MPLS label forwarding. |
Contact | OpenConfig working group www.openconfig.net |
openconfig-aft-ethernet | |
Organization | OpenConfig working group |
Submodule | openconfig-aft-ethernet |
Version | 2019-11-07 |
File | openconfig-aft-ethernet.yang |
Cooked | /cookedmodules/openconfig-aft-ethernet/2019-11-07 |
YANG | /src/openconfig-aft-ethernet@2019-11-07.yang |
XSD | /xsd/openconfig-aft-ethernet@2019-11-07.xsd |
Abstract | Submodule containing definitions of groupings for the abstract forwarding tables for Ethernet. |
Contact | OpenConfig working group www.openconfig.net |
openconfig-aft-ipv6 | |
Organization | OpenConfig working group |
Submodule | openconfig-aft-ipv6 |
Version | 2019-11-07 |
File | openconfig-aft-ipv6.yang |
Cooked | /cookedmodules/openconfig-aft-ipv6/2019-11-07 |
YANG | /src/openconfig-aft-ipv6@2019-11-07.yang |
XSD | /xsd/openconfig-aft-ipv6@2019-11-07.xsd |
Abstract | Submodule containing definitions of groupings for the abstract forwarding tables for IPv6. |
Contact | OpenConfig working group www.openconfig.net |
openconfig-aft-pf | |
Organization | OpenConfig working group |
Submodule | openconfig-aft-pf |
Version | 2019-11-07 |
File | openconfig-aft-pf.yang |
Cooked | /cookedmodules/openconfig-aft-pf/2019-11-07 |
YANG | /src/openconfig-aft-pf@2019-11-07.yang |
XSD | /xsd/openconfig-aft-pf@2019-11-07.xsd |
Abstract | Submodule containing definitions of groupings for the abstract forwarding table(s) for policy forwarding entries. These are defi... |
Contact | OpenConfig working group www.openconfig.net |
Description
openconfig-aft-ipv4 |
Submodule containing definitions of groupings for the abstract forwarding tables for IPv4. |
openconfig-aft-common |
Submodule containing definitions of groupings that are re-used across multiple contexts within the AFT model. |
openconfig-aft |
A model describing the forwarding entries installed on a network element. It should be noted that this model is not expected to align 1:1 with the underlying structure used directly by a forwarding element (e.g., linecard), but rather provide an abstraction that can be consumed by an NMS to observe, and in some cases manipulate, the internal forwarding database in a simplified manner. Since the underlying model of the forwarding table is not expected to align with this model, the structure described herein is referred to as an Abstract Forwarding Table (AFT), rather than the FIB. |
openconfig-aft-mpls |
Submodule containing definitions of groupings for the abstract forwarding table for MPLS label forwarding. |
openconfig-aft-ethernet |
Submodule containing definitions of groupings for the abstract forwarding tables for Ethernet. |
openconfig-aft-ipv6 |
Submodule containing definitions of groupings for the abstract forwarding tables for IPv6. |
openconfig-aft-pf |
Submodule containing definitions of groupings for the abstract forwarding table(s) for policy forwarding entries. These are defined to be forwarding tables that allow matches on fields other than the destination address that is used in other forwarding tables. |
Groupings
Grouping | Objects | Abstract |
aft-common-entry-nexthop-config | index | Configuration parameters relating to a next-hop entry for a AFT entry |
aft-common-entry-nexthop-state | ip-address mac-address pushed-mpls-label-stack encapsulate-header origin-protocol | Parameters relating to a next-hop. |
aft-common-entry-state | packets-forwarded octets-forwarded next-hop-group | Operational state parameters relating to a forwarding entry |
aft-common-install-protocol | origin-protocol | Grouping for a common reference to the protocol which installed an entry. |
aft-common-ip-state | origin-protocoldecapsulate-header | Common parameters across IP address families |
aft-ethernet-entry-config | mac-address | Configuration parameters for the Ethernet AFT entry. |
aft-ethernet-entry-state | packets-forwarded octets-forwarded next-hop-group | Operational state parameters for the Ethernet AFT entry. |
aft-ethernet-structural | mac-entry | Structural grouping defining the schema for the Ethernet abstract forwarding table. |
aft-ipv4-unicast-entry-config | prefix | Configuration parameters for the IPv4 unicast entry. |
aft-ipv4-unicast-entry-state | packets-forwarded octets-forwarded next-hop-grouporigin-protocol decapsulate-header | Operational state parameters for the IPv4 unicast entry. |
aft-ipv4-unicast-structural | ipv4-entry | Structural grouping defining the schema for the IPv4 unicast abstract forwarding table. |
aft-ipv6-unicast-entry-config | prefix | Configuration parameters for the IPv6 unicast entry. |
aft-ipv6-unicast-entry-state | packets-forwarded octets-forwarded next-hop-grouporigin-protocol decapsulate-header | Operational state parameters for the IPv6 unicast entry. |
aft-ipv6-unicast-structural | ipv6-entry | Structural grouping defining the schema for the IPv6 unicast abstract forwarding table. |
aft-labeled-entry-state | lsp-name | Operational state for LSP name in forwarding entry |
aft-mpls-entry-config | label | Configuration parameters for the MPLS entry. |
aft-mpls-entry-state | packets-forwarded octets-forwarded next-hop-grouppopped-mpls-label-stack | Operational state parameters for the MPLS entry. |
aft-mpls-structural | label-entry | Structural grouping defining the schema for the MPLS abstract forwarding table. |
aft-next-hop-groups-structural | next-hop-groups | Logical grouping for groups of next-hops. |
aft-nhg-conditional-config | id | Configuration parameters relating to the conditional selection of a next-hop group for an AFT entry. |
aft-nhg-conditional-interface-config | id | Configuration parameters relating to the input-interface condition for a next-hop-group. |
aft-nhg-conditional-interface-state | interface subinterface | Operational state parameters relating to the input-interface condition for a next-hop-group. |
aft-nhg-conditional-state | dscp next-hop-group | Operational state parameters relating to the conditional selection of a next-hop group for an AFT entry. |
aft-nhg-config | id | Configuration parameters related to a next-hop-group. |
aft-nhg-nh-config | index | Configuration parameters relating to an individual next-hop within a next-hop-group. |
aft-nhg-nh-state | weight | Operational state parameters relating to an individual next-hop within the next-hop-group. |
aft-nhg-state | color backup-next-hop-group | Operational state parameters related to a next-hop-group. |
aft-nhop-structural | next-hops | Structural grouping describing a next-hop entry. |
aft-pf-entry-config | index ip-prefix mac-address mpls-label mpls-tc ip-dscp ip-protocol l4-src-port l4-dst-port | Configuration parameters for the Policy Forwarding AFT entry. |
aft-pf-entry-state | packets-forwarded octets-forwarded next-hop-group | Operational state parameters for the Policy Forwarding AFT entry. |
aft-pf-structural | policy-forwarding-entry | Structural grouping defining the schema for the policy forwarding abstract forwarding table. |
aft-top | afts | Top-level grouping allowing per-protocol instantiation of the AFT. |