netconfcentral logo

service-function-description-monitor-report

HTML

service-function-description-monitor-report@2014-11-05



  module service-function-description-monitor-report {

    yang-version 1;

    namespace
      "urn.intel.params:xml:ns:sf-desc-mon-rpt";

    prefix sf-desc-mon-rpt;

    import ietf-inet-types {
      prefix inet;
      revision-date "2010-09-24";
    }
    import ietf-yang-types {
      prefix yang;
      revision-date "2010-09-24";
    }

    organization "Intel Inc.";

    contact "honglix.chen@intel.com";

    description
      "The module for entities implementing the network service functions for Service Function Chaining";

    revision "2014-11-05" {
      description "Initial revision.";
    }


    grouping SF-description {
      leaf data-plane-ip {
        type inet:ip-address;
        description "Data-plane IP address";
      }

      leaf data-plane-port {
        type inet:port-number;
        description "Data-plane port number";
      }

      leaf type {
        type string;
        description "SF type";
      }

      leaf number-of-dataports {
        type uint32;
        description "Number of dataports";
      }

      container capabilities {
        leaf supported-packet-rate {
          type uint32;
          description
            "Maximum Mpps supported";
        }

        leaf supported-bandwidth {
          type uint32;
          description
            "Maximum Mbps supported ";
        }

        leaf supported-ACL-number {
          type uint32;
          description
            "ACL number of the service function";
        }

        leaf RIB-size {
          type uint32;
          description
            "Number of Routing Information Table's entries.";
        }

        leaf FIB-size {
          type uint32;
          description
            "Number of Forwarding Information Table's entries.";
        }

        container ports-bandwidth {
          list port-bandwidth {
            key "port-id";
            leaf port-id {
              type uint32;
              description
                "The id of the port ";
            }

            leaf ipaddress {
              type inet:ipv4-address;
              description
                "IP address of the port";
            }

            leaf macaddress {
              type yang:mac-address;
              description
                "MAC address of the the port";
            }

            leaf supported-bandwidth {
              type uint32;
              description
                "Maximum Mbps supported by the port";
            }
          }  // list port-bandwidth
        }  // container ports-bandwidth
      }  // container capabilities
    }  // grouping SF-description

    grouping SF-monitoring-info {
      leaf liveness {
        type boolean;
        description
          "Liveness flag of the service function";
      }

      container resource-utilization {
        leaf packet-rate-utilization {
          type uint32;
          description
            "Percentage of current package rate utilization.";
        }

        leaf bandwidth-utilization {
          type uint32;
          description
            "Percentage of bandwidth utilization.";
        }

        leaf CPU-utilization {
          type uint32;
          description
            "Percentage of CPU utilization.";
        }

        leaf memory-utilization {
          type uint32;
          description
            "Percentage of memory utilization.";
        }

        leaf available-memory {
          type uint32;
          description
            "Available memory size of the service function in MB.";
        }

        leaf RIB-utilization {
          type uint32;
          description
            "Percentage of Routing Information Table utilization.";
        }

        leaf FIB-utilization {
          type uint32;
          description
            "Percentage of Forwarding Information Table utilization.";
        }

        leaf power-utilization {
          type uint32;
          description
            "power utilization in W.";
        }

        container SF-ports-bandwidth-utilization {
          list port-bandwidth-utilization {
            key "port-id";
            leaf port-id {
              type uint32;
              description
                "The id of the port ";
            }

            leaf bandwidth-utilization {
              type uint32;
              description
                "Percentage of the port's supported bandwidth utilization.";
            }

            leaf rx-packet {
              type yang:zero-based-counter64;
              description
                "The number of received packets.";
            }

            leaf tx-packet {
              type yang:zero-based-counter64;
              description
                "The number of transmitted packets.";
            }

            leaf rx-bytes {
              type yang:zero-based-counter64;
              description
                "The number of received bytes.";
            }

            leaf tx-bytes {
              type yang:zero-based-counter64;
              description
                "The number of transmitted bytes.";
            }

            leaf rx-bytes-rate {
              type uint32;
              description
                "Bytes received rate.";
            }

            leaf tx-bytes-rate {
              type uint32;
              description
                "Bytes transmitted rate.";
            }

            leaf rx-packet-rate {
              type uint32;
              description
                "Packets received rate.";
            }

            leaf tx-packet-rate {
              type uint32;
              description
                "Packets transmitted rate.";
            }
          }  // list port-bandwidth-utilization
        }  // container SF-ports-bandwidth-utilization
      }  // container resource-utilization
    }  // grouping SF-monitoring-info

    container service-function {
      container description-info {
        uses SF-description;
      }  // container description-info

      container monitoring-info {
        uses SF-monitoring-info;
      }  // container monitoring-info
    }  // container service-function

    rpc get-SF-description {
      description
        "Get service function description information.";
      output {
        container description-info {
          uses SF-description;
        }  // container description-info
      }
    }  // rpc get-SF-description

    rpc get-SF-monitoring-info {
      description
        "Get current service function monitoring information.";
      output {
        container monitoring-info {
          uses SF-monitoring-info;
        }  // container monitoring-info
      }
    }  // rpc get-SF-monitoring-info
  }  // module service-function-description-monitor-report

