Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

IxVM Chassis Deployment App 2G Shell

Release date: March 2019

Shell version: 1.0.1

Document version: 1.0.0

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.

IxVM Chassis Deployment App 2G Shell

The IxVM Deployment App 2G shell provides you with connectivity and management capabilities such as device structure discovery and power management. The device is provided as a virtual machine within a vCenter App.

For more information on the IxVM Traffic Chassis, see the official IxVM product documentation.

Note: The shell supports only VMone, which combines the Virtual Chassis and Virtual Load Module into a single VM.

Standard version

IxVM Chassis Deployment App 2G shell is based on the CloudShell Virtual Traffic Generator Standard 1.0.0.

Requirements

Release: IxVM Chassis Deployment App 2G Shell

IxVM versions: 8.40 and above

CloudShell versions: 8.2 and above

Ixia Virtual Test Appliance versions: 8.2 and above

Note: If your CloudShell version does not support this shell, you should consider upgrading to a later version of CloudShell or contact customer support.

Data Model

The shell's data model includes all shell metadata, families, and attributes.

IxVM Chassis Deployment App 2G Shell Families and Models

The families and models of the chassis are listed in the following table:

Family Model Description
Virtual Traffic Generator Chassis IxVM Virtual Traffic Chassis 2G IxVM deployed test appliance
Module Virtual Traffic Generator Module IxVM deployed test appliance card
Port Virtual Traffic Generator Port IxVM deployed test appliance port

IxVM Chassis Deployed App 2G Shell Attributes

The attributes of the chassis are listed in the following table:

Attribute Type Default value Description
Name String CloudShell resource display name.
Address String IP address of the deployed IxVM test appliance.
Folder String Root CloudShell folder in which to place the resource. Use the search bar to quickly find the desired folder.
Visibility Lookup Family Default (Everyone) Visibility determines who can see the resource in the diagram, search pane, and Inventory dashboard. By default, Visibility is defined in the resource family and can be changed for a specific resource.
Possible values: Family Default (Everyone), Admin only, and Everyone.
Remote Connection Lookup Family Default (Enable) Remote connection determines if you can remotely connect to the resource. By default, Remote Connection is defined in the resource family and can be changed for a specific resource.
Possible values: Family Default (Enable), Enable, and Disable.
Controller TCP Port String TCP port of the traffic server. Relevant only if an external server is configured. If left empty, the Default TCP port is used.
Controller Address String IP address of the traffic server. Relevant only if an external server is configured.
Client Install Path String Path in which the traffic client is installed on the Execution Server. For example C:/Program Files (x86)/Ixia/IxLoad/5.10-GA.
Power Management Boolean True Used by the power management orchestration, if enabled, to determine whether to automatically manage the device power status.
Serial Number String Serial number of the resource.
Server Description String Full description of the server. Usually includes the OS, exact firmware version, and additional characteristics of the device.
License Server String License server address.
Model Name String Catalog name of the device model. The attribute will be displayed in CloudShell instead of the CloudShell model.
Vendor String Name of the device manufacturer.
Version String Firmware version of the resource.
User String Username for the deployed IxVM test appliance (should be a privileged user).
Password Password Password for the deployed IxVM test appliance.
License Server String IP address or hostname of the License Server.

IxVM Virtual Traffic Generator Port Attributes

The attributes of the ports are listed in the following table:

Attribute Type Description
Logical Name String Port's logical name in the test configuration
Requested vNIC String VNic number from vCenter
MAC Address String Port's MAC address

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.

IxVM Chassis Deployment App 2G shell

Command Description
Autoload Creates the device structure, its hierarchy and attributes when deploying the App.

Downloading the Shell

The IxVM Chassis Deployment App 2G shell is available from the Quali Community Integrations page.

Download the files into a temporary location on your local machine.

The shell comprises:

