org.onosproject.dhcp.rest

Class DhcpWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.dhcp.rest.DhcpWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

public class DhcpWebResource
extends org.onosproject.rest.AbstractWebResource

Manage DHCP address assignments.

Constructor Summary

Constructors

Constructor and Description
DhcpWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteMapping(String macID) Delete a static MAC/IP binding.
javax.ws.rs.core.Response	getConfigs() Get DHCP server configuration data.
javax.ws.rs.core.Response	listAvailableIPs() Get all available IPs.
javax.ws.rs.core.Response	listMappings() Get all MAC/IP mappings.
javax.ws.rs.core.Response	setMapping(InputStream stream) Post a new static MAC/IP binding.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok, setServiceDirectory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DhcpWebResource

public DhcpWebResource()

Method Detail

getConfigs

public javax.ws.rs.core.Response getConfigs()

Get DHCP server configuration data. Shows lease, renewal and rebinding times in seconds.

Returns:

200 OK

Json model for REST api:

DhcpConfigGet

listMappings

public javax.ws.rs.core.Response listMappings()

Get all MAC/IP mappings. Shows all MAC/IP mappings held by the DHCP server.

Returns:

200 OK

Json model for REST api:

DhcpConfigGetMappings

listAvailableIPs

public javax.ws.rs.core.Response listAvailableIPs()

Get all available IPs. Shows all the IPs in the free pool of the DHCP Server.

Returns:

200 OK

Json model for REST api:

DhcpConfigGetAvailable

setMapping

public javax.ws.rs.core.Response setMapping(InputStream stream)

Post a new static MAC/IP binding. Registers a static binding to the DHCP server, and displays the current set of bindings.

Parameters:

stream - JSON stream

Returns:

200 OK

Json model for REST api:

DhcpConfigPut

deleteMapping

public javax.ws.rs.core.Response deleteMapping(String macID)

Delete a static MAC/IP binding. Removes a static binding from the DHCP Server, and displays the current set of bindings.

Parameters:

macID - mac address identifier

Returns:

200 OK