aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python
diff options
context:
space:
mode:
Diffstat (limited to 'resources/libraries/python')
-rw-r--r--resources/libraries/python/telemetry/IPFIXSetup.py129
-rw-r--r--resources/libraries/python/telemetry/IPFIXUtil.py105
-rw-r--r--resources/libraries/python/telemetry/SPAN.py48
3 files changed, 19 insertions, 263 deletions
diff --git a/resources/libraries/python/telemetry/IPFIXSetup.py b/resources/libraries/python/telemetry/IPFIXSetup.py
deleted file mode 100644
index db703c8a7e..0000000000
--- a/resources/libraries/python/telemetry/IPFIXSetup.py
+++ /dev/null
@@ -1,129 +0,0 @@
-# Copyright (c) 2018 Cisco and/or its affiliates.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at:
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""IPFIX setup library"""
-
-from resources.libraries.python.topology import Topology
-from resources.libraries.python.VatExecutor import VatTerminal
-
-
-class IPFIXSetup(object):
- """Class contains methods for seting up IPFIX reporting on DUTs."""
-
- def __init__(self):
- """Initializer."""
- pass
-
- @staticmethod
- def setup_ipfix_exporter(node, collector, source, fib=None, mtu=None,
- interval=None):
- """Setup an IPFIX exporter on node to export collected flow data.
-
- :param node: DUT node.
- :param collector: IP address of flow data collector.
- :param source: IP address of local interface to send flow data from.
- :param fib: fib table ID.
- :param mtu: Maximum transfer unit of path to collector.
- :param interval: Frequency of sending template packets, in seconds.
- :type node: dict
- :type collector: str
- :type source: str
- :type fib: int
- :type mtu: int
- :type interval: int
- """
-
- fib = "vrf_id {0}".format(fib) if fib else ''
- mtu = "path_mtu {0}".format(mtu) if mtu else ''
- interval = "template_interval {0}".format(interval) if interval else ''
-
- with VatTerminal(node, json_param=False) as vat:
- vat.vat_terminal_exec_cmd_from_template('ipfix_exporter_set.vat',
- collector=collector,
- source=source,
- fib=fib,
- mtu=mtu,
- interval=interval)
-
- @staticmethod
- def assign_interface_to_flow_table(node, interface, table_id,
- ip_version='ip4'):
- """Assigns a VPP interface to the specified classify table for IPFIX
- flow data collection.
-
- :param node: DUT node.
- :param interface: An interface on the DUT node.
- :param table_id: ID of a classify table.
- :param ip_version: Version of IP protocol. Valid options are ip4, ip6.
- :type node: dict
- :type interface: str or int
- :type table_id: int
- :type ip_version: str
- """
-
- if isinstance(interface, basestring):
- sw_if_index = Topology.get_interface_sw_index(node, interface)
- elif isinstance(interface, int):
- sw_if_index = interface
- else:
- raise TypeError
-
- table = "{0}-table {1}".format(ip_version, table_id)
-
- with VatTerminal(node, json_param=False) as vat:
- vat.vat_terminal_exec_cmd_from_template(
- "ipfix_interface_enable.vat",
- interface=sw_if_index,
- table=table,
- delete='')
-
- @staticmethod
- def set_ipfix_stream(node, domain=None, src_port=None):
- """Set an IPFIX export stream. Can be used to break up IPFIX reports
- into separate reporting domains.
-
- :param node: DUT node.
- :param domain: Desired index number of exporting domain.
- :param src_port: Source port to use when sending IPFIX packets. Default
- is the standard IPFIX port 4739.
- :type node: dict
- :type domain: int
- :type src_port: int
- """
-
- domain = "domain {0}".format(domain) if domain else ''
- src_port = "src_port {0}".format(src_port) if src_port else ''
-
- with VatTerminal(node, json_param=False) as vat:
- vat.vat_terminal_exec_cmd_from_template("ipfix_stream_set.vat",
- domain=domain,
- src_port=src_port)
-
- @staticmethod
- def assign_classify_table_to_exporter(node, table_id, ip_version='ip4'):
- """Assign a classify table to an IPFIX exporter. Classified packets will
- be included in the IPFIX flow report.
-
- :param node: DUT node.
- :param table_id: ID of a classify table.
- :param ip_version: Version of IP protocol. Valid options are ip4, ip6.
- :type node: dict
- :type table_id: int
- :type ip_version: str
- """
-
- with VatTerminal(node, json_param=False) as vat:
- vat.vat_terminal_exec_cmd_from_template("ipfix_table_add.vat",
- table=table_id,
- ip_version=ip_version,
- add_del='add')
diff --git a/resources/libraries/python/telemetry/IPFIXUtil.py b/resources/libraries/python/telemetry/IPFIXUtil.py
deleted file mode 100644
index 2f83760759..0000000000
--- a/resources/libraries/python/telemetry/IPFIXUtil.py
+++ /dev/null
@@ -1,105 +0,0 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at:
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""IPFIX utilities library. Provides classes that allow scapy to work
-with IPFIX packets.
-
- Note:
- Template and data sets in one packet are not supported.
- Option template sets (Set_ID = 3) are not supported.
- """
-
-
-from scapy.all import Packet, bind_layers
-from scapy.fields import ByteField, ShortField, IntField, LongField, IPField,\
- StrFixedLenField, FieldListField
-from scapy.layers.inet import UDP
-from scapy.layers.inet6 import IP6Field
-from scapy.contrib.ppi_geotag import UTCTimeField
-
-
-class IPFIXHandler(object):
- """Class for handling IPFIX packets. To use, create instance of class before
- dissecting IPFIX packets with scapy, then run update_template every time
- an IPFIX template packet is received."""
-
- template_elements = {
- 4: ByteField("Protocol_ID", 0x00),
- 7: ShortField("src_port", 0),
- 8: IPField("IPv4_src", ""),
- 11: ShortField("dst_port", 0),
- 12: IPField("IPv4_dst", ""),
- 27: IP6Field("IPv6_src", "::"),
- 28: IP6Field("IPv6_dst", "::"),
- 86: LongField("packetTotalCount", 0),
- 180: ShortField("udp_src_port", 0),
- 181: ShortField("udp_dst_port", 0),
- 182: ShortField("tcp_src_port", 0),
- 183: ShortField("tcp_dst_port", 0),
- 193: ByteField("Next_header", 0x00)
- }
-
- def __init__(self):
- """Initializer, registers IPFIX header and template layers with scapy.
- """
- bind_layers(UDP, IPFIXHeader, dport=4739)
- bind_layers(IPFIXHeader, IPFIXTemplate, Set_ID=2)
-
- def update_template(self, packet):
- """Updates IPFIXData class with new data template. Registers IPFIX data
- layer with scapy using the new template.
-
- :param packet: Packet containing an IPFIX template.
- :type packet: scapy.Ether
- """
- template_list = packet['IPFIX template'].Template
- template_id = packet['IPFIX template'].Template_ID
-
- IPFIXData.fields_desc = []
- for item in template_list[::2]:
- try:
- IPFIXData.fields_desc.append(self.template_elements[item])
- except KeyError:
- raise KeyError(
- "Unknown IPFIX template element with ID {0}".format(item))
- bind_layers(IPFIXHeader, IPFIXData, Set_ID=template_id)
- # if the packet doesn't end here, assume it contains more data sets
- bind_layers(IPFIXData, IPFIXData)
-
-
-class IPFIXHeader(Packet):
- """Class for IPFIX header."""
- name = "IPFIX header"
- fields_desc = [StrFixedLenField("Version", 0x000a, length=2),
- ShortField("Message Length", 0),
- UTCTimeField("Timestamp(UTC)", ""),
- IntField("Sequence Number", 0),
- IntField("Observation Domain ID", 0),
- ShortField("Set_ID", 0),
- ShortField("Set_Length", 0)]
-
-
-class IPFIXTemplate(Packet):
- """Class for IPFIX template layer."""
- name = "IPFIX template"
- fields_desc = [ShortField("Template_ID", 256),
- ShortField("nFields", 2),
- FieldListField("Template", [], ShortField("type_len", ""),
- count_from=lambda p: p.nFields*2)]
-
-
-class IPFIXData(Packet):
- """Class for IPFIX data layer. Needs to be updated with
- a template before use."""
- name = "IPFIX flow data"
- fields_desc = []
diff --git a/resources/libraries/python/telemetry/SPAN.py b/resources/libraries/python/telemetry/SPAN.py
index 048e89ba67..c282c6160b 100644
--- a/resources/libraries/python/telemetry/SPAN.py
+++ b/resources/libraries/python/telemetry/SPAN.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2018 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
@@ -14,7 +14,7 @@
"""SPAN setup library"""
from resources.libraries.python.topology import Topology
-from resources.libraries.python.VatExecutor import VatTerminal
+from resources.libraries.python.PapiExecutor import PapiExecutor
class SPAN(object):
@@ -25,39 +25,26 @@ class SPAN(object):
pass
@staticmethod
- def set_span_mirroring(node, src_if, dst_if):
- """Set Span mirroring on the specified node.
-
- :param node: DUT node.
- :param src_if: Interface to mirror traffic from.
- :param dst_if: Interface to mirror traffic to.
- :type node: dict
- :type src_if: str
- :type dst_if: str
- """
-
- src_if = Topology.get_interface_sw_index(node, src_if)
- dst_if = Topology.get_interface_sw_index(node, dst_if)
-
- with VatTerminal(node, json_param=False) as vat:
- vat.vat_terminal_exec_cmd_from_template('span_create.vat',
- src_sw_if_index=src_if,
- dst_sw_if_index=dst_if)
-
- @staticmethod
- def vpp_get_span_configuration(node):
+ def vpp_get_span_configuration(node, is_l2=False):
"""Get full SPAN configuration from VPP node.
+ Used by Honeycomb.
+
:param node: DUT node.
:type node: dict
+
:returns: Full SPAN configuration as list. One list entry for every
source/destination interface pair.
:rtype: list of dict
"""
+ args = dict(
+ is_l2=1 if is_l2 else 0
+ )
+ with PapiExecutor(node) as papi_exec:
+ dump = papi_exec.add("sw_interface_span_dump", **args). \
+ get_dump().reply[0]["api_reply"]
- with VatTerminal(node, json_param=True) as vat:
- data = vat.vat_terminal_exec_cmd_from_template('span_dump.vat')
- return data[0]
+ return dump
@staticmethod
def vpp_get_span_configuration_by_interface(node, dst_interface,
@@ -65,6 +52,8 @@ class SPAN(object):
"""Get a list of all interfaces currently being mirrored
to the specified interface.
+ Used by Honeycomb.
+
:param node: DUT node.
:param dst_interface: Name, sw_if_index or key of interface.
:param ret_format: Optional. Desired format of returned interfaces.
@@ -78,12 +67,13 @@ class SPAN(object):
data = SPAN.vpp_get_span_configuration(node)
- dst_interface = Topology.convert_interface_reference(
+ dst_int = Topology.convert_interface_reference(
node, dst_interface, "sw_if_index")
src_interfaces = []
for item in data:
- if item["dst-if-index"] == dst_interface:
- src_interfaces.append(item["src-if-index"])
+ if item["sw_interface_span_details"]["sw_if_index_to"] == dst_int:
+ src_interfaces.append(
+ item["sw_interface_span_details"]["sw_if_index_from"])
if ret_format != "sw_if_index":
src_interfaces = [