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

Interface InterfacePhysConfig

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, InterfaceCommonConfig
All Known Subinterfaces:
Config, State
@Generated("mdsal-binding-generator") public interface InterfacePhysConfig extends org.opendaylight.yangtools.yang.binding.DataObject, InterfaceCommonConfig
Configuration data for physical interfaces

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

 grouping interface-phys-config {
   leaf name {
     type string;
   }
   leaf type {
     type identityref {
       base interface-type;
     }
   }
   leaf mtu {
     type uint16;
   }
   leaf loopback-mode {
     type boolean;
     default false;
   }
   uses interface-common-config;
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getLoopbackMode()
    Return loopbackMode, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getMtu()
    Return mtu, or null if it is not present.
    String
    getName()
    Return name, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.InterfaceType
    getType()
    Return type, or null if it is not present.
    Class<? extends InterfacePhysConfig>
    implementedInterface()
     
    default @NonNull Boolean
    requireLoopbackMode()
    Return loopbackMode, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireMtu()
    Return mtu, guaranteed to be non-null.
    default @NonNull String
    requireName()
    Return name, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.InterfaceType
    requireType()
    Return type, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev210406.InterfaceCommonConfig

    getDescription, getEnabled, requireDescription, requireEnabled

  • 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 InterfacePhysConfig> 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
      Specified by:
      implementedInterface in interface InterfaceCommonConfig

    • getName

      String getName()
      Return name, or null if it is not present. 
           
         The name of the interface. A device MAY restrict the allowed values for this
         leaf, possibly depending on the type of the interface. For system-controlled
         interfaces, this leaf is the device-specific name of the interface. The 'config
         false' list interfaces/interface[name]/state contains the currently existing
         interfaces on the device. If a client tries to create configuration for a
         system-controlled interface that is not present in the corresponding state list,
         the server MAY reject the request if the implementation does not support
         pre-provisioning of interfaces or if the name refers to an interface that can
         never exist in the system. A NETCONF server MUST reply with an rpc-error with
         the error-tag 'invalid-value' in this case. The IETF model in RFC 7223 provides
         YANG features for the following (i.e., pre-provisioning and arbitrary-names),
         however they are omitted here: If the device supports pre-provisioning of
         interface configuration, the 'pre-provisioning' feature is advertised. If the
         device allows arbitrarily named user-controlled interfaces, the
         'arbitrary-names' feature is advertised. When a configured user-controlled
         interface is created by the system, it is instantiated with the same name in the
         /interfaces/interface[name]/state list.
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null. 
           
         The name of the interface. A device MAY restrict the allowed values for this
         leaf, possibly depending on the type of the interface. For system-controlled
         interfaces, this leaf is the device-specific name of the interface. The 'config
         false' list interfaces/interface[name]/state contains the currently existing
         interfaces on the device. If a client tries to create configuration for a
         system-controlled interface that is not present in the corresponding state list,
         the server MAY reject the request if the implementation does not support
         pre-provisioning of interfaces or if the name refers to an interface that can
         never exist in the system. A NETCONF server MUST reply with an rpc-error with
         the error-tag 'invalid-value' in this case. The IETF model in RFC 7223 provides
         YANG features for the following (i.e., pre-provisioning and arbitrary-names),
         however they are omitted here: If the device supports pre-provisioning of
         interface configuration, the 'pre-provisioning' feature is advertised. If the
         device allows arbitrarily named user-controlled interfaces, the
         'arbitrary-names' feature is advertised. When a configured user-controlled
         interface is created by the system, it is instantiated with the same name in the
         /interfaces/interface[name]/state list.
      Returns:
      String name, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if name is not present

    • getType

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.InterfaceType getType()
      Return type, or null if it is not present. 
           
         The type of the interface. When an interface entry is created, a server MAY
         initialize the type leaf with a valid value, e.g., if it is possible to derive
         the type from the name of the interface. If a client tries to set the type of an
         interface to a value that can never be used by the system, e.g., if the type is
         not supported or if the type does not match the name of the interface, the
         server MUST reject the request. A NETCONF server MUST reply with an rpc-error
         with the error-tag 'invalid-value' in this case.
      Returns:
      InterfaceType type, or null if it is not present.

    • requireType

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.InterfaceType requireType()
      Return type, guaranteed to be non-null. 
           
         The type of the interface. When an interface entry is created, a server MAY
         initialize the type leaf with a valid value, e.g., if it is possible to derive
         the type from the name of the interface. If a client tries to set the type of an
         interface to a value that can never be used by the system, e.g., if the type is
         not supported or if the type does not match the name of the interface, the
         server MUST reject the request. A NETCONF server MUST reply with an rpc-error
         with the error-tag 'invalid-value' in this case.
      Returns:
      InterfaceType type, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if type is not present

    • getMtu

      org.opendaylight.yangtools.yang.common.Uint16 getMtu()
      Return mtu, or null if it is not present. 
           
         Set the max transmission unit size in octets for the physical interface. If this
         is not set, the mtu is set to the operational default -- e.g., 1514 bytes on an
         Ethernet interface.
      Returns:
      Uint16 mtu, or null if it is not present.

    • requireMtu

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireMtu()
      Return mtu, guaranteed to be non-null. 
           
         Set the max transmission unit size in octets for the physical interface. If this
         is not set, the mtu is set to the operational default -- e.g., 1514 bytes on an
         Ethernet interface.
      Returns:
      Uint16 mtu, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if mtu is not present

    • getLoopbackMode

      Boolean getLoopbackMode()
      Return loopbackMode, or null if it is not present. 
           
         When set to true, the interface is logically looped back, such that packets that
         are forwarded via the interface are received on the same interface.
      Returns:
      Boolean loopbackMode, or null if it is not present.

    • requireLoopbackMode

      default @NonNull Boolean requireLoopbackMode()
      Return loopbackMode, guaranteed to be non-null. 
           
         When set to true, the interface is logically looped back, such that packets that
         are forwarded via the interface are received on the same interface.
      Returns:
      Boolean loopbackMode, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if loopbackMode is not present