netconfcentral logo

openconfig-policy-forwarding

HTML

openconfig-policy-forwarding@2017-06-21



  module openconfig-policy-forwarding {

    yang-version 1;

    namespace
      "http://openconfig.net/yang/policy-forwarding";

    prefix oc-pf;

    import openconfig-extensions {
      prefix oc-ext;
    }

    include openconfig-pf-forwarding-policies;
    include openconfig-pf-path-groups;
    include openconfig-pf-interfaces;

    organization "OpenConfig working group";

    contact
      "OpenConfig working group
    www.openconfig.net";

    description
      "This module defines configuration and operational state data
    relating to policy-based forwarding. Policy-based forwarding is
    utilised when a system chooses how to forward packets (including
    applying data-plane operations such as encapsulation or
    decapsulation) based on policies other than destination L2 or L3
    header. Typically, systems may implement:

     - IP policy-based routing, where routing may be done based on the
       source plus destination of an IP packet; information within the
       L4 header; or some combination of both.
     - Encapsulation or decapsulation based on certain policy
       information - for example, matching particular IP destinations
       and decapsulating GRE headers.
     - Class-based selection of egress routes - such as class-based
       selection of an egress MPLS path.

    The policies that are defined in this model are applied to a
    particular ingress context of a network element (e.g., interface)
    and are defined to apply following other interface policy such as
    QoS classification and access control lists.

    This module defines:

     - policy-forwarding
    |
    |--- policies
    |    |-- policy
    |        |-- [match criteria]    How packets are defined to
    |        |                       match policy.
    |        |-- [forwarding-action] How packets matching should
    |                                 be forwarded.
    |--- interfaces
    |    |-- interfaces
    |        | -- apply-forwarding-policy  Forwarding policy to
    |                                      used on the interface.
    |--- path-selection-groups
         |-- path-selection-group     A group of forwarding resources
                                      that are grouped for purposes
                                      of next-hop selection.

    A forwarding-policy specifies the match criteria that it intends
    to use to determine the packets that it reroutes - this may
    consist of a number of criteria, such as DSCP. The action of the
    policy results in a forwarding action being applied to matching
    packets. For example, decapsulating the packet from a GRE header.
    In order to enact the policy based on particular interfaces - the
    forwarding-policy is applied to an interface via referencing it
    within an 'apply-forwarding-policy' statement associated with an
    interface.

    In some cases (e.g., Class-Based Tunnel Selection) the forwarding
    action does not resolve to a single egress action, and rather
    normal forwarding rules are to be applied but considering a subset
    of forwarding resources. In these cases, a path-selection-group
    can be created, referencing the subset of forwarding paths that
    should be used for the egress selection. In the case that a subset
    of MPLS LSPs are eligible for, say, DSCP 46 marked packets, a
    path-selection-group is created, referencing the subset of LSPs.
    The forwarding action of the corresponding policy is set to
    PATH_GROUP and references the configured group of LSPs.";

    revision "2017-06-21" {
      description
        "Amend policy forwarding model based on ACL changes.";
      reference
        "0.2.0";

    }

    revision "2017-02-28" {
      description
        "Initial public release of policy forwarding.";
      reference
        "0.1.0";

    }

    revision "2016-11-08" {
      description "Initial revision.";
      reference
        "0.0.1";

    }

    oc-ext:openconfig-version "0.2.0";

    grouping policy-forwarding-top {
      description
        "Top-level grouping for Policy Forwarding";
      container policy-forwarding {
        description
          "Configuration and operational state relating to policy-forwarding within
        a network instance.";
        uses pf-forwarding-policy-structural;

        uses pf-interfaces-structural;

        uses pf-path-groups-structural;
      }  // container policy-forwarding
    }  // grouping policy-forwarding-top
  }  // module openconfig-policy-forwarding

Summary

  
openconfig-pf-forwarding-policies  
  
Organization OpenConfig working group
  
Submodule openconfig-pf-forwarding-policies
Version 2017-06-21
File openconfig-pf-forwarding-policies.yang
  
  
Cooked /cookedmodules/openconfig-pf-forwarding-policies/2017-06-21
YANG /src/openconfig-pf-forwarding-policies@2017-06-21.yang
XSD /xsd/openconfig-pf-forwarding-policies@2017-06-21.xsd
  
Abstract This submodule contains configuration and operational state relating to the definition of policy-forwarding policies.
  
Contact
OpenConfig working group
www.openconfig.net
  
openconfig-policy-forwarding  
  
Organization OpenConfig working group
  
Module openconfig-policy-forwarding
Version 2017-06-21
File openconfig-policy-forwarding.yang
  
Prefix oc-pf
Namespace http://openconfig.net/yang/policy-forwarding
  
Cooked /cookedmodules/openconfig-policy-forwarding/2017-06-21
YANG /src/openconfig-policy-forwarding@2017-06-21.yang
XSD /xsd/openconfig-policy-forwarding@2017-06-21.xsd
  
Abstract This module defines configuration and operational state data relating to policy-based forwarding. Policy-based forwarding is uti...
  
