Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev210406

Interface InterfaceCommonState

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
State, State, SubinterfacesState
@Generated("mdsal-binding-generator") public interface InterfaceCommonState extends org.opendaylight.yangtools.yang.binding.DataObject
Operational state data (in addition to intended configuration) at the global level for this interface

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

 grouping interface-common-state {
   oc-ext:operational;
   leaf ifindex {
     type uint32;
     oc-ext:telemetry-on-change;
   }
   leaf admin-status {
     type enumeration {
       enum UP {
       }
       enum DOWN {
       }
       enum TESTING {
       }
     }
     oc-ext:telemetry-on-change;
   }
   leaf oper-status {
     type enumeration {
       enum UP {
         value 1;
       }
       enum DOWN {
         value 2;
       }
       enum TESTING {
         value 3;
       }
       enum UNKNOWN {
         value 4;
       }
       enum DORMANT {
         value 5;
       }
       enum NOT_PRESENT {
         value 6;
       }
       enum LOWER_LAYER_DOWN {
         value 7;
       }
     }
     oc-ext:telemetry-on-change;
   }
   leaf last-change {
     type oc-types:timeticks64;
     oc-ext:telemetry-on-change;
   }
   leaf logical {
     type boolean;
     oc-ext:telemetry-on-change;
   }
   leaf management {
     type boolean;
     oc-ext:telemetry-on-change;
   }
   leaf cpu {
     type boolean;
     oc-ext:telemetry-on-change;
   }
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends InterfaceCommonState> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getIfindex

      org.opendaylight.yangtools.yang.common.Uint32 getIfindex()
      Return ifindex, or null if it is not present. 
           
         System assigned number for each interface. Corresponds to ifIndex object in SNMP
         Interface MIB
      Returns:
      Uint32 ifindex, or null if it is not present.

    • requireIfindex

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireIfindex()
      Return ifindex, guaranteed to be non-null. 
           
         System assigned number for each interface. Corresponds to ifIndex object in SNMP
         Interface MIB
      Returns:
      Uint32 ifindex, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ifindex is not present

    • getAdminStatus

      InterfaceCommonState.AdminStatus getAdminStatus()
      Return adminStatus, or null if it is not present. 
           
         The desired state of the interface. In RFC 7223 this leaf has the same read
         semantics as ifAdminStatus. Here, it reflects the administrative state as set by
         enabling or disabling the interface.
      Returns:
      AdminStatus adminStatus, or null if it is not present.

    • requireAdminStatus

      default @NonNull InterfaceCommonState.AdminStatus requireAdminStatus()
      Return adminStatus, guaranteed to be non-null. 
           
         The desired state of the interface. In RFC 7223 this leaf has the same read
         semantics as ifAdminStatus. Here, it reflects the administrative state as set by
         enabling or disabling the interface.
      Returns:
      AdminStatus adminStatus, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if adminStatus is not present

    • getOperStatus

      InterfaceCommonState.OperStatus getOperStatus()
      Return operStatus, or null if it is not present. 
           
         The current operational state of the interface. This leaf has the same semantics
         as ifOperStatus.
      Returns:
      OperStatus operStatus, or null if it is not present.

    • requireOperStatus

      default @NonNull InterfaceCommonState.OperStatus requireOperStatus()
      Return operStatus, guaranteed to be non-null. 
           
         The current operational state of the interface. This leaf has the same semantics
         as ifOperStatus.
      Returns:
      OperStatus operStatus, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if operStatus is not present

    • getLastChange

      Timeticks64 getLastChange()
      Return lastChange, or null if it is not present. 
           
         This timestamp indicates the absolute time of the last state change of the
         interface (e.g., up-to-down transition). This is different than the SNMP
         ifLastChange object in the standard interface MIB in that it is not relative to
         the system boot time (i.e,. sysUpTime). The value is the timestamp in
         nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
      Returns:
      Timeticks64 lastChange, or null if it is not present.

    • requireLastChange

      default @NonNull Timeticks64 requireLastChange()
      Return lastChange, guaranteed to be non-null. 
           
         This timestamp indicates the absolute time of the last state change of the
         interface (e.g., up-to-down transition). This is different than the SNMP
         ifLastChange object in the standard interface MIB in that it is not relative to
         the system boot time (i.e,. sysUpTime). The value is the timestamp in
         nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
      Returns:
      Timeticks64 lastChange, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if lastChange is not present

    • getLogical

      Boolean getLogical()
      Return logical, or null if it is not present. 
           
         When set to true, the interface is a logical interface which does not have an
         associated physical port or channel on the system.
      Returns:
      Boolean logical, or null if it is not present.

    • requireLogical

      default @NonNull Boolean requireLogical()
      Return logical, guaranteed to be non-null. 
           
         When set to true, the interface is a logical interface which does not have an
         associated physical port or channel on the system.
      Returns:
      Boolean logical, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if logical is not present

    • getManagement

      Boolean getManagement()
      Return management, or null if it is not present. 
           
         When set to true, the interface is a dedicated management interface that is not
         connected to dataplane interfaces. It may be used to connect the system to an
         out-of-band management network, for example.
      Returns:
      Boolean management, or null if it is not present.

    • requireManagement

      default @NonNull Boolean requireManagement()
      Return management, guaranteed to be non-null. 
           
         When set to true, the interface is a dedicated management interface that is not
         connected to dataplane interfaces. It may be used to connect the system to an
         out-of-band management network, for example.
      Returns:
      Boolean management, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if management is not present

    • getCpu

      Boolean getCpu()
      Return cpu, or null if it is not present. 
           
         When set to true, the interface is for traffic that is handled by the system
         CPU, sometimes also called the control plane interface. On systems that
         represent the CPU interface as an Ethernet interface, for example, this leaf
         should be used to distinguish the CPU interface from dataplane interfaces.
      Returns:
      Boolean cpu, or null if it is not present.

    • requireCpu

      default @NonNull Boolean requireCpu()
      Return cpu, guaranteed to be non-null. 
           
         When set to true, the interface is for traffic that is handled by the system
         CPU, sometimes also called the control plane interface. On systems that
         represent the CPU interface as an Ethernet interface, for example, this leaf
         should be used to distinguish the CPU interface from dataplane interfaces.
      Returns:
      Boolean cpu, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if cpu is not present