Interface AllocationPool

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<AllocationPool>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Network>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<AllocationPoolKey>

    public interface AllocationPool
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Network>, org.opendaylight.yangtools.yang.binding.Augmentable<AllocationPool>, org.opendaylight.yangtools.yang.binding.Identifiable<AllocationPoolKey>

    This class represents the following YANG schema fragment defined in module dhcp_allocation_pool

     list allocation-pool {
       key subnet;
       leaf subnet {
         type inet:ip-prefix;
       }
       leaf allocate-from {
         type inet:ip-address;
       }
       leaf allocate-to {
         type inet:ip-address;
       }
       leaf gateway {
         type inet:ip-address;
       }
       leaf-list dns-servers {
         type inet:ip-address;
       }
     }
     
    The schema path to identify an instance is dhcp_allocation_pool/dhcp_allocation_pool/network/allocation-pool

    To create instances of this class use AllocationPoolBuilder.

    See Also:
    AllocationPoolBuilder, AllocationPoolKey
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateFrom()
      low allocation limit
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateTo()
      high allocation limit
      @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsServers()
      dns server list
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getGateway()
      default gateway for dhcp allocation
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSubnet()
      subnet for the dhcp to allocate ip addresses
      default java.lang.Class<AllocationPool> implementedInterface()  
      AllocationPoolKey key()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<AllocationPool> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getSubnet

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSubnet()
        subnet for the dhcp to allocate ip addresses
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix subnet, or null if not present
      • getAllocateFrom

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateFrom()
        low allocation limit
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress allocateFrom, or null if not present
      • getAllocateTo

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAllocateTo()
        high allocation limit
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress allocateTo, or null if not present
      • getGateway

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getGateway()
        default gateway for dhcp allocation
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress gateway, or null if not present
      • getDnsServers

        @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsServers()
        dns server list
        Returns:
        java.util.List dnsServers, or null if not present