Contact
OpenConfig working group
www.openconfig.net
  
openconfig-pf-path-groups  
  
Organization OpenConfig working group
  
Submodule openconfig-pf-path-groups
Version 2017-06-21
File openconfig-pf-path-groups.yang
  
  
Cooked /cookedmodules/openconfig-pf-path-groups/2017-06-21
YANG /src/openconfig-pf-path-groups@2017-06-21.yang
XSD /xsd/openconfig-pf-path-groups@2017-06-21.xsd
  
Abstract This submodule contains configuration and operational state relating to path-selection-groups which are used to group forwarding...
  
Contact
OpenConfig working group
www.openconfig.net
  
openconfig-pf-interfaces  
  
Organization OpenConfig working group
  
Submodule openconfig-pf-interfaces
Version 2017-06-21
File openconfig-pf-interfaces.yang
  
  
Cooked /cookedmodules/openconfig-pf-interfaces/2017-06-21
YANG /src/openconfig-pf-interfaces@2017-06-21.yang
XSD /xsd/openconfig-pf-interfaces@2017-06-21.xsd
  
Abstract This submodule contains groupings related to the association between interfaces and policy forwarding rules.
  
Contact
OpenConfig working group
www.openconfig.net

Description

 
openconfig-pf-forwarding-policies
This submodule contains configuration and operational state
relating to the definition of policy-forwarding policies.
 
openconfig-policy-forwarding
This module defines configuration and operational state data
relating to policy-based forwarding. Policy-based forwarding is
utilised when a system chooses how to forward packets (including
applying data-plane operations such as encapsulation or
decapsulation) based on policies other than destination L2 or L3
header. Typically, systems may implement:

- IP policy-based routing, where routing may be done based on the
  source plus destination of an IP packet; information within the
  L4 header; or some combination of both.
- Encapsulation or decapsulation based on certain policy
  information - for example, matching particular IP destinations
  and decapsulating GRE headers.
- Class-based selection of egress routes - such as class-based
  selection of an egress MPLS path.

The policies that are defined in this model are applied to a
particular ingress context of a network element (e.g., interface)
and are defined to apply following other interface policy such as
QoS classification and access control lists.

This module defines:

- policy-forwarding
|
|--- policies
|    |-- policy
|        |-- [match criteria]    How packets are defined to
|        |                       match policy.
|        |-- [forwarding-action] How packets matching should
|                                 be forwarded.
|--- interfaces
|    |-- interfaces
|        | -- apply-forwarding-policy  Forwarding policy to
|                                      used on the interface.
|--- path-selection-groups
    |-- path-selection-group     A group of forwarding resources
				 that are grouped for purposes
				 of next-hop selection.

A forwarding-policy specifies the match criteria that it intends
to use to determine the packets that it reroutes - this may
consist of a number of criteria, such as DSCP. The action of the
policy results in a forwarding action being applied to matching
packets. For example, decapsulating the packet from a GRE header.
In order to enact the policy based on particular interfaces - the
forwarding-policy is applied to an interface via referencing it
within an 'apply-forwarding-policy' statement associated with an
interface.

In some cases (e.g., Class-Based Tunnel Selection) the forwarding
action does not resolve to a single egress action, and rather
normal forwarding rules are to be applied but considering a subset
of forwarding resources. In these cases, a path-selection-group
can be created, referencing the subset of forwarding paths that
should be used for the egress selection. In the case that a subset
of MPLS LSPs are eligible for, say, DSCP 46 marked packets, a
path-selection-group is created, referencing the subset of LSPs.
The forwarding action of the corresponding policy is set to
PATH_GROUP and references the configured group of LSPs.
 
openconfig-pf-path-groups
This submodule contains configuration and operational state
relating to path-selection-groups which are used to group
forwarding entities together to be used as policy forwarding
targets.
 
openconfig-pf-interfaces
This submodule contains groupings related to the association
between interfaces and policy forwarding rules.

Groupings

Grouping Objects Abstract
pf-forwarding-policy-action-config discard decapsulate-gre network-instance path-selection-group next-hop Forwarding policy action configuration parameters.
pf-forwarding-policy-config policy-id Configuration parameters relating to the forwarding policy.
pf-forwarding-policy-rule-config sequence-id Configuration parameters relating to a policy rule.
pf-forwarding-policy-rule-state matched-pkts matched-octets Operational state parameters relating to a policy rule.
pf-forwarding-policy-structural policies Structural grouping defining forwarding policies under the policy- forwarding module.
pf-interface-config interface-id apply-forwarding-policy Configuration parameters relating to an interface to policy forwarding rule binding.
pf-interfaces-structural interfaces Structural grouping for interface to forwarding policy bindings within the policy-forwarding model.
pf-path-groups-structural path-selection-groups Structural grouping containing the definition of path groups within the context of policy-based forwarding.
pf-path-selection-group-config group-id mpls-lsp Configuration parameters relating to a path selection group.
policy-forwarding-top policy-forwarding Top-level grouping for Policy Forwarding