org.onosproject.vtnrsc

Interface Subnet

All Known Implementing Classes:

DefaultSubnet

public interface Subnet

Representation of a subnet.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Subnet.Mode Coarse classification of the type of the ipV6Mode.

Method Summary

Modifier and Type	Method and Description
Iterable<AllocationPool>	allocationPools() Returns a collection of allocation_pools.
org.onlab.packet.IpPrefix	cidr() Returns the cidr.
boolean	dhcpEnabled() Returns true if DHCP is enabled and return false if DHCP is disabled.
org.onlab.packet.IpAddress	gatewayIp() Returns the gateway IP address.
Iterable<HostRoute>	hostRoutes() Returns a collection of hostRoutes.
SubnetId	id() Returns the subnet identifier.
Subnet.Mode	ipV6AddressMode() Returns the ipV6AddressMode.
Subnet.Mode	ipV6RaMode() Returns the ipV6RaMode.A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac.
org.onlab.packet.IpAddress.Version	ipVersion() Returns the IP version, which is 4 or 6.
TenantNetworkId	networkId() Returns the network identifier.
boolean	shared() Indicates whether this tenantNetwork is shared across all tenants.
String	subnetName() Returns the name of the subnet.
TenantId	tenantId() Returns tenant identifier.

Method Detail

id

SubnetId id()

Returns the subnet identifier.

Returns:

identifier

subnetName

String subnetName()

Returns the name of the subnet.

Returns:

subnetName

networkId

TenantNetworkId networkId()

Returns the network identifier.

Returns:

the network identifier

tenantId

TenantId tenantId()

Returns tenant identifier.

Returns:

the tenant identifier

ipVersion

org.onlab.packet.IpAddress.Version ipVersion()

Returns the IP version, which is 4 or 6.

Returns:

ipVersion

cidr

org.onlab.packet.IpPrefix cidr()

Returns the cidr.

Returns:

cidr

gatewayIp

org.onlab.packet.IpAddress gatewayIp()

Returns the gateway IP address.

Returns:

gatewayIp

dhcpEnabled

boolean dhcpEnabled()

Returns true if DHCP is enabled and return false if DHCP is disabled.

Returns:

true or false

shared

boolean shared()

Indicates whether this tenantNetwork is shared across all tenants. By default, only administrative user can change this value.

Returns:

true or false

hostRoutes

Iterable<HostRoute> hostRoutes()

Returns a collection of hostRoutes.

Returns:

a collection of hostRoutes

ipV6AddressMode

Subnet.Mode ipV6AddressMode()

Returns the ipV6AddressMode. A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac.

Returns:

ipV6AddressMode whose value is dhcpv6-stateful, dhcpv6-stateless or slaac

ipV6RaMode

Subnet.Mode ipV6RaMode()

Returns the ipV6RaMode.A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac.

Returns:

ipV6RaMode whose value is dhcpv6-stateful, dhcpv6-stateless or slaac

allocationPools

Iterable<AllocationPool> allocationPools()

Returns a collection of allocation_pools.

Returns:

a collection of allocationPools