Package org.onosproject.net.behaviour.inbandtelemetry

Class IntReportConfig

  • @Beta
public final class IntReportConfig
extends Config<ApplicationId>
    Application level configuration of the INT process. Config example: { "apps": { "org.onosproject.inbandtelemetry": { "report": { "collectorIp": "192.168.0.1", "collectorPort": 5500, "minFlowHopLatencyChangeNs": 300, "watchSubnets": [ "192.168.0.0/24", "10.140.0.0/16" ] } } } }

    • Constructor Detail

      • IntReportConfig

        public IntReportConfig()

    • Method Detail

      • collectorIp

        public IpAddress collectorIp()
        IP address of the collector. This is the destination IP address that will be used for all INT reports generated by all INT devices.
        Returns:
        collector IP address, null if not present

      • collectorPort

        public TpPort collectorPort()
        UDP port number of the collector. This is the destination UDP port number that will be used for all INT reports generated by all INT devices.
        Returns:
        collector UDP port number, null if not present

      • minFlowHopLatencyChangeNs

        public int minFlowHopLatencyChangeNs()
        Gets the minimal interval of hop latency change for a flow. This value is used to instruct an INT-capable device to produce reports only for packets which hop latency changed by at least minFlowHopLatencyChangeNs from the previously reported value for the same flow (5-tuple), i.e., produce a report only if `(currentHopLatency - previousHopLatency) > minFlowHopLatencyChangeNs`. Some device implementations might support only specific intervals, e.g., powers of 2.
        Returns:
        Interval in nanoseconds

      • 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, null if not present

      • 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, null if not present

      • 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, null if not present

      • watchSubnets

        public Set<IpPrefix> watchSubnets()
        Gets subnets to be watched.
        Returns:
        subnets to be watched

      • setCollectorIp

        public IntReportConfig setCollectorIp​(IpAddress collectorIp)
        Sets the collector IP to the config.
        Parameters:
        collectorIp - the collector IP
        Returns:
        the config

      • setCollectorPort

        public IntReportConfig setCollectorPort​(TpPort port)
        Sets the collector port to the config.
        Parameters:
        port - the collector port
        Returns:
        the config

      • setMinFlowHopLatencyChangeNs

        public IntReportConfig setMinFlowHopLatencyChangeNs​(int ns)
        Sets the minimal interval of hop latency change for a flow to the config.
        Parameters:
        ns - the value of hop latency change
        Returns:
        the config

      • setCollectorNextHopMac

        public IntReportConfig setCollectorNextHopMac​(MacAddress collectorNextHopMac)
        Sets collector next hop mac address to the config.
        Parameters:
        collectorNextHopMac - the collector next hop mac address
        Returns:
        the config

      • setSinkIp

        public IntReportConfig setSinkIp​(IpAddress sinkIp)
        Sets the sink IP address to the config.
        Parameters:
        sinkIp - the sink IP address
        Returns:
        the config

      • setSinkMac

        public IntReportConfig setSinkMac​(MacAddress sinkMac)
        Sets the sink mac address to the config.
        Parameters:
        sinkMac - the sink mac address
        Returns:
        the config

      • setWatchSubnets

        public IntReportConfig setWatchSubnets​(Set<IpPrefix> subnets)
        Sets subnets to be watched.
        Parameters:
        subnets - subnets to be watched.
        Returns:
        the config