snappi

Test scripts written in snappi, an auto-generated python SDK, can be executed against any traffic generator conforming to Open Traffic Generator API.

Ixia-c is one such reference implementation of Open Traffic Generator API.

The repository is under active development and is subject to updates. All efforts will be made to keep the updates backwards compatible.

Setup Client

python -m pip install --upgrade snappi

Start Testing

import datetime
import time
import snappi
import pytest


@pytest.mark.example
def test_quickstart():
    # Create a new API handle to make API calls against OTG
    # with HTTP as default transport protocol
    api = snappi.api(location="https://localhost:8443")

    # Create a new traffic configuration that will be set on OTG
    config = api.config()

    # Add a test port to the configuration
    ptx = config.ports.add(name="ptx", location="veth-a")

    # Configure a flow and set previously created test port as one of endpoints
    flow = config.flows.add(name="flow")
    flow.tx_rx.port.tx_name = ptx.name
    # and enable tracking flow metrics
    flow.metrics.enable = True

    # Configure number of packets to transmit for previously configured flow
    flow.duration.fixed_packets.packets = 100
    # and fixed byte size of all packets in the flow
    flow.size.fixed = 128

    # Configure protocol headers for all packets in the flow
    eth, ip, udp, cus = flow.packet.ethernet().ipv4().udp().custom()

    eth.src.value = "00:11:22:33:44:55"
    eth.dst.value = "00:11:22:33:44:66"

    ip.src.value = "10.1.1.1"
    ip.dst.value = "20.1.1.1"

    # Configure repeating patterns for source and destination UDP ports
    udp.src_port.values = [5010, 5015, 5020, 5025, 5030]
    udp.dst_port.increment.start = 6010
    udp.dst_port.increment.step = 5
    udp.dst_port.increment.count = 5

    # Configure custom bytes (hex string) in payload
    cus.bytes = "".join([hex(c)[2:] for c in b"..QUICKSTART SNAPPI.."])

    # Optionally, print JSON representation of config
    print("Configuration: ", config.serialize(encoding=config.JSON))

    # Push traffic configuration constructed so far to OTG
    api.set_config(config)

    # Start transmitting the packets from configured flow
    ts = api.transmit_state()
    ts.state = ts.START
    api.set_transmit_state(ts)

    # Fetch metrics for configured flow
    req = api.metrics_request()
    req.flow.flow_names = [flow.name]
    # and keep polling until either expectation is met or deadline exceeds
    start = datetime.datetime.now()
    while True:
        metrics = api.get_metrics(req)
        if (datetime.datetime.now() - start).seconds > 10:
            raise Exception("deadline exceeded")
        # print YAML representation of flow metrics
        print(metrics)
        if metrics.flow_metrics[0].transmit == metrics.flow_metrics[0].STOPPED:
            break
        time.sleep(0.1)

Metadata

Release files for snappi 1.28.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for snappi 1.28.2
File	Size	Uploaded
snappi-1.28.2.tar.gz	471.3 kB	Apr 10, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for snappi 1.28.2
File	Interpreter	ABI	Platform	Reset
snappi-1.28.2-py2.py3-none-any.whl 475.1 kB Apr 10, 2025	Python 2, Python 3	none	any	Details

Total release size: 946.4 kB

Release files / snappi-1.28.2.tar.gz

Download URL	snappi-1.28.2.tar.gz
Size	471.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`8a72d265c9e19a22545dabf1bee063a17fcad55545454293085e1ee719095bc7`
BLAKE2b-256 checksum How to use checksums	`b61268129b21a42ca9b5cbb6d38667419a1179031240c82f8b67f4548759a86f`
Upload date	Apr 10, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.8.18`

Release files / snappi-1.28.2-py2.py3-none-any.whl

Download URL	snappi-1.28.2-py2.py3-none-any.whl
Size	475.1 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`35f8bdf22428dc328be57a33d401a0013efe3dedd7428e02707e7fc2572c6718`
BLAKE2b-256 checksum How to use checksums	`f7d5101eb33279ad4d256487680b323c827af873e25bb81732b3448d794b4cda`
Upload date	Apr 10, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.8.18`