Ixia BreakingPoint Chassis 2 Gen Shell #1649
Quali-Community
started this conversation in
Integrations
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Ixia BreakingPoint Chassis 2 Gen Shell
A shell integrates a device model, application or other technology with CloudShell. A shell consists of a data model that defines how the device and its properties are modeled in CloudShell, along with automation that enables interaction with the device via CloudShell.
Traffic Generator Shells
CloudShell's traffic generator shells enable you to conduct traffic test activities on Devices Under Test (DUT) or Systems Under Test (SUT) from a sandbox. In CloudShell, a traffic generator is typically modeled using a chassis resource, which represents the traffic generator device and ports, and a controller service that runs the chassis commands, such as Load Configuration File, Start Traffic and Get Statistics. Chassis and controllers are modeled by different shells, allowing you to accurately model your real-life architecture. For example, scenarios where the chassis and controller are located on different machines.
For additional information on traffic generator shell architecture, and setting up and using a traffic generator in CloudShell, see the Traffic Generators Overiew online help topic.
Ixia BreakingPoint 2G Shells
To model an Ixia BreakingPoint device in CloudShell, use the following shells:
▪ BreakingPoint Chassis 2G Shell, which provides data model and autoload functionality to model and load the BreakingPoint Chassis to resource management.
▪ BreakingPoint Controller 2G Shell (service), which provides functionality to load test configuration, run tests, get test results, etc.
Standard version
The BreakingPoint 2G shells are based on the Traffic Generator Chassis Shell Standard version 1.0.3 and Traffic Generator Controller Shell Standard version 2.0.0.
For detailed information about the shell’s structure and attributes, see the Traffic Generator Chassis Shell Standard and Traffic Generator Controller Shell Standard in GitHub.
Certified models
▪ BreakingPoint VE
Requirements
Release: Ixia BreakingPoint 2G shells
▪ CloudShell version: 8.3 GA Patch 3 and above patches, 9.0 GA Patch 2 and above patches, 9.1 GA and above patches, and above CloudShell versions
▪ BreakingPoint application: 8.20 and above
Shell Documentation
The shell documentation can be found at: Ixia BreakingPoint 2G Shells ReadMe.
Repository
Latest Release
README.md
Name
BreakingPoint-Chassis-Shell-2G
Owner
QualiSystems
Type
2nd Gen Shell
Category
Traffic Generators
Min. Compatible CloudShell Version
8.3P3 9.0P2 9.1
Total Downloads
(All Releases)
165
Link
3.0.1
(Version / Tag)
TAR / ZIP
3.0.1 (TAR)
3.0.1 (ZIP)
Author
github-actions[bot]
Published On
09/05/2022 01:15 PM
Assets
BreakingPoint.Chassis.Shell.2G.zip
[8 KB]
cloudshell-BreakingPoint-Chassis-Shell-2G-offline-requirements-package-3.0.1.zip
[1.09 MB]
BreakingPoint Chassis 2G Shell
Release date: September 2022
Shell version: 3.0.1
Document version: 1.1
In This Guide
Overview
A shell integrates a device model, application or other technology with CloudShell. A shell consists of a data model that defines how the device and its properties are modeled in CloudShell, along with automation that enables interaction with the device via CloudShell.
Traffic Generator Shells
CloudShell's traffic generator shells enable you to conduct traffic test activities on Devices Under Test (DUT) or Systems Under Test (SUT) from a sandbox. In CloudShell, a traffic generator is typically modeled using a chassis resource, which represents the traffic generator device and ports, and a controller service that runs the chassis commands, such as Load Configuration File, Start Traffic and Get Statistics. Chassis and controllers are modeled by different shells, allowing you to accurately model your real-life architecture. For example, scenarios where the chassis and controller are located on different machines.
For additional information on traffic generator shell architecture, and setting up and using a traffic generator in CloudShell, see the Traffic Generators Overiew online help topic.
BreakingPoint Chassis 2G Shell
To model the traffic generator in CloudShell, you must use the following shells:
▪ BreakingPoint Chassis 2G Shell , which provides data model and autoload functionality to model and load the chassis to resource management.
▪ BreakingPoint Controller Shell 2G (service), which provides functionality to load test configuration, run tests, get test results, etc.
Standard version
The BreakingPoint 2G shells are based on the Traffic Generator Chassis Shell Standard version 1.0.3 and the Traffic Generator Controller Shell Standard version 2.0.0.
For detailed information about the shell’s structure and attributes, see the Traffic Generator Chassis Shell Standard and the Traffic Generator Controller Shell Standard in GitHub.
Requirements
Release: Ixia BreakingPoint 2G shells
Data Model
The shell's data model includes all shell metadata, families, and attributes.
BreakingPoint Families and Models
The chassis families and models are listed in the following table:
BreakingPoint Chassis 2G Shell Attributes
The attribute names and types are listed in the following sections of the Traffic Generator Standard:
Automation
This section describes the automation (driver) associated with the data model. The shell’s driver is provided as part of the shell package. There are two types of automation processes, Autoload and Resource. Autoload is executed when creating the resource in the Inventory dashboard, while resource commands are run in the sandbox.
For Traffic Generator shells, commands are configured and executed from the controller service in the sandbox, with the exception of the Autoload command, which is executed when creating the resource.
The command names and types are listed in the following sections of the Traffic Generator Standard:
Downloading the Shell
The BreakingPoint Chassis 2G Shell is available from the Quali Community Integrations page.
Download the files into a temporary location on your local machine.
The shell comprises:
Importing and Configuring the Shell
This section describes how to import the BreakingPoint Chassis 2G Shell and configure and modify the shell’s devices.
Importing the shell into CloudShell
To import the shell into CloudShell:
Make sure you have the shell’s zip package. If not, download the shell from the Quali Community's Integrations page.
In CloudShell Portal, as Global administrator, open the Manage – Shells page.
Click Import.
In the dialog box, navigate to the shell's zip package, select it and click Open.
The shell is displayed in the Shells page and can be used by domain administrators in all CloudShell domains to create new inventory resources, as explained in Adding Inventory Resources.
Offline installation of a shell
Note: Offline installation instructions are relevant only if CloudShell Execution Server has no access to PyPi. You can skip this section if your execution server has access to PyPi. For additional information, see the online help topic on offline dependencies.
In offline mode, import the shell into CloudShell and place any dependencies in the appropriate dependencies folder. The dependencies folder may differ, depending on the CloudShell version you are using:
For CloudShell version 8.3 and above, see Adding Shell and script packages to the local PyPi Server repository.
For CloudShell version 8.2, perform the appropriate procedure: Adding Shell and script packages to the local PyPi Server repository or Setting the Python pythonOfflineRepositoryPath configuration key.
For CloudShell versions prior to 8.2, see Setting the Python pythonOfflineRepositoryPath configuration key.
Adding shell and script packages to the local PyPi Server repository
If your Quali Server and/or execution servers work offline, you will need to copy all required Python packages, including the out-of-the-box ones, to the PyPi Server's repository on the Quali Server computer (by default C:\Program Files (x86)\QualiSystems\CloudShell\Server\Config\Pypi Server Repository).
For more information, see Configuring CloudShell to Execute Python Commands in Offline Mode.
To add Python packages to the local PyPi Server repository:
If you haven't created and configured the local PyPi Server repository to work with the execution server, perform the steps in Add Python packages to the local PyPi Server repository (offline mode).
For each shell or script you add into CloudShell, do one of the following (from an online computer):
Connect to the Internet and download each dependency specified in the requirements.txt file with the following command:
pip download -r requirements.txt
.The shell or script's requirements are downloaded as zip files.
In the Quali Community's Integrations page, locate the shell and click the shell's Download link. In the page that is displayed, from the Downloads area, extract the dependencies package zip file.
Place these zip files in the local PyPi Server repository.
Setting the Python PythonOfflineRepositoryPath configuration key
Before PyPi Server was introduced as CloudShell’s Python package management mechanism, the
PythonOfflineRepositoryPath
key was used to set the default offline package repository on the Quali Server machine, and could be used on specific Execution Server machines to set a different folder.To set the offline Python repository:
Download the [Shell Offline Requirements .zip File Name] file, see Downloading the Shell.
Unzip it to a local repository. Make sure the execution server has access to this folder.
On the Quali Server machine, in the ~\CloudShell\Server\customer.config file, add the following key to specify the path to the default Python package folder (for all Execution Servers):
<add key="PythonOfflineRepositoryPath" value="repository full path"/>
If you want to override the default folder for a specific Execution Server, on the Execution Server machine, in the ~TestShell\Execution Server\customer.config file, add the following key:
<add key="PythonOfflineRepositoryPath" value="repository full path"/>
Restart the Execution Server.
Configuring a new resource
This section explains how to create a new resource from the shell.
In CloudShell, the component that models the device is called a resource. It is based on the shell that models the device and allows the CloudShell user and API to remotely control the device from CloudShell.
You can also modify existing resources, see Managing Resources in the Inventory.
To create a resource for the device:
In the CloudShell Portal, in the Inventory dashboard, click Add New.
From the list, select BreakingPoint Chassis 2G Shell.
Enter the Name and IP address of the device (if applicable).
Click Create.
In the Resource dialog box, enter the device's settings. For details, see Device Name Attributes.
Click Continue.
CloudShell validates the device’s settings and updates the new resource with the device’s structure (if the device has a structure).
Updating Python Dependencies for Shells
This section explains how to update your Python dependencies folder. This is required when you upgrade a shell that uses new/updated dependencies. It applies to both online and offline dependencies.
Updating offline Python dependencies
To update offline Python dependencies:
Download the latest Python dependencies package zip file locally.
Extract the zip file to the suitable offline package folder(s).
Terminate the shell’s instance, as explained here.
Updating online Python dependencies
In online mode, the execution server automatically downloads and extracts the appropriate dependencies file to the online Python dependencies repository every time a new instance of the driver or script is created.
To update online Python dependencies:
References
To download and share integrations, see Quali Community's Integrations.
For instructional training and documentation, see Quali University.
To suggest an idea for the product, see Quali's Idea box.
To connect with Quali users and experts from around the world, ask questions and discuss issues, see Quali's Community forums.
To use traffic generator ports as abstract resources, see CloudShell's Online Help.
Release Notes
What's New
For release updates, see the shell's GitHub releases page.
* Please allow 30-60 seconds for manual update changes to take effect.
ofir eldar 02/14/2019 04:58 PM
· 4350 ·
Beta Was this translation helpful? Give feedback.
All reactions