Package org.onosproject.net.device

Interface DeviceAdminService

All Superinterfaces:

DeviceService, ListenerService<DeviceEvent,DeviceListener>

public interface DeviceAdminService
extends DeviceService

Service for administering the inventory of infrastructure devices.

Method Summary

Modifier and Type	Method	Description
void	changePortState(DeviceId deviceId, PortNumber portNumber, boolean enable)	Administratively enables or disables a port on a device.
void	removeDevice(DeviceId deviceId)	Removes the device with the specified identifier.
default void	removeDevicePorts(DeviceId deviceId)	Removes the ports of a device with the specified identifier.

Methods inherited from interface org.onosproject.net.device.DeviceService

getAvailableDeviceCount, getAvailableDevices, getAvailableDevices, getDeltaStatisticsForPort, getDevice, getDeviceCount, getDevices, getDevices, getLastUpdatedInstant, getPort, getPort, getPortDeltaStatistics, getPorts, getPortStatistics, getRole, getStatisticsForPort, isAvailable, localStatus

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

removeDevice

void removeDevice(DeviceId deviceId)

Removes the device with the specified identifier.

Parameters:

deviceId - device identifier

changePortState

void changePortState(DeviceId deviceId,
                     PortNumber portNumber,
                     boolean enable)

Administratively enables or disables a port on a device.

Parameters:

deviceId - device identifier

portNumber - port identifier

enable - true if port is to be enabled, false to disable

removeDevicePorts

default void removeDevicePorts(DeviceId deviceId)

Removes the ports of a device with the specified identifier. The device must be presently unavailable, i.e. offline.

Parameters:

deviceId - device identifier