Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712

Interface SubnetAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Subnet
    @Generated("mdsal-binding-generator")
public interface SubnetAttributes
extends org.opendaylight.yangtools.yang.binding.DataObject

    This class represents the following YANG schema fragment defined in module neutron-subnets 

     grouping subnet-attributes {
   leaf network-id {
     type yang:uuid;
   }
   leaf ip-version {
     type identityref {
       base ip-version-base;
     }
   }
   leaf cidr {
     type inet:ip-prefix;
   }
   leaf gateway-ip {
     type inet:ip-address;
   }
   leaf-list dns-nameservers {
     type inet:ip-address;
   }
   leaf ipv6-address-mode {
     type identityref {
       base dhcpv6-base;
     }
   }
   leaf ipv6-ra-mode {
     type identityref {
       base dhcpv6-base;
     }
   }
   list allocation-pools {
     key start;
     leaf start {
       type inet:ip-address;
     }
     leaf end {
       type inet:ip-address;
     }
   }
   list host-routes {
     key destination;
     leaf destination {
       type inet:ip-prefix;
     }
     leaf nexthop {
       type inet:ip-address;
     }
   }
   leaf enable-dhcp {
     type boolean;
     default true;
   }
 }
    The schema path to identify an instance is neutron-subnets/subnet-attributes

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        Class<? extends SubnetAttributes> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getNetworkId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()
        Return networkId, or null if it is not present. 
             
         network this subnet is associated with.
        Returns:
        Uuid networkId, or null if it is not present.

      • requireNetworkId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireNetworkId()
        Return networkId, guaranteed to be non-null. 
             
         network this subnet is associated with.
        Returns:
        Uuid networkId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if networkId is not present

      • getIpVersion

        Class<? extends IpVersionBase> getIpVersion()
        Return ipVersion, or null if it is not present. 
             
         IP version
        Returns:
        Class<? extends IpVersionBase> ipVersion, or null if it is not present.

      • requireIpVersion

        default @NonNull Class<? extends IpVersionBase> requireIpVersion()
        Return ipVersion, guaranteed to be non-null. 
             
         IP version
        Returns:
        Class<? extends IpVersionBase> ipVersion, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ipVersion is not present

      • getCidr

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getCidr()
        Return cidr, or null if it is not present. 
             
         cidr representing IP range for this subnet, based on IP version
        Returns:
        IpPrefix cidr, or null if it is not present.

      • requireCidr

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix requireCidr()
        Return cidr, guaranteed to be non-null. 
             
         cidr representing IP range for this subnet, based on IP version
        Returns:
        IpPrefix cidr, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if cidr is not present

      • getGatewayIp

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getGatewayIp()
        Return gatewayIp, or null if it is not present. 
             
         default gateway used by devices in this subnet
        Returns:
        IpAddress gatewayIp, or null if it is not present.

      • requireGatewayIp

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireGatewayIp()
        Return gatewayIp, guaranteed to be non-null. 
             
         default gateway used by devices in this subnet
        Returns:
        IpAddress gatewayIp, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if gatewayIp is not present

      • getDnsNameservers

        @Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsNameservers()
        Return dnsNameservers, or null if it is not present. 
             
         DNS name servers used by hosts in this subnet.
        Returns:
        List<IpAddress> dnsNameservers, or null if it is not present.

      • requireDnsNameservers

        default @NonNull List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> requireDnsNameservers()
        Return dnsNameservers, guaranteed to be non-null. 
             
         DNS name servers used by hosts in this subnet.
        Returns:
        List<IpAddress> dnsNameservers, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if dnsNameservers is not present

      • getIpv6AddressMode

        Class<? extends Dhcpv6Base> getIpv6AddressMode()
        Return ipv6AddressMode, or null if it is not present. 
             
         neutron subnet-create --ip-version 6 --ipv6_ra_mode off --ipv6_address_mode off
         NETWORK CIDR neutron subnet-create --ip-version 6 --ipv6_ra_mode off
         --ipv6_address_mode dhcpv6-stateful NETWORK CIDR neutron subnet-create
         --ip-version 6 --ipv6_ra_mode slaac --ipv6_address_mode slaac NETWORK CIDR
         neutron subnet-create --ip-version 6 --ipv6_ra_mode dhcpv6-stateful
         --ipv6_address_mode off NETWORK CIDR neutron subnet-create --ip-version 6
         --ipv6_ra_mode dhcpv6-stateless --ipv6_address_mode dhcpv6-stateless NETWORK
         CIDR Note: can't find this in the spec but OS is sending it with a null value.
        Returns:
        Class<? extends Dhcpv6Base> ipv6AddressMode, or null if it is not present.

      • requireIpv6AddressMode

        default @NonNull Class<? extends Dhcpv6Base> requireIpv6AddressMode()
        Return ipv6AddressMode, guaranteed to be non-null. 
             
         neutron subnet-create --ip-version 6 --ipv6_ra_mode off --ipv6_address_mode off
         NETWORK CIDR neutron subnet-create --ip-version 6 --ipv6_ra_mode off
         --ipv6_address_mode dhcpv6-stateful NETWORK CIDR neutron subnet-create
         --ip-version 6 --ipv6_ra_mode slaac --ipv6_address_mode slaac NETWORK CIDR
         neutron subnet-create --ip-version 6 --ipv6_ra_mode dhcpv6-stateful
         --ipv6_address_mode off NETWORK CIDR neutron subnet-create --ip-version 6
         --ipv6_ra_mode dhcpv6-stateless --ipv6_address_mode dhcpv6-stateless NETWORK
         CIDR Note: can't find this in the spec but OS is sending it with a null value.
        Returns:
        Class<? extends Dhcpv6Base> ipv6AddressMode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ipv6AddressMode is not present

      • getIpv6RaMode

        Class<? extends Dhcpv6Base> getIpv6RaMode()
        Return ipv6RaMode, or null if it is not present. 
             
         TODO can't find this in the spec but OS sends it with a null value.
        Returns:
        Class<? extends Dhcpv6Base> ipv6RaMode, or null if it is not present.

      • requireIpv6RaMode

        default @NonNull Class<? extends Dhcpv6Base> requireIpv6RaMode()
        Return ipv6RaMode, guaranteed to be non-null. 
             
         TODO can't find this in the spec but OS sends it with a null value.
        Returns:
        Class<? extends Dhcpv6Base> ipv6RaMode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ipv6RaMode is not present

      • getAllocationPools

        @Nullable Map<AllocationPoolsKey,​AllocationPools> getAllocationPools()
        Return allocationPools, or null if it is not present. 
             
         Sub-ranges of cidr available for dynamic allocation to ports
        Returns:
        Map<AllocationPoolsKey, AllocationPools> allocationPools, or null if it is not present.

      • nonnullAllocationPools

        default @NonNull Map<AllocationPoolsKey,​AllocationPools> nonnullAllocationPools()
        Return allocationPools, or an empty list if it is not present.
        Returns:
        Map<AllocationPoolsKey, AllocationPools> allocationPools, or an empty list if it is not present.

      • getHostRoutes

        @Nullable Map<HostRoutesKey,​HostRoutes> getHostRoutes()
        Return hostRoutes, or null if it is not present. 
             
         Routes that should be used by devices with IPs from this subnet (not including
         local subnet route).
        Returns:
        Map<HostRoutesKey, HostRoutes> hostRoutes, or null if it is not present.

      • nonnullHostRoutes

        default @NonNull Map<HostRoutesKey,​HostRoutes> nonnullHostRoutes()
        Return hostRoutes, or an empty list if it is not present.
        Returns:
        Map<HostRoutesKey, HostRoutes> hostRoutes, or an empty list if it is not present.

      • getEnableDhcp

        Boolean getEnableDhcp()
        Return enableDhcp, or null if it is not present. 
             
         Specifies whether DHCP is enabled for this subnet or not.
        Returns:
        Boolean enableDhcp, or null if it is not present.

      • requireEnableDhcp

        default @NonNull Boolean requireEnableDhcp()
        Return enableDhcp, guaranteed to be non-null. 
             
         Specifies whether DHCP is enabled for this subnet or not.
        Returns:
        Boolean enableDhcp, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if enableDhcp is not present