ixia hltapi automation introduction v1.1

Slide title

minimum 32 pt

(32 pt makes 2 rows

Text and bullet level 1

minimum 24 pt

Bullets level 2-5

minimum 20 pt

Characters for Embedded font: !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~¡¢£¤¥¦§¨©ª«¬®¯°±²³´¶·¸¹º»¼½ÀÁÂÃÄÅÆÇÈËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷

øùúûüýþÿĀāĂăąĆćĊċČĎďĐđĒĖėĘęĚěĞğĠġĢģĪīĮįİıĶķĹĺĻļĽľŁłŃńŅņŇňŌŐőŒœŔŕŖŗŘřŚśŞşŠšŢţŤťŪūŮůŰűŲųŴŵŶŷŸŹźŻżŽžƒȘșˆˇ˘˙˚˛˜˝ẀẁẃẄẅỲỳ–—‘’‚“”„†‡•…‰‹›⁄€™ĀĀĂĂĄĄĆĆĊĊČČĎĎĐĐĒĒĖĖĘĘĚĚĞĞĠĠĢĢĪĪĮĮİĶĶĹĹĻĻĽĽŃŃŅŅŇŇŌŌŐŐŔŔŖŖŘŘŚŚŞŞŢŢŤŤŪŪŮŮŰŰŲŲŴŴŶŶŹŹŻŻȘș−≤≥fifl

ΆΈΉΊΌΎΏΐΑΒΓΕΖΗΘΙΚΛΜΝΞΟΠΡΣΤΥΦΧΨΪΫΆΈΉΊΰαβγδεζηθικλνξορςΣΤΥΦΧΨΩΪΫΌΎΏ

ЁЂЃЄЅІЇЈЉЊЋЌЎЏАБВГДЕЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯАБВГДЕЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯЁЂЃЄЅІЇЈЉЊЋЌЎЏѢѢѲѲѴѴҐҐәǽẀẁẂẃẄẅỲỳ№

Do not add objects or

text in the footer area HLTAPI | Ericsson Internal | V1.1 | 2014-12-09 |

Ixia HLTAPI Automation

introduction

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







OUTLINE

Section I

Have an overview on HLTAPI

Section II

How to work with HLTAPI in ARTS

Section III

Useful information for script writing

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Section I

Have an overview on HLTAPI

Introduction of HLTAPI

Recommend way to use HLTAPI

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Introduction of HLTAPI

What is HLTAPI?

Cisco High Level Tcl Application Programming Interface (HLTAPI)

Both Ixia’s and STC’s implementation adhere to Cisco HLTAPI.

Why we choose HLTAPI?

Make the use of the test equipment easier to automate.

• For each protocol and traffic, there are 3 main APIs: config, control, stats/info.

Greatly reduce test script changes after upgrade.

• Hide lower level API and make any differences completely transparent to you.

Easier to migrate test scripts from one kind of TGEN to another.

• Both Ixia and STC will update implementation according to CISCO requirement.

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Introduction of HLTAPI (CONT.)

Who will use HLTAPI and when?

We suggest all testers who will write new scripts to use HLTAPI

from now on, because Ixia’s implementation of HLTAPI has been

enhanced in IxNetwork 7.30 especially for NextGen Framework,

Low level API wrapper (IXNETWORK.pm) will be still maintained

for modification and enhancement of existing scripts.

Where to use HLTAPI?

In ARTS, HLTAPI would be called via IXNETWORK object which

could be obtained by global variable $::device<n>.

Get new codes to support running HLTAPI via Tcl client:

• New file: infra/lib/common/TGEN.pm

• New folder: infra/lib/common/TGEN

• Several lines modification in infra/lib/common/IXNETWORK.pm

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







RECOMMEND way to use HLTAPI

1. Manually configure interface / topology, protocol, traffic

via IxNetwork GUI, then start all protocols and traffic to

get useful statistics successfully.

2. Use “Automation-> Script Gen” to generate High Level

Script.

3. View the script and find out how to call HLTAPI one by

one.

4. Convert Ixia script to ARTS script.

5. Configure test bed.

Note: Step 2-3 can be replaced by loading ixncfg in ARTS script.

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







SECTION II

How to work with HLTAPI in ARTS

Operations via IxNetwork GUI

Ixia to ARTS

Test bed configuration

Load ixncfg

Protocols verified

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Find out how to call HLTAPI

Operations via IxNetwork GUI

Manually configure

Script Gen

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







IXIA to ARTS

Take DHCP Client APIs for example:

Described in Chapter7 of Ixia HLTAPIs Guide 4.90

We support 2 ways to call the API:

Option 1:

$::device1->emulation_dhcp_config->Exec(…); // use ixia namespace by default

$::device1->ngpf->emulation_dhcp_config->Exec(…); // use ngpf namespace

• Just copy and paste API name from Ixia Guide / ScriptGen.

• The only exception: For session API: connect, we need to call it as

$::device1->connectAPI->Exec() to avoid conflict.

• See more information of namespace in next page.

Option 2:

$::device1->emulation->dhcp->config->Exec(…);

$::device1->ngpf->emulation->dhcp->config->Exec(…);

• This style is similar to ARTS NextGen API for SEOS.

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







IXIA to ARTS – Namespace

NAME - ::<namespace>::emulation_dhcp_config

A namespace is a collection of commands and variables. It

encapsulates the commands and variables to ensure they do not

interfere with the commands and variables of other namespaces.

::ixia – This namespace is valid for HLT commands using IxOS,

IxNetwork-FT, IxNetwork legacy, IxLoad functionality.

::ixiangpf– This namespace is valid for HLT commands using

NGPF IxNetwork functionality.

Note: For details about the Protocols and their supported APIs

please see Protocols and Required APIs.

C:/Users/eweixgu/Desktop/HL_API_Help_4.91/Content/HLTAPI/output_flare/emulation_dhcp_config.html

C:/Users/eweixgu/Desktop/HL_API_Help_4.91/Content/HLTAPI/output_flare/emulation_dhcp_config.html

C:/Program Files (x86)/Ixia/hltapi/4.90.112.58/Docs/Content/HL_API/About_HLT/Protocols_Required_APIs.htm

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







IXIA to ARTS – Parameter

Parameters should be given in hash mode.

Parameter names are exactly same as those in Ixia

HLTAPI Guide / ScriptGen.

If the parameter is described as list or array in the Ixia

HLTAPI guide, we need to input the reference of list or

hash in ARTS script.

Example: my @portList = ( $::DEVICE1_PORT1, $::DEVICE1_PORT2);

$::device1->connectAPI->Exec( port_list => \@portList, device => $::device1->{IP_ADDRESS}, …

);

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







IXIA to ARTS – Load Parameters

You can also predefine input parameters in .stream file my $ospfv2_2_status =$::device1->NGPF->emulation_ospf_config->Exec(

profile => "OSPFv2_2_CFG",

handle => "$ipv4_2_handle",

mode => "create“

);

In .stream file: N2XSET = OSPFv2_2_CFG {

area_id = 0.0.0.0

area_id_type = ip

authentication_mode = null

demand_circuit = 0

…

}

Note: In the case where one parameter is defined in both script and .stream file, the definition in script has higher priority than that in .stream file.

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







IXIA to ARTS – Return value

Return values of the APIs are put in hash.

For the key split by ‘.’ in the HLTAPI guide, it should be

accessed in hash style.

Example:

For the key: ipv6.aggregate.port_name in the guide,

It should be accessed as: $result->{ipv6}{aggregate}{port_name}

Important:

For there is no way to differentiate between a string and a list with

only one element, we need to take care of it in ARTS script.

Example: ipv6.aggregate.port_list is defined as a list

If only one port is configured, the value should be a list that has only one element, we

should get it by $result->{ipv6}{aggregate}{port_list}.

If several ports are configured, the value should be a list that has several elements, we

should get the item by $result->{ipv6}{aggregate}{port_list}->[i].

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Test bed configuration

Before Test

For a successful connection, below components should be installed.

TCL Client with package IxTclNetwork / IxTclHal / Ixia installed

IxNetwork TCL Server (installed with IxNetwork)

Ixia TCL Server (installed with IxOS)

Note: You can find detailed description in IXIA HLTAPI Guide, chapter "Session APIs“,

and you can also refer to Ixia support.

Test bed Example testbed=ixialoopback243 {

DEVICE=Hardware_IXIANETWORK

CONNECTION-D=GE,Hardware_IXIANETWORK.4/15,Hardware_IXIANETWORK.4/16

}

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Test bed configuration (CONT.)

DEVICE=Hardware_IXIANETWORK {

TYPE=IXNETWORK

ADMIN_IP=10.170.81.243 // Ixia Chassis IP

CHASSIS_ID=1

TCL_CLIENT=Hardware_ixia_tcl_client_77 // Ixia TCL Client Device, see below

CABLE_LENGTH=1

LOCKS_ENABLED=0

PROMPT=/\[.*\]\$/

}

DEVICE=Hardware_ixia_tcl_client_77 {

TYPE=LINUX

IXTCL_SERVER=147.128.22.186 // where the IxNetwork TCL Server is installed

IXOS_TCL_PORT=7009 // which port IxNetwork started (if missing, default 8009)

ADMIN_IP=10.185.57.77 // where the Ixia TCL Client is installed

USERNAME=test // access info of TCL Client

PASSWORD=test

IXOS_VERSION=6.70.1050.14

IXTCLSH_PATH=/tools/sqa/tcl8.4/bin/tclsh // path of tcl shell

IXOS_TCL_LIB=/home/arts2/ixia/IxOS6.70.1050.14/lib // path of IXIA TCL Lib in TCL Client

}

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Load IXNCFG

To save time used in protocol configuration (~70% time),

we support loading existing Ixia Configure File (ixncfg),

then make changes on protocols and Traffic Items. Load existing Ixia Configure File .ixncfg

Port mapping

Connect

Get Protocol handlers

Make changes on protocol

Get Traffic Item/Flow Group handlers

Make changes on Traffic Item/Flow Group

Start the protocols

(Collect Protocol Statistics) Start the traffic items

Stop protocols and traffic

Collect traffic and/or protocol statistics

Clean up and release the ports

Sample script: tests/ixia_hltapi/basic/loadconfig

Equal to do all

configuration in script

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Protocols verified

Protocols verified by EGI team (till Dec. 5)

DHCPv4 Server & Client

DHCPv6 Server & Client

Dual-stack (DHCPv4 and DHCPv6) Client

IPv6 Auto-configuration

PPPOX Client

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Section III

Useful information for script writing

FAQ

Code & sample scripts

Reference materials

Further enhancement

Support

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







FAQ

Q: How do we use offline ports for automation activities?

A: Call connect API used parameter vport_count instead of port_list,

and then call connect API again with parameter port_list to resume

session & assign ports.

Q: Is HLTAPI traffic model different from what IxNetwork GUI

users are accustomed to?

A: Yes. The building blocks of traffic are streams. Each stream is

given a globally unique stream ID when created. This ID is used later

on to retrieve stream statistics, such as packet rates, packets

transmitted, and received per-stream latencies (max, min, average).

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Code & sample scripts

ARTS Code:

Please get the latest ARTS code.

cvsm checkout -rARTS_Production arts_lib

Sample Scripts:

cvsm checkout -rARTS_Production sqa/ARTS/testsample

Under sqa/ARTS/testsample folder, you can find

• Ixia Legacy/Classic Sample: tests/ixia_hltapi/legacy/dhcpv4_b2b

• Ixia NextGen Sample: tests/ixia_hltapi/ngpf/ospfv2_basic

• Load Configure File Sample: tests/ixia_hltapi/basic/loadconfig

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Reference materials

Sample scripts

To get a basic idea

Ixia HLTAPI Help

From Ixia Guide we can know what APIs they provide,

what parameters need to fill in each API

Where to find:

• HLTAPI 4.90/IxNetwork7.30:

Refer to HL_API_Help.htm

Typically it can be found at C:\Program Files

(x86)\Ixia\hltapi\4.90.112.58\Docs

• HLTAPI 4.70/IxNetwork7.10:

C:\Program Files

(x86)\Ixia\hltapi\4.70.92.8\TclScripts\lib\hltapi\Docs\HLTAPICommand

Guide_.pdf

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Reference materials Common steps For IXIA legacy Protocols

The following format shows a typical legacy script setup:

Connect to the chassis and IxNetwork Tcl Server and reserve ports

Configure interfaces using the interface_config procedure and/or

Configure the routing and switching protocols using the

emulation_<protocol>_config procedures

Configure the traffic items

Start the protocols

(Collect Protocol Statistics) Start the traffic items

Stop protocols and traffic



Sample script: tests/ixia_hltapi/legacy/dhcpv4_b2b

Note: For more information please refer to HL API help:

About This Guide -> Difference Between NGPF and Legacy Protocols

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Reference materials Common steps For IXIA NGPF Protocols

The following items are included in a NGPF HL API script:

Connect to the chassis and IxNetwork Tcl Server and reserve ports

Create topologies on the assigned ports

Create device groups in the topologies

Add protocol stacks under each device group

Create traffic items using the NGPF endpoints provided by the protocol stacks

Start the protocols

Retrieve protocol statistics

Start the traffic items

Stop the protocol stacks and traffic items



Sample script: tests/ixia_hltapi/ngpf/ospfv2_basic

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Further enhancement

Support defining default parameter values for specific test

bed or traffic generator.

Simplify the structure of return value for specific API.

Use mapping mechanism like ARTS NextGen API to hide

the differences between different versions of TGEN

equipment.

Other feature the users want

Slide title

minimum 32 pt

(32 pt makes 2 rows


minimum 24 pt

Bullets level 2-5

minimum 20 pt







Support

Ixia Support

For questions related to IxNetwork GUI usage, test environment

setup, features/protocols Ixia supported etc.

ARTS/TGEN Support

For ARTS/TGEN automation tool related Issues.

eTrack

ixia hltapi automation introduction v1.1

Documents