Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416

Interface VlanSwitchedConfig

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:
Config, State
@Generated("mdsal-binding-generator") public interface VlanSwitchedConfig extends org.opendaylight.yangtools.yang.binding.DataObject
VLAN related configuration that is part of the physical Ethernet interface.

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

 grouping vlan-switched-config {
   leaf interface-mode {
     type oc-vlan-types:vlan-mode-type;
   }
   leaf native-vlan {
     when "../interface-mode = 'TRUNK'" {
     }
     type oc-vlan-types:vlan-id;
   }
   leaf access-vlan {
     when "../interface-mode = 'ACCESS'" {
     }
     type oc-vlan-types:vlan-id;
   }
   leaf-list trunk-vlans {
     when "../interface-mode = 'TRUNK'" {
     }
     type union {
       type oc-vlan-types:vlan-id;
       type oc-vlan-types:vlan-range;
     }
   }
 }

  • 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 VlanSwitchedConfig> 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

    • getInterfaceMode

      VlanModeType getInterfaceMode()
      Return interfaceMode, or null if it is not present. 
           
         Set the interface to access or trunk mode for VLANs
      Returns:
      VlanModeType interfaceMode, or null if it is not present.

    • requireInterfaceMode

      default @NonNull VlanModeType requireInterfaceMode()
      Return interfaceMode, guaranteed to be non-null. 
           
         Set the interface to access or trunk mode for VLANs
      Returns:
      VlanModeType interfaceMode, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if interfaceMode is not present

    • getNativeVlan

      VlanId getNativeVlan()
      Return nativeVlan, or null if it is not present. 
           
         Set the native VLAN id for untagged frames arriving on a trunk interface. Tagged
         frames sent on an interface configured with a native VLAN should have their tags
         stripped prior to transmission. This configuration is only valid on a trunk
         interface.
      Returns:
      VlanId nativeVlan, or null if it is not present.

    • requireNativeVlan

      default @NonNull VlanId requireNativeVlan()
      Return nativeVlan, guaranteed to be non-null. 
           
         Set the native VLAN id for untagged frames arriving on a trunk interface. Tagged
         frames sent on an interface configured with a native VLAN should have their tags
         stripped prior to transmission. This configuration is only valid on a trunk
         interface.
      Returns:
      VlanId nativeVlan, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if nativeVlan is not present

    • getAccessVlan

      VlanId getAccessVlan()
      Return accessVlan, or null if it is not present. 
           
         Assign the access vlan to the access port.
      Returns:
      VlanId accessVlan, or null if it is not present.

    • requireAccessVlan

      default @NonNull VlanId requireAccessVlan()
      Return accessVlan, guaranteed to be non-null. 
           
         Assign the access vlan to the access port.
      Returns:
      VlanId accessVlan, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if accessVlan is not present

    • getTrunkVlans

      @Nullable Set<VlanSwitchedConfig.TrunkVlans> getTrunkVlans()
      Return trunkVlans, or null if it is not present. 
           
         Specify VLANs, or ranges thereof, that the interface may carry when in trunk
         mode. If not specified, all VLANs are allowed on the interface. Ranges are
         specified in the form x..y, where x&lt;y - ranges are assumed to be
         inclusive (such that the VLAN range is x &lt;= range &lt;= y.
      Returns:
      Set<TrunkVlans> trunkVlans, or null if it is not present.

    • requireTrunkVlans

      default @NonNull Set<VlanSwitchedConfig.TrunkVlans> requireTrunkVlans()
      Return trunkVlans, guaranteed to be non-null. 
           
         Specify VLANs, or ranges thereof, that the interface may carry when in trunk
         mode. If not specified, all VLANs are allowed on the interface. Ranges are
         specified in the form x..y, where x&lt;y - ranges are assumed to be
         inclusive (such that the VLAN range is x &lt;= range &lt;= y.
      Returns:
      Set<TrunkVlans> trunkVlans, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if trunkVlans is not present