netconfcentral logo

ietf-l3vpn-svc@2017-01-27



  module ietf-l3vpn-svc {

    yang-version 1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-l3vpn-svc";

    prefix l3vpn-svc;

    import ietf-inet-types {
      prefix inet;
    }
    import ietf-yang-types {
      prefix yang;
    }

    organization "IETF L3SM Working Group";

    contact
      "WG List: <mailto:l3sm@ietf.org>

  Editor:
   L3SM WG

  Chairs:
   Adrian Farrel, Qin Wu
  ";

    description
      "This YANG module defines a generic service configuration
  model for Layer 3 VPNs.  This model is common across all
  vendor implementations.";

    revision "2017-01-27" {
      description "Initial document.";
      reference
        "RFC 8049.";

    }


    feature cloud-access {
      description
        "Allows the VPN to connect to a CSP.";
    }

    feature multicast {
      description
        "Enables multicast capabilities in a VPN.";
    }

    feature ipv4 {
      description
        "Enables IPv4 support in a VPN.";
    }

    feature ipv6 {
      description
        "Enables IPv6 support in a VPN.";
    }

    feature carrierscarrier {
      description "Enables support of CsC.";
    }

    feature extranet-vpn {
      description
        "Enables support of extranet VPNs.";
    }

    feature site-diversity {
      description
        "Enables support of site diversity constraints.";
    }

    feature encryption {
      description
        "Enables support of encryption.";
    }

    feature qos {
      description
        "Enables support of classes of services.";
    }

    feature qos-custom {
      description
        "Enables support of the custom QoS profile.";
    }

    feature rtg-bgp {
      description
        "Enables support of the BGP routing protocol.";
    }

    feature rtg-rip {
      description
        "Enables support of the RIP routing protocol.";
    }

    feature rtg-ospf {
      description
        "Enables support of the OSPF routing protocol.";
    }

    feature rtg-ospf-sham-link {
      description
        "Enables support of OSPF sham links.";
    }

    feature rtg-vrrp {
      description
        "Enables support of the VRRP routing protocol.";
    }

    feature fast-reroute {
      description
        "Enables support of Fast Reroute.";
    }

    feature bfd {
      description "Enables support of BFD.";
    }

    feature always-on {
      description
        "Enables support of the 'always-on' access constraint.";
    }

    feature requested-type {
      description
        "Enables support of the 'requested-type' access constraint.";
    }

    feature bearer-reference {
      description
        "Enables support of the 'bearer-reference' access constraint.";
    }

    typedef svc-id {
      type string;
      description
        "Defines a type of service component identifier.";
    }

    typedef template-id {
      type string;
      description
        "Defines a type of service template identifier.";
    }

    typedef address-family {
      type enumeration {
        enum "ipv4" {
          value 0;
          description "IPv4 address family.";
        }
        enum "ipv6" {
          value 1;
          description "IPv6 address family.";
        }
      }
      description
        "Defines a type for the address family.";
    }

    identity site-network-access-type {
      base 
      description
        "Base identity for site-network-access type.";
    }

    identity point-to-point {
      base site-network-access-type;
      description
        "Identity for point-to-point connection.";
    }

    identity multipoint {
      base site-network-access-type;
      description
        "Identity for multipoint connection.
   Example: Ethernet broadcast segment.";
    }

    identity placement-diversity {
      base 
      description
        "Base identity for site placement constraints.";
    }

    identity bearer-diverse {
      base placement-diversity;
      description
        "Identity for bearer diversity.
   The bearers should not use common elements.";
    }

    identity pe-diverse {
      base placement-diversity;
      description
        "Identity for PE diversity.";
    }

    identity pop-diverse {
      base placement-diversity;
      description
        "Identity for POP diversity.";
    }

    identity linecard-diverse {
      base placement-diversity;
      description
        "Identity for linecard diversity.";
    }

    identity same-pe {
      base placement-diversity;
      description
        "Identity for having sites connected on the same PE.";
    }

    identity same-bearer {
      base placement-diversity;
      description
        "Identity for having sites connected using the same bearer.";
    }

    identity customer-application {
      base 
      description
        "Base identity for customer application.";
    }

    identity web {
      base customer-application;
      description
        "Identity for Web application (e.g., HTTP, HTTPS).";
    }

    identity mail {
      base customer-application;
      description
        "Identity for mail application.";
    }

    identity file-transfer {
      base customer-application;
      description
        "Identity for file transfer application (e.g., FTP, SFTP).";
    }

    identity database {
      base customer-application;
      description
        "Identity for database application.";
    }

    identity social {
      base customer-application;
      description
        "Identity for social-network application.";
    }

    identity games {
      base customer-application;
      description
        "Identity for gaming application.";
    }

    identity p2p {
      base customer-application;
      description
        "Identity for peer-to-peer application.";
    }

    identity network-management {
      base customer-application;
      description
        "Identity for management application
   (e.g., Telnet, syslog, SNMP).";
    }

    identity voice {
      base customer-application;
      description
        "Identity for voice application.";
    }

    identity video {
      base customer-application;
      description
        "Identity for video conference application.";
    }

    identity site-vpn-flavor {
      base 
      description
        "Base identity for the site VPN service flavor.";
    }

    identity site-vpn-flavor-single {
      base site-vpn-flavor;
      description
        "Base identity for the site VPN service flavor.
   Used when the site belongs to only one VPN.";
    }

    identity site-vpn-flavor-multi {
      base site-vpn-flavor;
      description
        "Base identity for the site VPN service flavor.
   Used when a logical connection of a site
   belongs to multiple VPNs.";
    }

    identity site-vpn-flavor-sub {
      base site-vpn-flavor;
      description
        "Base identity for the site VPN service flavor.
   Used when a site has multiple logical connections.
   Each connection may belong to different multiple VPNs.";
    }

    identity site-vpn-flavor-nni {
      base site-vpn-flavor;
      description
        "Base identity for the site VPN service flavor.
   Used to describe an NNI option A connection.";
    }

    identity management {
      base 
      description
        "Base identity for site management scheme.";
    }

    identity co-managed {
      base management;
      description
        "Base identity for co-managed site.";
    }

    identity customer-managed {
      base management;
      description
        "Base identity for customer-managed site.";
    }

    identity provider-managed {
      base management;
      description
        "Base identity for provider-managed site.";
    }

    identity address-allocation-type {
      base 
      description
        "Base identity for address-allocation-type for PE-CE link.";
    }

    identity provider-dhcp {
      base address-allocation-type;
      description
        "Provider network provides DHCP service to customer.";
    }

    identity provider-dhcp-relay {
      base address-allocation-type;
      description
        "Provider network provides DHCP relay service to customer.";
    }

    identity provider-dhcp-slaac {
      base address-allocation-type;
      description
        "Provider network provides DHCP service to customer,
   as well as SLAAC.";
    }

    identity static-address {
      base address-allocation-type;
      description
        "Provider-to-customer addressing is static.";
    }

    identity slaac {
      base address-allocation-type;
      description "Use IPv6 SLAAC.";
    }

    identity site-role {
      base 
      description
        "Base identity for site type.";
    }

    identity any-to-any-role {
      base site-role;
      description
        "Site in an any-to-any IP VPN.";
    }

    identity spoke-role {
      base site-role;
      description
        "Spoke site in a Hub-and-Spoke IP VPN.";
    }

    identity hub-role {
      base site-role;
      description
        "Hub site in a Hub-and-Spoke IP VPN.";
    }

    identity vpn-topology {
      base 
      description
        "Base identity for VPN topology.";
    }

    identity any-to-any {
      base vpn-topology;
      description
        "Identity for any-to-any VPN topology.";
    }

    identity hub-spoke {
      base vpn-topology;
      description
        "Identity for Hub-and-Spoke VPN topology.";
    }

    identity hub-spoke-disjoint {
      base vpn-topology;
      description
        "Identity for Hub-and-Spoke VPN topology
   where Hubs cannot communicate with each other.";
    }

    identity multicast-tree-type {
      base 
      description
        "Base identity for multicast tree type.";
    }

    identity ssm-tree-type {
      base multicast-tree-type;
      description
        "Identity for SSM tree type.";
    }

    identity asm-tree-type {
      base multicast-tree-type;
      description
        "Identity for ASM tree type.";
    }

    identity bidir-tree-type {
      base multicast-tree-type;
      description
        "Identity for bidirectional tree type.";
    }

    identity multicast-rp-discovery-type {
      base 
      description
        "Base identity for RP discovery type.";
    }

    identity auto-rp {
      base multicast-rp-discovery-type;
      description
        "Base identity for Auto-RP discovery type.";
    }

    identity static-rp {
      base multicast-rp-discovery-type;
      description
        "Base identity for static type.";
    }

    identity bsr-rp {
      base multicast-rp-discovery-type;
      description
        "Base identity for BSR discovery type.";
    }

    identity routing-protocol-type {
      base 
      description
        "Base identity for routing protocol type.";
    }

    identity ospf {
      base routing-protocol-type;
      description
        "Identity for OSPF protocol type.";
    }

    identity bgp {
      base routing-protocol-type;
      description
        "Identity for BGP protocol type.";
    }

    identity static {
      base routing-protocol-type;
      description
        "Identity for static routing protocol type.";
    }

    identity rip {
      base routing-protocol-type;
      description
        "Identity for RIP protocol type.";
    }

    identity vrrp {
      base routing-protocol-type;
      description
        "Identity for VRRP protocol type.
   This is to be used when LANs are directly connected
   to PE routers.";
    }

    identity direct {
      base routing-protocol-type;
      description
        "Identity for direct protocol type.";
    }

    identity protocol-type {
      base 
      description
        "Base identity for protocol field type.";
    }

    identity tcp {
      base protocol-type;
      description "TCP protocol type.";
    }

    identity udp {
      base protocol-type;
      description "UDP protocol type.";
    }

    identity icmp {
      base protocol-type;
      description "ICMP protocol type.";
    }

    identity icmp6 {
      base protocol-type;
      description "ICMPv6 protocol type.";
    }

    identity gre {
      base protocol-type;
      description "GRE protocol type.";
    }

    identity ipip {
      base protocol-type;
      description "IP-in-IP protocol type.";
    }

    identity hop-by-hop {
      base protocol-type;
      description
        "Hop-by-Hop IPv6 header type.";
    }

    identity routing {
      base protocol-type;
      description
        "Routing IPv6 header type.";
    }

    identity esp {
      base protocol-type;
      description "ESP header type.";
    }

    identity ah {
      base protocol-type;
      description "AH header type.";
    }

    grouping vpn-service-cloud-access {
      description
        "Grouping for VPN cloud definition.";
      container cloud-accesses {
        if-feature cloud-access;
        description
          "Container for cloud access configurations.";
        list cloud-access {
          key "cloud-identifier";
          description
            "Cloud access configuration.";
          leaf cloud-identifier {
            type string;
            description
              "Identification of cloud service.
     Local administration meaning.";
          }

          choice list-flavor {
            description
              "Choice for cloud access policy.";
            leaf permit-any {
              type empty;
              description
                "Allows all sites.";
            }
            leaf-list permit-site {
              type leafref {
                path
                  "/l3vpn-svc/sites/site/site-id";
              }
              description
                "Site ID to be authorized.";
            }
            leaf-list deny-site {
              type leafref {
                path
                  "/l3vpn-svc/sites/site/site-id";
              }
              description
                "Site ID to be denied.";
            }
          }  // choice list-flavor

          container authorized-sites {
            description
              "Configuration of authorized sites.";
            list authorized-site {
              key "site-id";
              description
                "List of authorized sites.";
              leaf site-id {
                type leafref {
                  path
                    "/l3vpn-svc/sites/site/site-id";
                }
                description "Site ID.";
              }
            }  // list authorized-site
          }  // container authorized-sites

          container denied-sites {
            description
              "Configuration of denied sites.";
            list denied-site {
              key "site-id";
              description
                "List of denied sites.";
              leaf site-id {
                type leafref {
                  path
                    "/l3vpn-svc/sites/site/site-id";
                }
                description "Site ID.";
              }
            }  // list denied-site
          }  // container denied-sites

          container address-translation {
            description "Container for NAT.";
            container nat44 {
              description
                "IPv4-to-IPv4 translation.";
              leaf enabled {
                type boolean;
                default 'false';
                description
                  "Controls whether or not address translation is required.";
              }

              leaf nat44-customer-address {
                type inet:ipv4-address;
                must "../enabled = 'true'" {
                  description
                    "Applicable only if address translation is enabled.";
                }
                description
                  "Address to be used for translation.
       This is to be used if the customer is
       providing the address.";
              }
            }  // container nat44
          }  // container address-translation
        }  // list cloud-access
      }  // container cloud-accesses
    }  // grouping vpn-service-cloud-access

    grouping multicast-rp-group-cfg {
      description
        "Definition of groups for RP-to-group mapping.";
      choice group-format {
        description
          "Choice for group format.";
        case startend {
          leaf group-start {
            type inet:ip-address;
            description
              "First group address.";
          }

          leaf group-end {
            type inet:ip-address;
            description
              "Last group address.";
          }
        }  // case startend
        leaf group-address {
          type inet:ip-address;
          description "Group address.";
        }
      }  // choice group-format
    }  // grouping multicast-rp-group-cfg

    grouping vpn-service-multicast {
      description
        "Grouping for multicast VPN definition.";
      container multicast {
        if-feature multicast;
        description
          "Multicast global parameters for the VPN service.";
        leaf enabled {
          type boolean;
          default 'false';
          description "Enables multicast.";
        }

        container customer-tree-flavors {
          description
            "Type of trees used by customer.";
          leaf-list tree-flavor {
            type identityref {
              base multicast-tree-type;
            }
            description
              "Type of tree to be used.";
          }
        }  // container customer-tree-flavors

        container rp {
          description "RP parameters.";
          container rp-group-mappings {
            description
              "RP-to-group mappings.";
            list rp-group-mapping {
              key "id";
              description
                "List of RP-to-group mappings.";
              leaf id {
                type uint16;
                description
                  "Unique identifier for the mapping.";
              }

              container provider-managed {
                description
                  "Parameters for a provider-managed RP.";
                leaf enabled {
                  type boolean;
                  default 'false';
                  description
                    "Set to true if the RP must be a provider-managed node.
         Set to false if it is a customer-managed node.";
                }

                leaf rp-redundancy {
                  when "../enabled = 'true'" {
                    description
                      "Relevant when the RP is provider-managed.";
                  }
                  type boolean;
                  default 'false';
                  description
                    "If true, a redundancy mechanism for the RP is required.";
                }

                leaf optimal-traffic-delivery {
                  when "../enabled = 'true'" {
                    description
                      "Relevant when the RP is provider-managed.";
                  }
                  type boolean;
                  default 'false';
                  description
                    "If true, the SP must ensure that
         traffic uses an optimal path.";
                }
              }  // container provider-managed

              leaf rp-address {
                when
                  "../provider-managed/enabled = 'false'" {
                  description
                    "Relevant when the RP is provider-managed.";
                }
                type inet:ip-address;
                description
                  "Defines the address of the RP.
        Used if the RP is customer-managed.";
              }

              container groups {
                description
                  "Multicast groups associated with the RP.";
                list group {
                  key "id";
                  description
                    "List of groups.";
                  leaf id {
                    type uint16;
                    description
                      "Identifier for the group.";
                  }

                  uses multicast-rp-group-cfg;
                }  // list group
              }  // container groups
            }  // list rp-group-mapping
          }  // container rp-group-mappings

          container rp-discovery {
            description
              "RP discovery parameters.";
            leaf rp-discovery-type {
              type identityref {
                base multicast-rp-discovery-type;
              }
              default 'static-rp';
              description
                "Type of RP discovery used.";
            }

            container bsr-candidates {
              when
                "../rp-discovery-type = 'bsr-rp'" {
                description
                  "Only applicable if discovery type is BSR-RP.";
              }
              description
                "Customer BSR candidate's address.";
              leaf-list bsr-candidate-address {
                type inet:ip-address;
                description
                  "Address of BSR candidate.";
              }
            }  // container bsr-candidates
          }  // container rp-discovery
        }  // container rp
      }  // container multicast
    }  // grouping vpn-service-multicast

    grouping vpn-service-mpls {
      description
        "Grouping for MPLS CsC definition.";
      leaf carrierscarrier {
        if-feature carrierscarrier;
        type boolean;
        default 'false';
        description
          "The VPN is using CsC, and so MPLS is required.";
      }
    }  // grouping vpn-service-mpls

    grouping customer-location-info {
      description
        "This grouping defines customer location parameters.";
      container locations {
        description
          "List of locations for the site.";
        list location {
          key "location-id";
          description
            "Location of the site.";
          leaf location-id {
            type svc-id;
            description
              "Identifier for a particular location.";
          }

          leaf address {
            type string;
            description
              "Address (number and street) of the site.";
          }

          leaf postal-code {
            type string;
            description
              "Postal code of the site.";
          }

          leaf state {
            type string;
            description
              "State of the site.  This leaf can also be used to describe
      a region for a country that does not have states.";
          }

          leaf city {
            type string;
            description "City of the site.";
          }

          leaf country-code {
            type string {
              pattern '[A-Z]{2}';
            }
            description
              "Country of the site.
      Expressed as ISO ALPHA-2 code.";
          }
        }  // list location
      }  // container locations
    }  // grouping customer-location-info

    grouping site-group {
      description
        "Grouping definition to assign
   group-ids to site or site-network-access.";
      container groups {
        description
          "Groups the site or site-network-access belongs to.";
        list group {
          key "group-id";
          description "List of group-ids.";
          leaf group-id {
            type string;
            description
              "Group-id the site belongs to.";
          }
        }  // list group
      }  // container groups
    }  // grouping site-group

    grouping site-diversity {
      description
        "This grouping defines site diversity parameters.";
      container site-diversity {
        if-feature site-diversity;
        description
          "Diversity constraint type.
     All site-network-accesses will inherit the group values
     defined here.";
        uses site-group;
      }  // container site-diversity
    }  // grouping site-diversity

    grouping access-diversity {
      description
        "This grouping defines access diversity parameters.";
      container access-diversity {
        if-feature site-diversity;
        description "Diversity parameters.";
        uses site-group;

        container constraints {
          description
            "Placement constraints for this site network access.";
          list constraint {
            key "constraint-type";
            description
              "List of constraints.";
            leaf constraint-type {
              type identityref {
                base placement-diversity;
              }
              description
                "Diversity constraint type.";
            }

            container target {
              description
                "The constraint will be applied against
        this list of groups.";
              choice target-flavor {
                description
                  "Choice for the group definition.";
                list group {
                  key "group-id";
                  description
                    "List of groups.";
                  leaf group-id {
                    type string;
                    description
                      "The constraint will be applied against
            this particular group-id.";
                  }
                }  // list group
                leaf all-other-accesses {
                  type empty;
                  description
                    "The constraint will be applied against
           all other site network accesses of this site.";
                }
                leaf all-other-groups {
                  type empty;
                  description
                    "The constraint will be applied against
           all other groups managed by the customer.";
                }
              }  // choice target-flavor
            }  // container target
          }  // list constraint
        }  // container constraints
      }  // container access-diversity
    }  // grouping access-diversity

    grouping operational-requirements {
      description
        "This grouping defines some operational parameters.";
      leaf requested-site-start {
        type yang:date-and-time;
        description
          "Optional leaf indicating requested date and time when the
       service at a particular site is expected to start.";
      }

      leaf requested-site-stop {
        type yang:date-and-time;
        description
          "Optional leaf indicating requested date and time when the
       service at a particular site is expected to stop.";
      }
    }  // grouping operational-requirements

    grouping operational-requirements-ops {
      description
        "This grouping defines some operational parameters.";
      leaf actual-site-start {
        type yang:date-and-time;
        config false;
        description
          "Optional leaf indicating actual date and time when the
       service at a particular site actually started.";
      }

      leaf actual-site-stop {
        type yang:date-and-time;
        config false;
        description
          "Optional leaf indicating actual date and time when the
       service at a particular site actually stopped.";
      }
    }  // grouping operational-requirements-ops

    grouping flow-definition {
      description
        "Flow definition based on criteria.";
      container match-flow {
        description
          "Describes flow-matching criteria.";
        leaf dscp {
          type inet:dscp;
          description "DSCP value.";
        }

        leaf dot1p {
          type uint8 {
            range "0..7";
          }
          description "802.1p matching.";
        }

        leaf ipv4-src-prefix {
          type inet:ipv4-prefix;
          description
            "Match on IPv4 src address.";
        }

        leaf ipv6-src-prefix {
          type inet:ipv6-prefix;
          description
            "Match on IPv6 src address.";
        }

        leaf ipv4-dst-prefix {
          type inet:ipv4-prefix;
          description
            "Match on IPv4 dst address.";
        }

        leaf ipv6-dst-prefix {
          type inet:ipv6-prefix;
          description
            "Match on IPv6 dst address.";
        }

        leaf l4-src-port {
          type inet:port-number;
          description
            "Match on Layer 4 src port.";
        }

        leaf-list target-sites {
          type svc-id;
          description
            "Identify a site as traffic destination.";
        }

        container l4-src-port-range {
          description
            "Match on Layer 4 src port range.";
          leaf lower-port {
            type inet:port-number;
            description
              "Lower boundary for port.";
          }

          leaf upper-port {
            type inet:port-number;
            must ". >= ../lower-port" {
              description
                "Upper boundary must be higher than lower boundary.";
            }
            description
              "Upper boundary for port.";
          }
        }  // container l4-src-port-range

        leaf l4-dst-port {
          type inet:port-number;
          description
            "Match on Layer 4 dst port.";
        }

        container l4-dst-port-range {
          description
            "Match on Layer 4 dst port range.";
          leaf lower-port {
            type inet:port-number;
            description
              "Lower boundary for port.";
          }

          leaf upper-port {
            type inet:port-number;
            must ". >= ../lower-port" {
              description
                "Upper boundary must be higher than lower boundary.";
            }
            description
              "Upper boundary for port.";
          }
        }  // container l4-dst-port-range

        leaf protocol-field {
          type union {
            type uint8;
            type identityref {
              base protocol-type;
            }
          }
          description
            "Match on IPv4 protocol or IPv6 Next Header field.";
        }
      }  // container match-flow
    }  // grouping flow-definition

    grouping site-service-basic {
      description
        "Defines basic service parameters for a site.";
      leaf svc-input-bandwidth {
        type uint32;
        units "bps";
        description
          "From the PE's perspective, the service input
       bandwidth of the connection.";
      }

      leaf svc-output-bandwidth {
        type uint32;
        units "bps";
        description
          "From the PE's perspective, the service output
      bandwidth of the connection.";
      }

      leaf svc-mtu {
        type uint16;
        units "bytes";
        description
          "MTU at service level.  If the service is IP,
    it refers to the IP MTU.";
      }
    }  // grouping site-service-basic

    grouping site-protection {
      description
        "Defines protection service parameters for a site.";
      container traffic-protection {
        if-feature fast-reroute;
        description
          "Fast Reroute service parameters for the site.";
        leaf enabled {
          type boolean;
          default 'false';
          description
            "Enables traffic protection of access link.";
        }
      }  // container traffic-protection
    }  // grouping site-protection

    grouping site-service-mpls {
      description
        "Defines MPLS service parameters for a site.";
      container carrierscarrier {
        if-feature carrierscarrier;
        description
          "This container is used when the customer provides
    MPLS-based services.  This is used in the case of CsC.";
        leaf signalling-type {
          type enumeration {
            enum "ldp" {
              value 0;
              description
                "Use LDP as the signalling protocol
       between the PE and the CE.";
            }
            enum "bgp" {
              value 1;
              description
                "Use BGP (as per RFC 3107) as the signalling protocol
       between the PE and the CE.
       In this case, BGP must also be configured as
       the routing protocol.";
            }
          }
          description
            "MPLS signalling type.";
        }
      }  // container carrierscarrier
    }  // grouping site-service-mpls

    grouping site-service-qos-profile {
      description
        "This grouping defines QoS parameters for a site.";
      container qos {
        if-feature qos;
        description "QoS configuration.";
        container qos-classification-policy {
          description
            "Configuration of the traffic classification policy.";
          list rule {
            key "id";
            ordered-by user;
            description
              "List of marking rules.";
            leaf id {
              type uint16;
              description "ID of the rule.";
            }

            choice match-type {
              description
                "Choice for classification.";
              case match-flow {
                uses flow-definition;
              }  // case match-flow
              leaf match-application {
                type identityref {
                  base customer-application;
                }
                description
                  "Defines the application to match.";
              }
            }  // choice match-type

            leaf target-class-id {
              type string;
              description
                "Identification of the class of service.
       This identifier is internal to the administration.";
            }
          }  // list rule
        }  // container qos-classification-policy

        container qos-profile {
          description
            "QoS profile configuration.";
          choice qos-profile {
            description
              "Choice for QoS profile.
      Can be standard profile or custom.";
            leaf profile {
              type string;
              description
                "QoS profile to be used.";
            }
            container classes {
              if-feature qos-custom;
              description
                "Container for list of classes of services.";
              list class {
                key "class-id";
                description
                  "List of classes of services.";
                leaf class-id {
                  type string;
                  description
                    "Identification of the class of service.
          This identifier is internal to the administration.";
                }

                leaf rate-limit {
                  type uint8;
                  units "percent";
                  description
                    "To be used if the class must be rate-limited.
          Expressed as percentage of the service bandwidth.";
                }

                container latency {
                  description
                    "Latency constraint on the traffic class.";
                  choice flavor {
                    description
                      "Latency constraint on the traffic class.";
                    leaf use-lowest-latency {
                      type empty;
                      description
                        "The traffic class should use the path with the
             lowest latency.";
                    }
                    leaf latency-boundary {
                      type uint16;
                      units "msec";
                      description
                        "The traffic class should use a path with a
             defined maximum latency.";
                    }
                  }  // choice flavor
                }  // container latency

                container jitter {
                  description
                    "Jitter constraint on the traffic class.";
                  choice flavor {
                    description
                      "Jitter constraint on the traffic class.";
                    leaf use-lowest-jitter {
                      type empty;
                      description
                        "The traffic class should use the path with the
             lowest jitter.";
                    }
                    leaf latency-boundary {
                      type uint32;
                      units "usec";
                      description
                        "The traffic class should use a path with a
             defined maximum jitter.";
                    }
                  }  // choice flavor
                }  // container jitter

                container bandwidth {
                  description
                    "Bandwidth constraint on the traffic class.";
                  leaf guaranteed-bw-percent {
                    type uint8;
                    units "percent";
                    description
                      "To be used to define the guaranteed bandwidth
           as a percentage of the available service bandwidth.";
                  }

                  leaf end-to-end {
                    type empty;
                    description
                      "Used if the bandwidth reservation
           must be done on the MPLS network too.";
                  }
                }  // container bandwidth
              }  // list class
            }  // container classes
          }  // choice qos-profile
        }  // container qos-profile
      }  // container qos
    }  // grouping site-service-qos-profile

    grouping site-security-authentication {
      description
        "This grouping defines authentication parameters for a site.";
      container authentication {
        description
          "Authentication parameters.";
      }  // container authentication
    }  // grouping site-security-authentication

    grouping site-security-encryption {
      description
        "This grouping defines encryption parameters for a site.";
      container encryption {
        if-feature encryption;
        description "Encryption parameters.";
        leaf enabled {
          type boolean;
          default 'false';
          description
            "If true, access encryption is required.";
        }

        leaf layer {
          type enumeration {
            enum "layer2" {
              value 0;
              description
                "Encryption will occur at Layer 2.";
            }
            enum "layer3" {
              value 1;
              description
                "Encryption will occur at Layer 3.
       For example, IPsec may be used.";
            }
          }
          mandatory true;
          description
            "Layer on which encryption is applied.";
        }

        container encryption-profile {
          description
            "Profile of encryption to be applied.";
          choice profile {
            description "Choice of profile.";
            leaf profile-name {
              type string;
              description
                "Name of the SP profile to be applied.";
            }

            case customer-profile {
              leaf algorithm {
                type string;
                description
                  "Encryption algorithm to be used.";
              }

              choice key-type {
                description
                  "Type of keys to be used.";
                leaf preshared-key {
                  type string;
                  description
                    "Key coming from customer.";
                }

                case pki {
                }  // case pki
              }  // choice key-type
            }  // case customer-profile
          }  // choice profile
        }  // container encryption-profile
      }  // container encryption
    }  // grouping site-security-encryption

    grouping site-attachment-bearer {
      description
        "Defines physical properties of a site attachment.";
      container bearer {
        description
          "Bearer-specific parameters.
    To be augmented.";
        container requested-type {
          if-feature requested-type;
          description
            "Container for requested-type.";
          leaf requested-type {
            type string;
            description
              "Type of requested bearer: Ethernet, DSL,
      Wireless, etc.  Operator specific.";
          }

          leaf strict {
            type boolean;
            default 'false';
            description
              "Defines whether requested-type is a preference
      or a strict requirement.";
          }
        }  // container requested-type

        leaf always-on {
          if-feature always-on;
          type boolean;
          default 'true';
          description
            "Request for an always-on access type.
     For example, this could mean no dial access type.";
        }

        leaf bearer-reference {
          if-feature bearer-reference;
          type string;
          description
            "This is an internal reference for the SP.";
        }
      }  // container bearer
    }  // grouping site-attachment-bearer

    grouping site-routing {
      description
        "Grouping for routing protocols.";
      container routing-protocols {
        description
          "Defines routing protocols.";
        list routing-protocol {
          key "type";
          description
            "List of routing protocols used on
     the site.  This list can be augmented.";
          leaf type {
            type identityref {
              base routing-protocol-type;
            }
            description
              "Type of routing protocol.";
          }

          container ospf {
            when "../type = 'ospf'" {
              description
                "Only applies when protocol is OSPF.";
            }
            if-feature rtg-ospf;
            description
              "OSPF-specific configuration.";
            leaf-list address-family {
              type address-family;
              description
                "Address family to be activated.";
            }

            leaf area-address {
              type yang:dotted-quad;
              description "Area address.";
            }

            leaf metric {
              type uint16;
              description
                "Metric of the PE-CE link.";
            }

            container sham-links {
              if-feature rtg-ospf-sham-link;
              description
                "List of sham links.";
              list sham-link {
                key "target-site";
                description
                  "Creates a sham link with another site.";
                leaf target-site {
                  type svc-id;
                  description
                    "Target site for the sham link connection.
         The site is referred to by its ID.";
                }

                leaf metric {
                  type uint16;
                  description
                    "Metric of the sham link.";
                }
              }  // list sham-link
            }  // container sham-links
          }  // container ospf

          container bgp {
            when "../type = 'bgp'" {
              description
                "Only applies when protocol is BGP.";
            }
            if-feature rtg-bgp;
            description
              "BGP-specific configuration.";
            leaf autonomous-system {
              type uint32;
              description "AS number.";
            }

            leaf-list address-family {
              type address-family;
              description
                "Address family to be activated.";
            }
          }  // container bgp

          container static {
            when "../type = 'static'" {
              description
                "Only applies when protocol is static.";
            }
            description
              "Configuration specific to static routing.";
            container cascaded-lan-prefixes {
              description
                "LAN prefixes from the customer.";
              list ipv4-lan-prefixes {
                if-feature ipv4;
                key "lan next-hop";
                description
                  "List of LAN prefixes for the site.";
                leaf lan {
                  type inet:ipv4-prefix;
                  description
                    "LAN prefixes.";
                }

                leaf lan-tag {
                  type string;
                  description
                    "Internal tag to be used in VPN policies.";
                }

                leaf next-hop {
                  type inet:ipv4-address;
                  description
                    "Next-hop address to use on the customer side.";
                }
              }  // list ipv4-lan-prefixes

              list ipv6-lan-prefixes {
                if-feature ipv6;
                key "lan next-hop";
                description
                  "List of LAN prefixes for the site.";
                leaf lan {
                  type inet:ipv6-prefix;
                  description
                    "LAN prefixes.";
                }

                leaf lan-tag {
                  type string;
                  description
                    "Internal tag to be used in VPN policies.";
                }

                leaf next-hop {
                  type inet:ipv6-address;
                  description
                    "Next-hop address to use on the customer side.";
                }
              }  // list ipv6-lan-prefixes
            }  // container cascaded-lan-prefixes
          }  // container static

          container rip {
            when "../type = 'rip'" {
              description
                "Only applies when protocol is RIP.";
            }
            if-feature rtg-rip;
            description
              "Configuration specific to RIP routing.";
            leaf-list address-family {
              type address-family;
              description
                "Address family to be activated.";
            }
          }  // container rip

          container vrrp {
            when "../type = 'vrrp'" {
              description
                "Only applies when protocol is VRRP.";
            }
            if-feature rtg-vrrp;
            description
              "Configuration specific to VRRP routing.";
            leaf-list address-family {
              type address-family;
              description
                "Address family to be activated.";
            }
          }  // container vrrp
        }  // list routing-protocol
      }  // container routing-protocols
    }  // grouping site-routing

    grouping site-attachment-ip-connection {
      description
        "This grouping defines IP connection parameters.";
      container ip-connection {
        description
          "Defines connection parameters.";
        container ipv4 {
          if-feature ipv4;
          description
            "IPv4-specific parameters.";
          leaf address-allocation-type {
            type identityref {
              base address-allocation-type;
            }
            default "static-address";
            description
              "Defines how addresses are allocated.";
          }

          leaf number-of-dynamic-address {
            when
              "../address-allocation-type = 'provider-dhcp'" {
              description
                "Only applies when addresses are allocated by DHCP.";
            }
            type uint8;
            default '1';
            description
              "Describes the number of IP addresses the customer requires.";
          }

          container dhcp-relay {
            when
              "../address-allocation-type = 'provider-dhcp-relay'" {
              description
                "Only applies when provider is required to implement
       DHCP relay function.";
            }
            description
              "DHCP relay provided by operator.";
            container customer-dhcp-servers {
              description
                "Container for list of customer DHCP servers.";
              leaf-list server-ip-address {
                type inet:ipv4-address;
                description
                  "IP address of customer DHCP server.";
              }
            }  // container customer-dhcp-servers
          }  // container dhcp-relay

          container addresses {
            when
              "../address-allocation-type = 'static-address'" {
              description
                "Only applies when protocol allocation type is static.";
            }
            description
              "Describes IP addresses used.";
            leaf provider-address {
              type inet:ipv4-address;
              description
                "Address of provider side.";
            }

            leaf customer-address {
              type inet:ipv4-address;
              description
                "Address of customer side.";
            }

            leaf mask {
              type uint8 {
                range "0..31";
              }
              description
                "Subnet mask expressed in bits.";
            }
          }  // container addresses
        }  // container ipv4

        container ipv6 {
          if-feature ipv6;
          description
            "IPv6-specific parameters.";
          leaf address-allocation-type {
            type identityref {
              base address-allocation-type;
            }
            default "static-address";
            description
              "Defines how addresses are allocated.";
          }

          leaf number-of-dynamic-address {
            when
              "../address-allocation-type = 'provider-dhcp' "
                + "or ../address-allocation-type "
                + "= 'provider-dhcp-slaac'" {
              description
                "Only applies when addresses are allocated by DHCP.";
            }
            type uint8;
            default '1';
            description
              "Describes the number of IP addresses the customer requires.";
          }

          container dhcp-relay {
            when
              "../address-allocation-type = 'provider-dhcp-relay'" {
              description
                "Only applies when provider is required to implement
       DHCP relay function.";
            }
            description
              "DHCP relay provided by operator.";
            container customer-dhcp-servers {
              description
                "Container for list of customer DHCP servers.";
              leaf-list server-ip-address {
                type inet:ipv6-address;
                description
                  "IP address of customer DHCP server.";
              }
            }  // container customer-dhcp-servers
          }  // container dhcp-relay

          container addresses {
            when
              "../address-allocation-type = 'static-address'" {
              description
                "Only applies when protocol allocation type is static.";
            }
            description
              "Describes IP addresses used.";
            leaf provider-address {
              type inet:ipv6-address;
              description
                "Address of provider side.";
            }

            leaf customer-address {
              type inet:ipv6-address;
              description
                "Address of customer side.";
            }

            leaf mask {
              type uint8 {
                range "0..127";
              }
              description
                "Subnet mask expressed in bits.";
            }
          }  // container addresses
        }  // container ipv6

        container oam {
          description
            "Defines the OAM mechanisms used on the connection.";
          container bfd {
            if-feature bfd;
            description "Container for BFD.";
            leaf enabled {
              type boolean;
              default 'false';
              description "BFD activation.";
            }

            choice holdtime {
              description
                "Choice for holdtime flavor.";
              case profile {
                description
                  "Well-known SP profile.";
                leaf profile-name {
                  type string;
                  description
                    "Well-known SP profile.";
                }
              }  // case profile
              leaf fixed-value {
                type uint32;
                units "msec";
                description
                  "Expected holdtime expressed in msec.";
              }
            }  // choice holdtime
          }  // container bfd
        }  // container oam
      }  // container ip-connection
    }  // grouping site-attachment-ip-connection

    grouping site-service-multicast {
      description
        "Multicast parameters for the site.";
      container multicast {
        if-feature multicast;
        description
          "Multicast parameters for the site.";
        leaf multicast-site-type {
          type enumeration {
            enum "receiver-only" {
              value 0;
              description
                "The site only has receivers.";
            }
            enum "source-only" {
              value 1;
              description
                "The site only has sources.";
            }
            enum "source-receiver" {
              value 2;
              description
                "The site has both sources and receivers.";
            }
          }
          default "source-receiver";
          description
            "Type of multicast site.";
        }

        container multicast-address-family {
          description
            "Defines protocol to carry multicast.";
          leaf ipv4 {
            if-feature ipv4;
            type boolean;
            default 'true';
            description
              "Enables IPv4 multicast.";
          }

          leaf ipv6 {
            if-feature ipv6;
            type boolean;
            default 'false';
            description
              "Enables IPv6 multicast.";
          }
        }  // container multicast-address-family

        leaf protocol-type {
          type enumeration {
            enum "host" {
              value 0;
              description
                "Hosts are directly connected to the provider network.
       Host protocols such as IGMP or MLD are required.";
            }
            enum "router" {
              value 1;
              description
                "Hosts are behind a customer router.
       PIM will be implemented.";
            }
            enum "both" {
              value 2;
              description
                "Some hosts are behind a customer router, and some others
       are directly connected to the provider network.
       Both host and routing protocols must be used.
       Typically, IGMP and PIM will be implemented.";
            }
          }
          default "both";
          description
            "Multicast protocol type to be used with the customer site.";
        }
      }  // container multicast
    }  // grouping site-service-multicast

    grouping site-management {
      description
        "Management parameters for the site.";
      container management {
        description
          "Management configuration.";
        leaf type {
          type identityref {
            base management;
          }
          description
            "Management type of the connection.";
        }
      }  // container management
    }  // grouping site-management

    grouping site-devices {
      description
        "Grouping for device allocation.";
      container devices {
        must
          "/l3vpn-svc/sites/site/management/type = "
            + "'provider-managed' or "
            + "/l3vpn-svc/sites/site/management/type = "
            + "'co-managed'" {
          description
            "Applicable only for provider-managed or co-managed device.";
        }
        description
          "List of devices requested by customer.";
        list device {
          key "device-id";
          description
            "Device configuration.";
          leaf device-id {
            type svc-id;
            description
              "Identifier for the device.";
          }

          leaf location {
            type leafref {
              path
                "/l3vpn-svc/sites/site/locations/"
                  + "location/location-id";
            }
            description
              "Location of the device.";
          }

          container management {
            must
              "/l3vpn-svc/sites/site/management/type"
                + "= 'co-managed'" {
              description
                "Applicable only for co-managed device.";
            }
            description
              "Management configuration.  Applicable only for
      co-managed device.";
            leaf address-family {
              type address-family;
              description
                "Address family used for management.";
            }

            leaf address {
              type inet:ip-address;
              description
                "Management address.";
            }
          }  // container management
        }  // list device
      }  // container devices
    }  // grouping site-devices

    grouping site-vpn-flavor {
      description
        "Grouping for site VPN flavor.";
      leaf site-vpn-flavor {
        type identityref {
          base site-vpn-flavor;
        }
        default 'site-vpn-flavor-single';
        description
          "Defines whether the site is, for example,
    a single VPN site or a multiVPN.";
      }
    }  // grouping site-vpn-flavor

    grouping site-vpn-policy {
      description
        "VPN policy parameters for the site.";
      container vpn-policies {
        description "VPN policy.";
        list vpn-policy {
          key "vpn-policy-id";
          description
            "List of VPN policies.";
          leaf vpn-policy-id {
            type svc-id;
            description
              "Unique identifier for the VPN policy.";
          }

          list entries {
            key "id";
            description
              "List of entries for export policy.";
            leaf id {
              type svc-id;
              description
                "Unique identifier for the policy entry.";
            }

            container filter {
              description
                "If used, it permits the splitting of
       site LANs among multiple VPNs.
       If no filter is used, all the LANs will be
       part of the same VPNs with the same role.";
              choice lan {
                description
                  "Choice of ways to do LAN matching.";
                case prefixes {
                  leaf-list ipv4-lan-prefix {
                    if-feature ipv4;
                    type inet:ipv4-prefix;
                    description
                      "List of IPv4 prefixes to be matched.";
                  }

                  leaf-list ipv6-lan-prefix {
                    if-feature ipv6;
                    type inet:ipv6-prefix;
                    description
                      "List of IPv6 prefixes to be matched.";
                  }
                }  // case prefixes
                leaf-list lan-tag {
                  type string;
                  description
                    "List of 'lan-tag' items to be matched.";
                }
              }  // choice lan
            }  // container filter

            container vpn {
              description
                "List of VPNs the LAN is associated with.";
              leaf vpn-id {
                type leafref {
                  path
                    "/l3vpn-svc/vpn-services/"
                      + "vpn-service/vpn-id";
                }
                mandatory true;
                description
                  "Reference to an IP VPN.";
              }

              leaf site-role {
                type identityref {
                  base site-role;
                }
                default 'any-to-any-role';
                description
                  "Role of the site in the IP VPN.";
              }
            }  // container vpn
          }  // list entries
        }  // list vpn-policy
      }  // container vpn-policies
    }  // grouping site-vpn-policy

    grouping site-maximum-routes {
      description
        "Defines 'maximum-routes' for the site.";
      container maximum-routes {
        description
          "Defines 'maximum-routes' for the VRF.";
        list address-family {
          key "af";
          description
            "List of address families.";
          leaf af {
            type address-family;
            description "Address family.";
          }

          leaf maximum-routes {
            type uint32;
            description
              "Maximum prefixes the VRF can accept for this address family.";
          }
        }  // list address-family
      }  // container maximum-routes
    }  // grouping site-maximum-routes

    grouping site-security {
      description
        "Grouping for security parameters.";
      container security {
        description
          "Site-specific security parameters.";
        uses site-security-authentication;

        uses site-security-encryption;
      }  // container security
    }  // grouping site-security

    grouping site-service {
      description
        "Grouping for service parameters.";
      container service {
        description
          "Service parameters on the attachment.";
        uses site-service-qos-profile;

        uses site-service-mpls;

        uses site-service-multicast;
      }  // container service
    }  // grouping site-service

    grouping site-network-access-service {
      description
        "Grouping for service parameters.";
      container service {
        description
          "Service parameters on the attachment.";
        uses site-service-basic;

        uses site-service-qos-profile;

        uses site-service-mpls;

        uses site-service-multicast;
      }  // container service
    }  // grouping site-network-access-service

    grouping vpn-extranet {
      description
        "Grouping for extranet VPN configuration.
   This provides an easy way to interconnect
   all sites from two VPNs.";
      container extranet-vpns {
        if-feature extranet-vpn;
        description
          "Container for extranet VPN configuration.";
        list extranet-vpn {
          key "vpn-id";
          description
            "List of extranet VPNs the local VPN is attached to.";
          leaf vpn-id {
            type svc-id;
            description
              "Identifies the target VPN.";
          }

          leaf local-sites-role {
            type identityref {
              base site-role;
            }
            default 'any-to-any-role';
            description
              "This describes the role of the
      local sites in the target VPN topology.";
          }
        }  // list extranet-vpn
      }  // container extranet-vpns
    }  // grouping vpn-extranet

    grouping site-attachment-availability {
      description
        "Defines availability parameters for a site.";
      container availability {
        description
          "Availability parameters (used for multihoming).";
        leaf access-priority {
          type uint32;
          default '1';
          description
            "Defines the priority for the access.
     The higher the access-priority value,
     the higher the preference of the access will be.";
        }
      }  // container availability
    }  // grouping site-attachment-availability

    grouping access-vpn-policy {
      description
        "Defines the VPN attachment rules for a site's logical access.";
      container vpn-attachment {
        description
          "Defines VPN attachment of a site.";
        choice attachment-flavor {
          mandatory true;
          description
            "Choice for VPN attachment flavor.";
          leaf vpn-policy-id {
            type leafref {
              path
                "/l3vpn-svc/sites/site/"
                  + "vpn-policies/vpn-policy/"
                  + "vpn-policy-id";
            }
            description
              "Reference to a VPN policy.";
          }

          case vpn-id {
            leaf vpn-id {
              type leafref {
                path
                  "/l3vpn-svc/vpn-services"
                    + "/vpn-service/vpn-id";
              }
              description
                "Reference to a VPN.";
            }

            leaf site-role {
              type identityref {
                base site-role;
              }
              default 'any-to-any-role';
              description
                "Role of the site in the IP VPN.";
            }
          }  // case vpn-id
        }  // choice attachment-flavor
      }  // container vpn-attachment
    }  // grouping access-vpn-policy

    grouping vpn-svc-cfg {
      description
        "Grouping for VPN service configuration.";
      leaf vpn-id {
        type svc-id;
        description
          "VPN identifier.  Local administration meaning.";
      }

      leaf customer-name {
        type string;
        description "Name of the customer.";
      }

      leaf vpn-service-topology {
        type identityref {
          base vpn-topology;
        }
        default "any-to-any";
        description "VPN service topology.";
      }

      uses vpn-service-cloud-access;

      uses vpn-service-multicast;

      uses vpn-service-mpls;

      uses vpn-extranet;
    }  // grouping vpn-svc-cfg

    grouping site-top-level-cfg {
      description
        "Grouping for site top-level configuration.";
      uses operational-requirements;

      uses customer-location-info;

      uses site-devices;

      uses site-diversity;

      uses site-management;

      uses site-vpn-policy;

      uses site-vpn-flavor;

      uses site-maximum-routes;

      uses site-security;

      uses site-service;

      uses site-protection;

      uses site-routing;
    }  // grouping site-top-level-cfg

    grouping site-network-access-top-level-cfg {
      description
        "Grouping for site network access top-level configuration.";
      leaf site-network-access-type {
        type identityref {
          base site-network-access-type;
        }
        default "point-to-point";
        description
          "Describes the type of connection, e.g.,
    point-to-point or multipoint.";
      }

      choice location-flavor {
        mandatory true;
        description
          "Choice of how to describe the site's location.";
        case location {
          when
            "/l3vpn-svc/sites/site/management/type = "
              + "'customer-managed'" {
            description
              "Applicable only for customer-managed device.";
          }
          leaf location-reference {
            type leafref {
              path
                "/l3vpn-svc/sites/site/locations/"
                  + "location/location-id";
            }
            description
              "Location of the site-network-access.";
          }
        }  // case location

        case device {
          when
            "/l3vpn-svc/sites/site/management/type = "
              + "'provider-managed' or "
              + "/l3vpn-svc/sites/site/management/type = "
              + "'co-managed'" {
            description
              "Applicable only for provider-managed or co-managed device.";
          }
          leaf device-reference {
            type leafref {
              path
                "/l3vpn-svc/sites/site/devices/"
                  + "device/device-id";
            }
            description
              "Identifier of CE to use.";
          }
        }  // case device
      }  // choice location-flavor

      uses access-diversity;

      uses site-attachment-bearer;

      uses site-attachment-ip-connection;

      uses site-security;

      uses site-network-access-service;

      uses site-routing;

      uses site-attachment-availability;

      uses access-vpn-policy;
    }  // grouping site-network-access-top-level-cfg

    container l3vpn-svc {
      description
        "Main container for L3VPN service configuration.";
      container vpn-services {
        description
          "Top-level container for the VPN services.";
        list vpn-service {
          key "vpn-id";
          description
            "List of VPN services.";
          uses vpn-svc-cfg;
        }  // list vpn-service
      }  // container vpn-services

      container sites {
        description "Container for sites.";
        list site {
          key "site-id";
          description "List of sites.";
          leaf site-id {
            type svc-id;
            description
              "Identifier of the site.";
          }

          uses site-top-level-cfg;

          uses operational-requirements-ops;

          container site-network-accesses {
            description
              "List of accesses for a site.";
            list site-network-access {
              key "site-network-access-id";
              description
                "List of accesses for a site.";
              leaf site-network-access-id {
                type svc-id;
                description
                  "Identifier for the access.";
              }

              uses site-network-access-top-level-cfg;
            }  // list site-network-access
          }  // container site-network-accesses
        }  // list site
      }  // container sites
    }  // container l3vpn-svc
  }  // module ietf-l3vpn-svc