Interface InterfaceCommonState

  • All Superinterfaces:
    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 {
       leaf ifindex {
         type uint32;
       }
       leaf admin-status {
         type enumeration {
           enum UP {
           }
           enum DOWN {
           }
           enum TESTING {
           }
         }
       }
       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;
           }
         }
       }
       leaf last-change {
         type yang:timeticks;
       }
     }
     
    The schema path to identify an instance is openconfig-interfaces/interface-common-state
    • Field Detail

      • QNAME

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

      • implementedInterface

        Class<? extends InterfaceCommonState> implementedInterface()
        Specified by:
        implementedInterface in interface 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:
        org.opendaylight.yangtools.yang.common.Uint32 ifindex, or null if it is not present.
      • getAdminStatus

        InterfaceCommonState.AdminStatus getAdminStatus()
        Return adminStatus, or null if it is not present.
             
                 [adapted from IETF interfaces model (RFC 7223)] 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:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfaceCommonState.AdminStatus adminStatus, or null if it is not present.
      • getOperStatus

        InterfaceCommonState.OperStatus getOperStatus()
        Return operStatus, or null if it is not present.
             
                 [adapted from IETF interfaces model (RFC 7223)] The current operational state of
                 the interface. This leaf has the same semantics as ifOperStatus.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfaceCommonState.OperStatus operStatus, or null if it is not present.
      • getLastChange

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks getLastChange()
        Return lastChange, or null if it is not present.
             
                 Date and time of the last state change of the interface (e.g., up-to-down
                 transition). This corresponds to the ifLastChange object in the standard
                 interface MIB.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks lastChange, or null if it is not present.