Skip to main content

The Snappi IxNetwork Open Traffic Generator Python Package

Project description

snappi Extension for IxNetwork

license Project Status: Active - The project has reached a stable, usable state and is being actively developed. Build pypi python Total alerts Language grade: Python downloads

This extension allows executing test scripts written using snappi against
IxNetwork, (one of) Keysight's implementation of Open Traffic Generator.

The repository is under active development.

To start contributing, please see contributing.md.

Install on a client

python -m pip install --upgrade "snappi[ixnetwork]"

Start scripting

"""
Configure a raw TCP flow with,
- tx port as source to rx port as destination
- frame count 10000, each of size 128 bytes
- transmit rate of 1000 packets per second
Validate,
- frames transmitted and received for configured flow is as expected
"""

import snappi
# host is IxNetwork API Server
api = snappi.api(location='https://localhost:443', ext='ixnetwork')
# new config
config = api.config()
# port location is chassis-ip;card-id;port-id
tx, rx = (
    config.ports
    .port(name='tx', location='192.168.0.1;2;1')
    .port(name='rx', location='192.168.0.1;2;2')
)
# configure layer 1 properties
ly, = config.layer1.layer1(name='ly')
ly.port_names = [tx.name, rx.name]
ly.speed = ly.SPEED_10_GBPS
ly.media = ly.FIBER
# configure flow properties
flw, = config.flows.flow(name='flw')
# flow endpoints
flw.tx_rx.port.tx_name = tx.name
flw.tx_rx.port.rx_name = rx.name
# enable flow metrics
flw.metrics.enable = True
# configure rate, size, frame count
flw.size.fixed = 128
flw.rate.pps = 1000
flw.duration.fixed_packets.packets = 10000
# configure protocol headers with defaults fields
flw.packet.ethernet().vlan().ipv4().tcp()
# push configuration
api.set_config(config)
# start transmitting configured flows
control_state = api.control_state()
control_state.choice = control_state.TRAFFIC
control_state.traffic.choice = control_state.traffic.FLOW_TRANSMIT
control_state.traffic.flow_transmit.state = control_state.traffic.flow_transmit.START  # noqa
res = api.set_control_state(control_state)
if len(res.warnings) > 0:
    print("Warnings: {}".format(res.warnings))
# create a query for flow metrics
req = api.metrics_request()
req.flow.flow_names = [flw.name]
# wait for flow metrics to be as expected
while True:
    res = api.get_metrics(req)
    if all([m.frames_tx == 10000 == m.frames_rx for m in res.flow_metrics]):
        break

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snappi_ixnetwork-1.13.0.tar.gz (93.8 kB view details)

Uploaded Source

Built Distribution

snappi_ixnetwork-1.13.0-py2.py3-none-any.whl (86.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file snappi_ixnetwork-1.13.0.tar.gz.

File metadata

  • Download URL: snappi_ixnetwork-1.13.0.tar.gz
  • Upload date:
  • Size: 93.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for snappi_ixnetwork-1.13.0.tar.gz
Algorithm Hash digest
SHA256 f9a0b6bf6c769e89bce543cbd5cd29ff9fff751b8ac55e5580eb44295fd89188
MD5 5f5db3e3d7f6dc1f357e1296f397215d
BLAKE2b-256 b85439d897e9a37cf6ee0b327ea8ed22d1b81e0e81b75b0267d0386cce145e49

See more details on using hashes here.

File details

Details for the file snappi_ixnetwork-1.13.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for snappi_ixnetwork-1.13.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8215784ce78cb7b4784917daa541c80985aafb7570e7cde0d9dff3394fb4dd4e
MD5 c896ce3b794385d57ebb1d96b037f29a
BLAKE2b-256 7531b8af470c29b7442448710afdc858a616df0b70cf1f4092ae4fe425b29f5d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page