File name Description
IxVM Deployment App Chassis Shell2G.zip IxVM Deployment App Chassis shell 2nd Generation shell package
ixvm-deployment-app-offlinepackages-1.0.0.zip Shell Python dependencies (for offline deployments only)
IxVM.Sandbox.Setup.1.0.0zip CloudShell reservation setup script

Importing and Configuring the Shell

This section describes how to import the IxVM Deployment App 2G Shell and configure and modify the shell’s devices.

Importing the shell into CloudShell

To import the shell into CloudShell:

  1. Make sure you have the shell’s zip package. If not, download the shell from the Quali Community's Integrations page.

  2. In CloudShell Portal, as Global administrator, open the Manage – Shells page.

  3. Click Import.

  4. In the dialog box, navigate to the shell's zip package, select it and click Open.

    You can now use the vBlade and vChassis shells to create Apps that, once deployed in a sandbox, will spin up VMs that model a TeraVM traffic generator. See Configuring a new App. For more information, see Apps Overview.

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:

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:

  1. 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 (offlinemode).

  2. 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.

  3. 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:

  1. Download the ixvm-deployment-app-offlinepackages-1.0.0.zip* file, see Downloading the Shell.

  2. Unzip it to a local repository. Make sure the execution server has access to this folder.

  3. 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"/>

  4. 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"/>

  5. Restart the Execution Server.

Configuring a new App

This section explains how to create an App template for the IxVM Chassis to enable network connectivity between endpoints in the sandbox.

  1. In CloudShell Portal, as Global administrator, open the Manage – Apps page.

  2. Click Add.

  3. Select vCenter VM from Template. You may use any deployment type and provider supported by Ixia. vCenter is used here as an example.

  4. Enter the Name of the App and click Create.

  5. In the Deployment Paths tab, select the Cloud Provider and enter the vCenter Template to be used in VM creation. It should include the full path and template name, for example QualiFolder/Template.

  6. In the App Resource tab, select the IxVM Virtual Traffic Chassis 2G shell. Specify the User, Password, and License Server of the shell.

    Note: Contact your Admin to obtain the correct credentials to set on the deployed App shell. They are generally provided along with the VM image.

  7. Click Done.

The App is ready to be used in CloudShell sandboxes. A dedicated VM will be created once the App is deployed in a sandbox. Note that you can deploy multiple instances of the same App in the sandbox.

Configuring the setup script

This section explains how to add the setup script for the IxVM Deployment App Chassis 2G shell.

To add the setup script:

  1. Log in to CloudShell Portal as administrator of the relevant domain.

  2. Go to the Manage dashboard and click Scripts>Blueprint.

  3. Click Add New Script. From the list, select the downloaded setup script IxVM.Sandbox.Setup.1.0.0.zip.

  4. Click Edit and change the Script Type to Setup.

  5. Click Save.

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:

  1. Download the latest Python dependencies package zip file locally.

  2. Extract the zip file to the suitable offline package folder(s).

  3. 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:

  • If there is a live instance of the shell's driver or script, terminate the shell’s instance, as explained here. If an instance does not exist, the execution server will download the Python dependencies the next time a command of the driver or script runs.

Typical Workflows

Deploying the IxVM Deployment App Chassis 2G shell

  1. Enter your blueprint.

  2. Add the VM Deployment App to the blueprint.

    1. Open the App/Service pane.
    2. Drag and drop the IxVM Deployment App 2G Chassis resource to the canvas.
  3. Update the blueprint setup script.

    1. In the Blueprint sub menu, open Properties.
    2. In the Scripts section, select the Default Sandbox Setup 2.0 script and click the trash icon to the right of the script.
    3. Click Add Scripts.
    4. Select the IxVM.Sandbox.Setup.1.0.0.
    5. Click Done.
  4. Reserve the blueprint.

References

To download and share integrations, see Quali Community's Integrations.

For instructional training and documentation resources, see the 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.

Release Notes

What's New

For release updates, see the shell's GitHub releases page.