All Superinterfaces:: org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:: Subnet

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 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 List<AllocationPools>`	`getAllocationPools()`	Sub-ranges of cidr available for dynamic allocation to ports
`@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix`	`getCidr()`	cidr representing IP range for this subnet, based on IP version
`@Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress>`	`getDnsNameservers()`	DNS name servers used by hosts in this subnet.
`@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress`	`getGatewayIp()`	default gateway used by devices in this subnet
`@Nullable List<HostRoutes>`	`getHostRoutes()`	Routes that should be used by devices with IPs from this subnet (not including local subnet route).
`@Nullable Class<? extends Dhcpv6Base>`	`getIpv6AddressMode()`	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.
`@Nullable Class<? extends Dhcpv6Base>`	`getIpv6RaMode()`	TODO can't find this in the spec but OS sends it with a null value.
`@Nullable Class<? extends IpVersionBase>`	`getIpVersion()`	IP version
`@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid`	`getNetworkId()`	network this subnet is associated with.
`Class<? extends SubnetAttributes>`	`implementedInterface()`
`@Nullable Boolean`	`isEnableDhcp()`	Specifies whether DHCP is enabled for this subnet or not.
`default @NonNull List<AllocationPools>`	`nonnullAllocationPools()`
`default @NonNull List<HostRoutes>`	`nonnullHostRoutes()`

- 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
```
@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()
```
    network this subnet is associated with.
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid networkId, or null if not present
  - getIpVersion
```
@Nullable Class<? extends IpVersionBase> getIpVersion()
```
    IP version
    
    Returns:
    
    java.lang.Class ipVersion, or null if not present
  - getCidr
```
@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getCidr()
```
    cidr representing IP range for this subnet, based on IP version
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix cidr, or null if not present
  - getGatewayIp
```
@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getGatewayIp()
```
    default gateway used by devices in this subnet
    
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress gatewayIp, or null if not present
  - getDnsNameservers
```
@Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsNameservers()
```
    DNS name servers used by hosts in this subnet.
    
    Returns:
    
    java.util.List dnsNameservers, or null if not present
  - getIpv6AddressMode
```
@Nullable Class<? extends Dhcpv6Base> getIpv6AddressMode()
```
    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:
    
    java.lang.Class ipv6AddressMode, or null if not present
  - getIpv6RaMode
```
@Nullable Class<? extends Dhcpv6Base> getIpv6RaMode()
```
    TODO can't find this in the spec but OS sends it with a null value.
    
    Returns:
    
    java.lang.Class ipv6RaMode, or null if not present
  - getAllocationPools
```
@Nullable List<AllocationPools> getAllocationPools()
```
    Sub-ranges of cidr available for dynamic allocation to ports
    
    Returns:
    
    java.util.List allocationPools, or null if not present
  - nonnullAllocationPools
```
default @NonNull List<AllocationPools> nonnullAllocationPools()
```
    Returns:
    
    java.util.List allocationPools, or an empty list if it is not present
  - getHostRoutes
```
@Nullable List<HostRoutes> getHostRoutes()
```
    Routes that should be used by devices with IPs from this subnet (not including local subnet route).
    
    Returns:
    
    java.util.List hostRoutes, or null if not present
  - nonnullHostRoutes
```
default @NonNull List<HostRoutes> nonnullHostRoutes()
```
    Returns:
    
    java.util.List hostRoutes, or an empty list if it is not present
  - isEnableDhcp
```
@Nullable Boolean isEnableDhcp()
```
    Specifies whether DHCP is enabled for this subnet or not.
    
    Returns:
    
    java.lang.Boolean enableDhcp, or null if not present

Interface SubnetAttributes

Field Summary

Method Summary

Field Detail

QNAME

Method Detail

implementedInterface

getNetworkId

getIpVersion

getCidr

getGatewayIp

getDnsNameservers

getIpv6AddressMode

getIpv6RaMode

getAllocationPools

nonnullAllocationPools

getHostRoutes

nonnullHostRoutes

isEnableDhcp