Summary

  
  
Organization Intel Inc.
  
Module service-function-description-monitor-report
Version 2014-11-05
File service-function-description-monitor-report@2014-11-05.yang
  
Prefix sf-desc-mon-rpt
Namespace urn.intel.params:xml:ns:sf-desc-mon-rpt
  
Cooked /cookedmodules/service-function-description-monitor-report/2014-11-05
YANG /src/service-function-description-monitor-report@2014-11-05.yang
XSD /xsd/service-function-description-monitor-report@2014-11-05.xsd
  
Abstract The module for entities implementing the network service functions for Service Function Chaining
  
Contact
honglix.chen@intel.com

Description

 
The module for entities implementing the network service functions for Service Function Chaining

Groupings

Grouping Objects Abstract
SF-description data-plane-ip data-plane-port type number-of-dataports capabilities
SF-monitoring-info liveness resource-utilization

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
service-function container description-info monitoring-info
   description-info container data-plane-ip data-plane-port type number-of-dataports capabilities
      capabilities container supported-packet-rate supported-bandwidth supported-ACL-number RIB-size FIB-size ports-bandwidth
         FIB-size leaf Number of Forwarding Information Table's entries.
         ports-bandwidth container port-bandwidth
            port-bandwidth list port-id ipaddress macaddress supported-bandwidth
               ipaddress leaf IP address of the port
               macaddress leaf MAC address of the the port
               port-id leaf The id of the port
               supported-bandwidth leaf Maximum Mbps supported by the port
         RIB-size leaf Number of Routing Information Table's entries.
         supported-ACL-number leaf ACL number of the service function
         supported-bandwidth leaf Maximum Mbps supported
         supported-packet-rate leaf Maximum Mpps supported
      data-plane-ip leaf Data-plane IP address
      data-plane-port leaf Data-plane port number
      number-of-dataports leaf Number of dataports
      type leaf SF type
   monitoring-info container liveness resource-utilization
      liveness leaf Liveness flag of the service function
      resource-utilization container packet-rate-utilization bandwidth-utilization CPU-utilization memory-utilization available-memory RIB-utilization FIB-utilization power-utilization SF-ports-bandwidth-utilization
         available-memory leaf Available memory size of the service function in MB.
         bandwidth-utilization leaf Percentage of bandwidth utilization.
         CPU-utilization leaf Percentage of CPU utilization.
         FIB-utilization leaf Percentage of Forwarding Information Table utilization.
         memory-utilization leaf Percentage of memory utilization.
         packet-rate-utilization leaf Percentage of current package rate utilization.
         power-utilization leaf power utilization in W.
         RIB-utilization leaf Percentage of Routing Information Table utilization.
         SF-ports-bandwidth-utilization container port-bandwidth-utilization
            port-bandwidth-utilization list port-id bandwidth-utilization rx-packet tx-packet rx-bytes tx-bytes rx-bytes-rate tx-bytes-rate rx-packet-rate tx-packet-rate
               bandwidth-utilization leaf Percentage of the port's supported bandwidth utilization.
               port-id leaf The id of the port
               rx-bytes leaf The number of received bytes.
               rx-bytes-rate leaf Bytes received rate.
               rx-packet leaf The number of received packets.
               rx-packet-rate leaf Packets received rate.
               tx-bytes leaf The number of transmitted bytes.
               tx-bytes-rate leaf Bytes transmitted rate.
               tx-packet leaf The number of transmitted packets.
               tx-packet-rate leaf Packets transmitted rate.

RPC Methods

RPC Abstract
get-SF-description Get service function description information.
get-SF-monitoring-info Get current service function monitoring information.