Package org.onosproject.net.behaviour.inbandtelemetry

Class IntDeviceConfig

java.lang.Object

org.onosproject.net.behaviour.inbandtelemetry.IntDeviceConfig

@Beta
public final class IntDeviceConfig
extends java.lang.Object

Device-level configuration of the INT process.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IntDeviceConfig.Builder	An IntConfig object builder.
static class	IntDeviceConfig.TelemetrySpec	Represents a type of telemetry spec to collect in the dataplane.

Method Summary

Modifier and Type	Method	Description
static IntDeviceConfig.Builder	builder()	Returns a new builder.
IpAddress	collectorIp()	Returns IP address of the collector.
MacAddress	collectorNextHopMac()	Returns MAC address of next hop of INT report packets.
TpPort	collectorPort()	Returns UDP port number of the collector.
boolean	enabled()	Returns the status of INT functionality.
IpAddress	sinkIp()	Returns IP address of the sink device.
MacAddress	sinkMac()	Returns MAC address of the sink device.
IntDeviceConfig.TelemetrySpec	spec()	Returns the type of telemetry spec as per IntDeviceConfig.TelemetrySpec.

Methods inherited from class java.lang.Object

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

Method Detail

collectorIp

public IpAddress collectorIp()

Returns IP address of the collector. This is the destination IP address that will be used for all INT reports generated by all sink devices.

Returns:

collector IP address

collectorPort

public TpPort collectorPort()

Returns UDP port number of the collector. This is the destination UDP port number that will be used for all INT reports generated by all sink devices.

Returns:

collector UDP port number

collectorNextHopMac

public MacAddress collectorNextHopMac()

Returns MAC address of next hop of INT report packets. This can be either MAC address of the collector or a router. This is an optional parameter, which means that the usage of this parameter depends on IntProgrammable implementation. (e.g., If a report packet needs to be routed to reach the collector, IntProgrammable will ignore this value and choose next hop router's MAC address. If a collector itself is the next hop of INT report packets, then this value will be used as a destination MAC address for all INT report packets.)

Returns:

MAC address of next hop of INT report packets

sinkIp

public IpAddress sinkIp()

Returns IP address of the sink device. All sink devices share this address as the source IP address for all INT reports.

Returns:

sink device's IP address

sinkMac

public MacAddress sinkMac()

Returns MAC address of the sink device. All sink devices share this address as the source MAC address for all INT reports.

Returns:

sink device's MAC address

spec

public IntDeviceConfig.TelemetrySpec spec()

Returns the type of telemetry spec as per IntDeviceConfig.TelemetrySpec.

Returns:

telemetry spec

enabled

public boolean enabled()

Returns the status of INT functionality.

Returns:

true if INT is enabled; false otherwise.

builder

public static IntDeviceConfig.Builder builder()

Returns a new builder.

Returns:

new builder