Interface Counters

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Counters>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<InterfaceCountersState>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    public interface Counters
    extends org.opendaylight.yangtools.yang.binding.ChildOf<InterfaceCountersState>, org.opendaylight.yangtools.yang.binding.Augmentable<Counters>
    A collection of interface-related statistics objects.

    This class represents the following YANG schema fragment defined in module openconfig-interfaces

     container counters {
       leaf in-octets {
         type yang:counter64;
       }
       leaf in-unicast-pkts {
         type yang:counter64;
       }
       leaf in-broadcast-pkts {
         type yang:counter64;
       }
       leaf in-multicast-pkts {
         type yang:counter64;
       }
       leaf in-discards {
         type yang:counter64;
       }
       leaf in-errors {
         type yang:counter64;
       }
       leaf in-unknown-protos {
         type yang:counter32;
       }
       leaf out-octets {
         type yang:counter64;
       }
       leaf out-unicast-pkts {
         type yang:counter64;
       }
       leaf out-broadcast-pkts {
         type yang:counter64;
       }
       leaf out-multicast-pkts {
         type yang:counter64;
       }
       leaf out-discards {
         type yang:counter64;
       }
       leaf out-errors {
         type yang:counter64;
       }
       leaf last-clear {
         type yang:date-and-time;
       }
     }
     
    The schema path to identify an instance is openconfig-interfaces/interface-counters-state/counters

    To create instances of this class use CountersBuilder.

    See Also:
    CountersBuilder
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInBroadcastPkts()
      [adapted from IETF interfaces model (RFC 7223)] The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were addressed to a broadcast address at this sub-layer.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInDiscards()
      [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInErrors()
      [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInMulticastPkts()
      [adapted from IETF interfaces model (RFC 7223)] The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were addressed to a multicast address at this sub-layer.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInOctets()
      [adapted from IETF interfaces model (RFC 7223)] The total number of octets received on the interface, including framing characters.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInUnicastPkts()
      [adapted from IETF interfaces model (RFC 7223)] The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were not addressed to a multicast or broadcast address at this sub-layer.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getInUnknownProtos()
      [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getLastClear()
      Indicates the last time the interface counters were cleared.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutBroadcastPkts()
      [adapted from IETF interfaces model (RFC 7223)] The total number of packets that higher-level protocols requested be transmitted, and that were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutDiscards()
      [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutErrors()
      [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutMulticastPkts()
      [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutOctets()
      [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutUnicastPkts()
      [adapted from IETF interfaces model (RFC 7223)] The total number of packets that higher-level protocols requested be transmitted, and that were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent.
      default Class<Counters> implementedInterface()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default Class<Counters> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getInOctets

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInOctets()
        [adapted from IETF interfaces model (RFC 7223)] The total number of octets received on the interface, including framing characters. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 inOctets, or null if not present
      • getInUnicastPkts

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInUnicastPkts()
        [adapted from IETF interfaces model (RFC 7223)] The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were not addressed to a multicast or broadcast address at this sub-layer. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 inUnicastPkts, or null if not present
      • getInBroadcastPkts

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInBroadcastPkts()
        [adapted from IETF interfaces model (RFC 7223)] The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were addressed to a broadcast address at this sub-layer. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 inBroadcastPkts, or null if not present
      • getInMulticastPkts

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInMulticastPkts()
        [adapted from IETF interfaces model (RFC 7223)] The number of packets, delivered by this sub-layer to a higher (sub-)layer, that were addressed to a multicast address at this sub-layer. For a MAC-layer protocol, this includes both Group and Functional addresses. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 inMulticastPkts, or null if not present
      • getInDiscards

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInDiscards()
        [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64. The number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 inDiscards, or null if not present
      • getInErrors

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getInErrors()
        [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64. For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character- oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 inErrors, or null if not present
      • getInUnknownProtos

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getInUnknownProtos()
        [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64. For packet-oriented interfaces, the number of packets received via the interface that were discarded because of an unknown or unsupported protocol. For character-oriented or fixed-length interfaces that support protocol multiplexing, the number of transmission units received via the interface that were discarded because of an unknown or unsupported protocol. For any interface that does not support protocol multiplexing, this counter is not present. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 inUnknownProtos, or null if not present
      • getOutOctets

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutOctets()
        [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64. The total number of octets transmitted out of the interface, including framing characters. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 outOctets, or null if not present
      • getOutUnicastPkts

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutUnicastPkts()
        [adapted from IETF interfaces model (RFC 7223)] The total number of packets that higher-level protocols requested be transmitted, and that were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 outUnicastPkts, or null if not present
      • getOutBroadcastPkts

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutBroadcastPkts()
        [adapted from IETF interfaces model (RFC 7223)] The total number of packets that higher-level protocols requested be transmitted, and that were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 outBroadcastPkts, or null if not present
      • getOutMulticastPkts

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutMulticastPkts()
        [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64. The total number of packets that higher-level protocols requested be transmitted, and that were addressed to a multicast address at this sub-layer, including those that were discarded or not sent. For a MAC-layer protocol, this includes both Group and Functional addresses. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 outMulticastPkts, or null if not present
      • getOutDiscards

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutDiscards()
        [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64. The number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 outDiscards, or null if not present
      • getOutErrors

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getOutErrors()
        [adapted from IETF interfaces model (RFC 7223)] Changed the counter type to counter64. For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. 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'.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 outErrors, or null if not present
      • getLastClear

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getLastClear()
        Indicates the last time the interface counters were cleared.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime lastClear, or null if not present