netconfcentral logo

ietf-ipfix-bulk-data-export

HTML

ietf-ipfix-bulk-data-export@2020-03-05



  module ietf-ipfix-bulk-data-export {

    yang-version 1.1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-ipfix-bulk-data-export";

    prefix ibde;

    import ietf-yang-types {
      prefix yang;
      reference
        "RFC 6991: Common YANG Data Types";


    }
    import ietf-ipfix {
      prefix ipfix;
      reference
        "RFC XXXX: YANG Data Models for the IP Flow Information Export
        (IPFIX) Protocol, Packet Sampling (PSAMP) Protocol, and Bulk
        Data Export";


    }

    organization "IETF";

    contact
      "Web:      TBD
     List:     TBD

     Editor:   Joey Boyd
               <mailto:joey.boyd@adtran.com>

     Editor:   Marta Seda
               <mailto:marta.seda@calix.com>";

    description
      "This module contains a collection of YANG definitions for the
     management exporting bulk data over IPFIX.

     This data model is designed for the Network Management Datastore
     Architecture defined in RFC 8342.

     The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
     NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
     'MAY', and 'OPTIONAL' in this document are to be interpreted as
     described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
     they appear in all capitals, as shown here.

     Copyright (c) 2019 IETF Trust and the persons identified as
     authors of the code.  All rights reserved.

     Redistribution and use in source and binary forms, with or
     without modification, is permitted pursuant to, and subject to
     the license terms contained in, the Simplified BSD License set
     forth in Section 4.c of the IETF Trust's Legal Provisions
     Relating to IETF Documents
     (https://trustee.ietf.org/license-info).

     This version of this YANG module is part of RFC XXXX
     (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
     for full legal notices.";

    revision "2020-03-05" {
      description "Initial revision.";
      reference
        "RFC XXXX: YANG Data Models for the IP Flow Information Export
        	  (IPFIX) Protocol, Packet Sampling (PSAMP) Protocol,
        	  and Bulk Data Export";

    }


    feature bulk-data {
      description
        "If supported, bulk data templates can be configured.";
    }

    typedef resource {
      type instance-identifier;
      description
        "A resource from which bulk data will be exported.";
    }

    grouping bulk-data-template-parameters {
      description "Field Layout parameters.";
      leaf observation-domain-id {
        type uint32;
        default '0';
        description
          "An identifier of an Observation Domain that is locally
         unique to an Exporting Process (see RFC 7011 Section 3.1).

         Typically, this Information Element is for limiting the
         scope of other Information Elements.

         A value of 0 indicates that no specific Observation Domain
         is identified by this Information Element.";
      }

      container field-layout {
        description
          "Field Layout parameters.";
        list field {
          key "name";
          min-elements 1;
          description
            "Superset of statistics field names or special field-names
           (e.g., timestamps, etc) for interpreting statistics that
           are included in the Packet Reports or Flow Records
           generated by the device.";
          leaf name {
            type ipfix:name-type;
            description
              "An arbitrary string which uniquely identifies the
             field.";
          }

          choice identifier {
            mandatory true;
            description
              "The Information Element to be added to the template.";
            leaf ie-name {
              type ipfix:ie-name-type;
              description
                "Name of the Information Element.";
            }
            leaf ie-id {
              type ipfix:ie-id-type;
              description
                "ID of the Information Element.";
            }
          }  // choice identifier

          leaf ie-length {
            type uint16;
            units "octets";
            description
              "Length of the field in which the Information Element is
             encoded.  A value of 65535 specifies a variable-length
             Information Element.  For Information Elements of
             integer and float type, the field length MAY be set to a
             smaller value than the standard length of the abstract
             data type if the rules of reduced size encoding are
             fulfilled.

             If not configured by the user, this parameter is set by
             the Monitoring Device.";
            reference
              "RFC 7011, Section 6.2";

          }

          leaf ie-enterprise-number {
            type uint32;
            default '0';
            description
              "If this parameter is zero, the Information Element is
             registered in the IANA registry of IPFIX Information
             Elements or unspecified (if the Informational Element is
             not IANA registered).

             If this parameter is configured with a non-zero private
             enterprise number, the Information Element is
             enterprise-specific.";
            reference
              "RFC 7011; RFC 5103;
              IANA registry for Private Enterprise Numbers,
              http://www.iana.org/assignments/enterprise-numbers;
              IANA registry for IPFIX Entities,
              http://www.iana.org/assignments/ipfix";

          }
        }  // list field
      }  // container field-layout
    }  // grouping bulk-data-template-parameters

    augment /ipfix:ipfix {
      description
        "Augment IPFIX to add bulk data.";
      container bulk-data-export {
        description
          "Container for bulk data export nodes.";
        list template {
          key "name";
          description
            "List of bulk data templates of the Monitoring Device.";
          leaf name {
            type ipfix:name-type;
            description
              "An arbitrary string which uniquely identifies the
             bulk data template.";
          }

          leaf enabled {
            type boolean;
            default "true";
            description
              "If true, this template is enabled and the specified
             data is able to be exported.";
          }

          leaf export-interval {
            type uint32;
            units "seconds";
            description
              "This parameter configures the interval (in seconds) for
             periodical export of Flow Records.

             If not configured by the user, the Monitoring Device
             sets this parameter.";
          }

          uses bulk-data-template-parameters;

          leaf-list exporting-process {
            if-feature ipfix:exporter;
            type leafref {
              path "/ipfix:ipfix/ipfix:exporting-process/ipfix:name";
            }
            description
              "Records are exported by all Exporting Processes in the
             list.";
          }

          choice resource-identifier {
            description
              "Method to select the resources from which the records
             are to be exported.";
            leaf-list resource-instance {
              type resource;
              description
                "Records are sourced from all the resources in
                 this list.";
            }
          }  // choice resource-identifier

          leaf data-records {
            type yang:counter64;
            units "Data Records";
            config false;
            description
              "The number of Data Records generated for this sampling
             template.

             Discontinuities in the value of this counter can occur
             at re-initialization of the management system, and at
             other times as indicated by the value of Discontinuity
             Time.";
          }

          leaf discontinuity-time {
            type yang:date-and-time;
            config false;
            description
              "Timestamp of the most recent occasion at which the
             counter data records suffered a discontinuity.";
          }
        }  // list template
      }  // container bulk-data-export
    }
  }  // module ietf-ipfix-bulk-data-export

Summary

  
  
Organization IETF
  
Module ietf-ipfix-bulk-data-export
Version 2020-03-05
File ietf-ipfix-bulk-data-export@2020-03-05.yang
  
Prefix ibde
Namespace urn:ietf:params:xml:ns:yang:ietf-ipfix-bulk-data-export
  
Cooked /cookedmodules/ietf-ipfix-bulk-data-export/2020-03-05
YANG /src/ietf-ipfix-bulk-data-export@2020-03-05.yang
XSD /xsd/ietf-ipfix-bulk-data-export@2020-03-05.xsd
  
Abstract This module contains a collection of YANG definitions for the management exporting bulk data over IPFIX. This data model is des...
  
Contact
Web:      TBD
List:     TBD

Editor:   Joey Boyd
	  <mailto:joey.boyd@adtran.com>

Editor:   Marta Seda
	  <mailto:marta.seda@calix.com>

Description

 
This module contains a collection of YANG definitions for the
management exporting bulk data over IPFIX.

This data model is designed for the Network Management Datastore
Architecture defined in RFC 8342.

The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
'MAY', and 'OPTIONAL' in this document are to be interpreted as
described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.

Copyright (c) 2019 IETF Trust and the persons identified as
authors of the code.  All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).

This version of this YANG module is part of RFC XXXX
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.

Typedefs

Typedef Base type Abstract
resource instance-identifier A resource from which bulk data will be exported.

Groupings

Grouping Objects Abstract
bulk-data-template-parameters observation-domain-id field-layout Field Layout parameters.