---
id: ixnetwork-restpy
version: "1.11.0"
license: MIT
license_treatment: permissive
maintenance: active
---

# ixnetwork-restpy — The IxNetwork Python Client

License: permissive · Maintenance: active · Downloads: 349.3K/mo

## What it is and what it does

ixnetwork-restpy is a Python client for Keysight/Ixia's IxNetwork test platform, a commercial network traffic generation and analysis system. It exposes the platform's REST API as Python objects, allowing developers to script test scenarios—port mapping, traffic configuration, statistics retrieval—without using the GUI. The library provides high-level assistants (SessionAssistant, PortMapAssistant, StatViewAssistant) that wrap lower-level REST calls and manage connection state, authentication, and resource lifecycle.

Typical workflows involve connecting to a running IxNetwork server, configuring virtual or physical ports, defining traffic flows with specific frame rates and packet modifications, running the traffic, and collecting performance metrics. The package depends on requests for HTTP communication and websocket-client for real-time updates, making it suitable for CI/CD integration, large-scale test automation, and headless lab environments.

Use it for:

- Automate network performance testing in CI/CD pipelines by scripting port configuration, traffic generation, and result collection.
- Build custom test harnesses that generate specific traffic patterns and collect statistics without manual GUI interaction.
- Integrate IxNetwork testing into larger network simulation or validation frameworks that require programmatic control.
- Scale test execution across multiple IxNetwork instances by managing sessions and port mappings via Python.
- Generate reproducible network test scenarios from version-controlled scripts instead of saved GUI configurations.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

A Python client library for automating IxNetwork test platforms via REST API, enabling programmatic control of network traffic generation, port configuration, and statistics collection.

Yes, if you have access to an IxNetwork server and need to automate network traffic testing. The package is actively maintained, has no known vulnerabilities, installs cleanly, and is permissively licensed. The main prerequisite is a running IxNetwork platform (version 8.52+); without one, the package alone is not useful. For teams already using IxNetwork, this client eliminates manual GUI work and enables scriptable, repeatable test automation.

## Install

pip install ixnetwork-restpy
uv add ixnetwork-restpy
poetry add ixnetwork-restpy

## Installing ixnetwork-restpy

Before you install: Low friction installation with four straightforward runtime dependencies (requests, websocket-client, setuptools, packaging). Active maintenance with a release within the last week.

License in practice: MIT license permits commercial and private use with minimal restrictions; suitable for most deployment contexts.

Quickstart:

pip install ixnetwork-restpy

from ixnetwork_restpy import SessionAssistant

session_assistant = SessionAssistant(IpAddress='127.0.0.1', LogLevel=SessionAssistant.LOGLEVEL_INFO)
ixnetwork = session_assistant.Ixnetwork

Requires a running IxNetwork server (version 8.52 or later) accessible at the specified IP address to connect to.

Verify before relying:

- Whether the package supports Python 2.7 in practice given the classifier, or if modern Python versions are the actual target.
- Specific version compatibility matrix between client releases and supported IxNetwork server versions beyond the stated 8.52+ minimum.

## Package facts

- License: MIT (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 349.3K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

ixnetwork automation python, network traffic generator api, ixia test platform client, rest api network testing, traffic generation scripting, network-testing, traffic-generation, rest-client

[View on SkillFed](https://skillfed.io/packages/ixnetwork-restpy) · [View on PyPI](https://pypi.org/project/ixnetwork-restpy/)