Metadata-Version: 2.1
Name: snappi-ixnetwork
Version: 0.1.10
Summary: The IxNetwork Open Traffic Generator Python Package
Home-page: https://github.com/open-traffic-generator
Author: ajbalogh
Author-email: andy.balogh@keysight.com
License: MIT
Description: # Snappi Extension for IxNetwork
        [![license](https://img.shields.io/badge/license-MIT-green.svg)](https://en.wikipedia.org/wiki/MIT_License)
        [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
        [![Build](https://github.com/open-traffic-generator/ixnetwork/workflows/Build/badge.svg)](https://github.com/open-traffic-generator/ixnetwork/actions)
        [![pypi](https://img.shields.io/pypi/v/snappi_ixnetwork.svg)](https://pypi.org/project/snappi_ixnetwork)
        [![python](https://img.shields.io/pypi/pyversions/snappi_ixnetwork.svg)](https://pypi.python.org/pypi/snappi_ixnetwork)
        [![Total alerts](https://img.shields.io/lgtm/alerts/g/open-traffic-generator/ixnetwork.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/open-traffic-generator/ixnetwork/alerts/)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/open-traffic-generator/ixnetwork.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/open-traffic-generator/ixnetwork/context:python)
        
        This extension allows executing test scripts written using [snappi](https://github.com/open-traffic-generator/snappi) against  
        IxNetwork, (one of) Keysight's implementation of [Open Traffic Generator](https://github.com/open-traffic-generator/models/releases).
        
        The snappi-ixnetwork extension in this repo is under active development.
        
        To start contributing, please see [contributing.md](contributing.md).
        
        ## Install on a client
        
        ```sh
        python -m pip install --upgrade "snappi[ixnetwork]"
        ```
        
        ## Start scripting
        
        ```python
        """
        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(host='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 only one flow
        flw = config.flows.flow(name='flw')[-1]
        # configure rate, size, frame count and endpoints
        flw.size.fixed = 128
        flw.rate.pps = 1000
        flw.duration.fixed_packets.packets = 10000
        flw.tx_rx.port.tx_name = tx.name
        flw.tx_rx.port.rx_name = rx.name
        # configure protocol headers with defaults fields
        flw.packet.ethernet().vlan().ipv4().tcp()
        # set configuration and start traffic
        api.set_config(config)
        ts = api.transmit_state()
        ts.state = ts.START
        api.set_transmit_state(ts)
        # wait for flow metrics to be as expected
        while True:
            metrics = api.get_flow_metrics(api.flow_metrics_request())
            if all([m.frames_tx == 10000 == m.frames_rx for m in metrics]):
                break
        ```
        
Keywords: ixnetwork testing open traffic generator automation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing :: Traffic Generation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Requires-Python: >=2.7, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
