org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev180222.interfaces._interface

Interface Ipv4

All Superinterfaces:

Augmentable<Ipv4>, BindingObject, ChildOf<Interface1>, DataContainer, DataObject

public interface Ipv4
extends ChildOf<Interface1>, Augmentable<Ipv4>

Parameters for the IPv4 address family.

This class represents the following YANG schema fragment defined in module ietf-ip

 container ipv4 {
   presence
     "Enables IPv4 unless the 'enabled' leaf
      (which defaults to 'true') is set to 'false'";
   leaf enabled {
     type boolean;
     default true;
   }
   leaf forwarding {
     type boolean;
     default false;
   }
   leaf mtu {
     type uint16 {
       range 68..max;
     }
     units octets;
   }
   list address {
     key ip;
     leaf ip {
       type inet:ipv4-address-no-zone;
     }
     choice subnet {
       case prefix-length {
         leaf prefix-length {
           type uint8 {
             range 0..32;
           }
         }
       }
       case netmask {
         leaf netmask {
           if-feature ipv4-non-contiguous-netmasks;
           type yang:dotted-quad;
         }
       }
     }
     leaf origin {
       type ip-address-origin;
       config false;
     }
   }
   list neighbor {
     key ip;
     leaf ip {
       type inet:ipv4-address-no-zone;
     }
     leaf link-layer-address {
       type yang:phys-address;
     }
     leaf origin {
       type neighbor-origin;
       config false;
     }
   }
 }
 

The schema path to identify an instance is ietf-ip/interfaces/interface/(urn:ietf:params:xml:ns:yang:ietf-ip?revision=2018-02-22)ipv4

To create instances of this class use Ipv4Builder.

See Also:

Ipv4Builder

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
@Nullable List<Address>	getAddress() The list of IPv4 addresses on the interface.
@Nullable Integer	getMtu() The size, in octets, of the largest IPv4 packet that theinterface will send and receive.The server may restrict the allowed values for this leaf,depending on the interface's type.If this leaf is not configured, the operationally used MTUdepends on the interface's type.
@Nullable List<Neighbor>	getNeighbor() A list of mappings from IPv4 addresses tolink-layer addresses.Entries in this list in the intended configuration areused as static entries in the ARP Cache.In the operational state, this list represents the ARPCache.
@Nullable Boolean	isEnabled() Controls whether IPv4 is enabled or disabled on thisinterface.
@Nullable Boolean	isForwarding() Controls IPv4 packet forwarding of datagrams received by,but not addressed to, this interface.
default @NonNull List<Address>	nonnullAddress()
default @NonNull List<Neighbor>	nonnullNeighbor()

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation

Field Detail

QNAME

static final org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

isEnabled

@Nullable Boolean isEnabled()

Controls whether IPv4 is enabled or disabled on thisinterface. When IPv4 is enabled, this interface isconnected to an IPv4 stack, and the interface can sendand receive IPv4 packets.

Returns:

java.lang.Boolean enabled, or null if not present

isForwarding

@Nullable Boolean isForwarding()

Controls IPv4 packet forwarding of datagrams received by,but not addressed to, this interface. IPv4 routersforward datagrams. IPv4 hosts do not (except thosesource-routed via the host).

Returns:

java.lang.Boolean forwarding, or null if not present

getMtu

@Nullable Integer getMtu()

The size, in octets, of the largest IPv4 packet that theinterface will send and receive.The server may restrict the allowed values for this leaf,depending on the interface's type.If this leaf is not configured, the operationally used MTUdepends on the interface's type.

Returns:

java.lang.Integer mtu, or null if not present

getAddress

@Nullable List<Address> getAddress()

The list of IPv4 addresses on the interface.

Returns:

java.util.List address, or null if not present

nonnullAddress

default @NonNull List<Address> nonnullAddress()

Returns:

java.util.List address, or an empty list if it is not present

getNeighbor

@Nullable List<Neighbor> getNeighbor()

A list of mappings from IPv4 addresses tolink-layer addresses.Entries in this list in the intended configuration areused as static entries in the ARP Cache.In the operational state, this list represents the ARPCache.

Returns:

java.util.List neighbor, or null if not present

nonnullNeighbor

default @NonNull List<Neighbor> nonnullNeighbor()

Returns:

java.util.List neighbor, or an empty list if it is not present