################################################################################

# Version 1.0    $Revision: #1 $                                                #

#                                                                              #

#    Copyright © 1997 - 2014 by IXIA                                           #

#    All Rights Reserved.                                                      #

#                                                                              #

#    Revision Log:                                                             #

#    12/12/2014 - Sayantan Pramanick - created sample                          #

#                                                                              #

################################################################################



################################################################################

#                                                                              #

#                                LEGAL  NOTICE:                                #

#                                ==============                                #

# The following code and documentation (hereintime.sleep("the script") is an   #

# example script for demonstration purposes only.                              #

# The script is not a standard commercial product offered by Ixia and have     #

# been developed and is being provided for use only as indicated herein. The   #

# script [and all modifications enhancements and updates thereto (whether      #

# made by Ixia and/or by the user and/or by a third party)] shall at all times #

# remain the property of Ixia.                                                 #

#                                                                              #

# Ixia does not warrant (i) that the functions contained in the script will    #

# meet the users requirements or (ii) that the script will be without          #

# omissions or error-free.                                                     #

# THE SCRIPT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND AND IXIA         #

# DISCLAIMS ALL WARRANTIES EXPRESS IMPLIED STATUTORY OR OTHERWISE              #

# INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF MERCHANTABILITY AND FITNESS FOR #

# A PARTICULAR PURPOSE OR OF NON-INFRINGEMENT.                                 #

# THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SCRIPT  IS WITH THE #

# USER.                                                                        #

# IN NO EVENT SHALL IXIA BE LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING   #

# OUT OF THE USE OF OR THE INABILITY TO USE THE SCRIPT OR ANY PART THEREOF     #

# INCLUDING BUT NOT LIMITED TO ANY LOST PROFITS LOST BUSINESS LOST OR          #

# DAMAGED DATA OR SOFTWARE OR ANY INDIRECT INCIDENTAL PUNITIVE OR              #

# CONSEQUENTIAL DAMAGES EVEN IF IXIA HAS BEEN ADVISED OF THE POSSIBILITY OF    #

# SUCH DAMAGES IN ADVANCE.                                                     #

# Ixia will not be required to provide any software maintenance or support     #

# services of any kind (e.g. any error corrections) in connection with the     #

# script or any part thereof. The user acknowledges that although Ixia may     #

# from time to time and in its sole discretion provide maintenance or support  #

# services for the script any such services are subject to the warranty and    #

# damages limitations forth herein and will not obligate Ixia to provide       #

# any additional maintenance or support services.                              #

#                                                                              #

################################################################################



################################################################################

#                                                                              #

# Description:                                                                 #

#    This script intends to demonstrate how to use NGPF Audio Video Bridging   #

#     API.                                                                     #

#                                                                              #

#    1. It will create one MSRP Talker in one topology and 2 MSRP Listeners    #

#       in another topology. gPTP clocks will be added in talkers and          #

#       listeners.                                                             #

#    2. Start all protocols.                                                   #

#    3. Retrieve protocol statistics.                                          #

#    4. Retrieve protocol learned info.                                        #

#    7. Configure L2-L3 traffic.                                               #

#    9. Start the L2-L3 traffic.                                               #

#   12. Retrieve L2-L3 traffic stats.                                          #

#   13. Stop L2-L3 traffic.                                                    #

#   15. Stop all protocols.                                                    #                                                                                          

# Ixia Softwares:                                                              #

#    IxOS      6.80 EA (6.80.1100.7)                                           #

#    IxNetwork 7.40 EA (7.40.929.15)                                           #

#                                                                              #

################################################################################



################################################################################

# Please ensure that PERL5LIB environment variable is set properly so that 

# IxNetwork.pm module is available. IxNetwork.pm is generally available in

# C:\<IxNetwork Install Path>\API\Perl

################################################################################

use IxNetwork;

use strict;



sub assignPorts {

    my @my_resource = @_;

	my $ixNet    = $my_resource[0];

	my $chassis1 = $my_resource[1];

	my $card1    = $my_resource[2];

	my $port1    = $my_resource[3];

	my $chassis2 = $my_resource[4];

	my $card2    = $my_resource[5];

	my $port2    = $my_resource[6];

	my $vport1   = $my_resource[7];

	my $vport2   = $my_resource[8];

	

	my $root = $ixNet->getRoot();

	my $chassisObj1 = $ixNet->add($root.'/availableHardware', 'chassis');

    $ixNet->setAttribute($chassisObj1, '-hostname', $chassis1);

    $ixNet->commit();

    $chassisObj1 = ($ixNet->remapIds($chassisObj1))[0];

	

	my $chassisObj2 = '';

	if ($chassis1 ne $chassis2) {

	    $chassisObj2 = $ixNet->add($root.'/availableHardware', 'chassis');

        $ixNet->setAttribute($chassisObj2, '-hostname', $chassis2);

        $ixNet->commit();

        $chassisObj2 = ($ixNet->remapIds($chassisObj2))[0];

	} else {

	    $chassisObj2 = $chassisObj1;

	}

	

	my $cardPortRef1 = $chassisObj1.'/card:'.$card1.'/port:'.$port1;

    $ixNet->setMultiAttribute($vport1, '-connectedTo', $cardPortRef1,

        '-rxMode', 'captureAndMeasure', '-name', 'Ethernet - 001');

    $ixNet->commit();



    my $cardPortRef2 = $chassisObj2.'/card:'.$card2.'/port:'.$port2;

    $ixNet->setMultiAttribute($vport2, '-connectedTo', $cardPortRef2,

        '-rxMode', 'captureAndMeasure', '-name', 'Ethernet - 002');

		

    $ixNet->commit();

}



# Script Starts

print("!!! Test Script Starts !!!\n");



# Edit this variables values to match your setup

my $ixTclServer = '10.205.25.88';

my $ixTclPort   = '7777';

my @ports       = (('10.205.28.65', '2', '1'), ('10.205.28.65', '2', '2'));

# Spawn a new instance of IxNetwork object. 

my $ixNet = new IxNetwork();



print("Connect to IxNetwork Tcl server\n");

$ixNet->connect($ixTclServer, '-port', $ixTclPort, '-version', '7.40',

    '-setAttribute', 'strict');



print("Creating a new config\n");

$ixNet->execute('newConfig');



print("Adding 2 vports\n");

$ixNet->add($ixNet->getRoot(), 'vport');

$ixNet->add($ixNet->getRoot(), 'vport');

$ixNet->commit();



my $root   = $ixNet->getRoot();

my @vPorts  = $ixNet->getList($ixNet->getRoot(), 'vport');

my $vport1 = $vPorts[0];

my $vport2 = $vPorts[1];

assignPorts($ixNet, @ports, $vport1, $vport2);

sleep(5);



print("Adding 2 topologies\n");

$ixNet->add($root, 'topology', '-vports', $vport1);

$ixNet->add($root, 'topology', '-vports', $vport2);

$ixNet->commit();



my @topologies = $ixNet->getList($ixNet->getRoot(), 'topology');

my $topo1 = $topologies[0];

my $topo2 = $topologies[1];



print("Adding 1 device groups in topology 1\n");

$ixNet->add($topo1, 'deviceGroup');



print("Adding 2 device groups in topology 2\n");

$ixNet->add($topo2, 'deviceGroup');

$ixNet->add($topo2, 'deviceGroup');

$ixNet->commit();



my @t1devices = $ixNet->getList($topo1, 'deviceGroup');

my @t2devices = $ixNet->getList($topo2, 'deviceGroup');



my $t1dev1 = $t1devices[0];

my $t2dev1 = $t2devices[0];

my $t2dev2 = $t2devices[1];



print("Configuring the multipliers (number of sessions)\n");

$ixNet->setAttribute($t1dev1, '-multiplier', 1);

$ixNet->setAttribute($t2dev1, '-multiplier', 2);

$ixNet->setAttribute($t2dev2, '-multiplier', 1);

$ixNet->commit();



print("Adding ethernet/mac endpoints\n");

$ixNet->add($t1dev1, 'ethernet');

$ixNet->add($t2dev1, 'ethernet');

$ixNet->add($t2dev2, 'ethernet');

$ixNet->commit();



my $mac1 = ($ixNet->getList($t1dev1, 'ethernet'))[0];

my $mac2 = ($ixNet->getList($t2dev1, 'ethernet'))[0];

my $mac3 = ($ixNet->getList($t2dev2, 'ethernet'))[0];



print("Configuring the mac addresses\n");

$ixNet->setMultiAttribute($ixNet->getAttribute($mac1, '-mac').'/counter',

    '-direction', 'increment',                        

    '-start', '22:22:22:22:22:22',

    '-step', '00:00:00:00:00:01');



$ixNet->setMultiAttribute($ixNet->getAttribute($mac2, '-mac').'/counter',

    '-direction', 'increment',                        

    '-start', '44:44:44:44:44:44',

    '-step', '00:00:00:00:00:01');



$ixNet->setMultiAttribute($ixNet->getAttribute($mac3, '-mac').'/singleValue',

    '-value', '66:66:66:66:66:66');

$ixNet->commit();



print("Adding MSRP talker in topology 1\n");

my $talker1 = $ixNet->add($mac1, 'msrpTalker');

$ixNet->commit();

my $talker1 = ($ixNet->remapIds($talker1))[0];



print("Configuring 2 streams in talker\n");

$ixNet->setAttribute($talker1, '-streamCount', '2');

$ixNet->commit();



print("Adding gPTP clock in topology 1\n");

my $ptp1 = $ixNet->add($mac1, 'ptp');

$ixNet->commit();

my $ptp1 = ($ixNet->remapIds($ptp1))[0];



print("Setting clock role as master in AVB talker\n");

$ixNet->setAttribute($ixNet->getAttribute($ptp1, '-role').'/singleValue',

    '-value', 'master');

$ixNet->commit();



print("Adding MSRP listener in topology 2\n");

my $listener1 = $ixNet->add($mac2, 'msrpListener');

$ixNet->commit();

my $listener1 = ($ixNet->remapIds($listener1))[0];



print("Adding gptp clock in topology 2\n");

my $ptp2 = $ixNet->add($mac3, 'ptp');

$ixNet->commit();

my $ptp2 = ($ixNet->remapIds($ptp2))[0];



$ixNet->setAttribute($ixNet->getAttribute($ptp2, '-profile').'/singleValue',

    '-value', 'ieee8021as');

$ixNet->setAttribute($ixNet->getAttribute($ptp2, '-delayMechanism').'/singleValue',

    '-value', 'peerdelay');

$ixNet->commit();



################################################################################

# 2. Start AVB protocols and wait for 60 seconds

################################################################################

print("Starting protocols and waiting for 60 seconds for protocols to come up\n");

$ixNet->execute('startAllProtocols');

sleep(5);



print("Fetching all Protocol Summary Stats\n");

my $viewPage = '::ixNet::OBJ-/statistics/view:"Protocols Summary"/page';

my @statcap  = $ixNet->getAttribute($viewPage, '-columnCaptions');

my @rowvals  = $ixNet->getAttribute($viewPage, '-rowValues');

my $index    = 0;

my $statValueList= '';

foreach $statValueList (@rowvals) {

    print("***************************************************\n");

    my $statVal = '';

    foreach $statVal (@$statValueList) {

	    my $statIndiv = ''; 

		$index = 0;

	    foreach $statIndiv (@$statVal) {

		    printf(" %-30s:%s\n", $statcap[$index], $statIndiv);

			$index++;

        }

    }    

}

print("***************************************************\n");



################################################################################

# 4. Retrieve protocol learned info

################################################################################

print("Fetching MSRP Talker Learned Info\n");

$ixNet->execute('getTalkerDatabases', $talker1);

sleep(5);

my @linfo = $ixNet->getList($talker1, 'learnedInfo');

my $streamDb = $linfo[0];

my $domainDb = $linfo[1];

my $vlanDb   = $linfo[2];



my @values = $ixNet->getAttribute($streamDb, '-values');

my @column = $ixNet->getAttribute($streamDb, '-columns');



print("***************************************************\n");

print("****  MSRP Talker stream database learned info ****\n");

for (my $index = 0; $index < @values; $index++) {

    my $rowValue = $values[$index];

		for (my $col = 0; $col < @column; $col++) {

        printf("%-30s:%s\n", $column[$col], @{$rowValue}[$col]);

    }#end for

}#end for



print("***************************************************\n");



my @values = $ixNet->getAttribute($domainDb, '-values');

my @column = $ixNet->getAttribute($domainDb, '-columns');



print("***************************************************\n");

print("****  MSRP Talker domain database learned info ****\n");

for (my $index = 0; $index < @values; $index++) {

    my $rowValue = $values[$index];

    for (my $col = 0; $col < @column; $col++) {

        printf("%-30s:%s\n", $column[$col], @{$rowValue}[$col]);

    }#end for

}#end for



print("***************************************************\n");



my @values = $ixNet->getAttribute($vlanDb, '-values');

my @column = $ixNet->getAttribute($vlanDb, '-columns');



print("***************************************************\n");

print("****  MSRP Talker VLAN database learned info ****\n");

for (my $index = 0; $index < @values; $index++) {

    my $rowValue = $values[$index];

		for (my $col = 0; $col < @column; $col++) {

        printf("%-30s:%s\n", $column[$col], @{$rowValue}[$col]);

    }#end for

}#end for



print("***************************************************\n");



print("Fetching MSRP Listener Learned Info for listener 1\n");

$ixNet->execute('getListenerDatabases', $listener1, '1');

sleep(5);

my @linfo = $ixNet->getList($listener1, 'learnedInfo');

my $streamDb = $linfo[0];

my $domainDb = $linfo[1];

my $vlanDb   = $linfo[2];



my @values = $ixNet->getAttribute($streamDb, '-values');

my @column = $ixNet->getAttribute($streamDb, '-columns');



print("***************************************************\n");

print("*** MSRP Listener stream database learned info ****\n");

for (my $index = 0; $index < @values; $index++) {

    my $rowValue = $values[$index];

		for (my $col = 0; $col < @column; $col++) {

        printf("%-30s:%s\n", $column[$col], @{$rowValue}[$col]);

    }#end for

}#end for

print("***************************************************\n");



my @values = $ixNet->getAttribute($domainDb, '-values');

my @column = $ixNet->getAttribute($domainDb, '-columns');

print("***************************************************\n");

print("*** MSRP Listener Domain database learned info ****\n");

for (my $index = 0; $index < @values; $index++) {

    my $rowValue = $values[$index];

		for (my $col = 0; $col < @column; $col++) {

        printf("%-30s:%s\n", $column[$col], @{$rowValue}[$col]);

    }#end for

}#end for

print("***************************************************\n");



my @values = $ixNet->getAttribute($vlanDb, '-values');

my @column = $ixNet->getAttribute($vlanDb, '-columns');

print("***************************************************\n");

print("**** MSRP Listener VLAN database learned info *****\n");

for (my $index = 0; $index < @values; $index++) {

    my $rowValue = $values[$index];

		for (my $col = 0; $col < @column; $col++) {

        printf("%-30s:%s\n", $column[$col], @{$rowValue}[$col]);

    }#end for

}#end for

print("***************************************************\n");



################################################################################

# 5. Disable streams and apply changes On The Fly (OTF). Enable again.

################################################################################

print("Deactivating the streams\n");

my $streams = ($ixNet->getList($mac1, 'streams'))[0];

my $multiValue = $ixNet->getAttribute($streams, '-active');

$ixNet->setAttribute($multiValue.'/singleValue', '-value', 'false');

$ixNet->commit();



my $globals = ($ixNet->getRoot()).'/globals';

my $topology = $globals.'/topology';

print("Applying changes on the fly\n");

$ixNet->execute('applyOnTheFly', $topology);

sleep(5);



print("Activating the streams\n");

$ixNet->setAttribute($multiValue.'/singleValue', '-value', 'true');

$ixNet->commit();



print("Applying changes on the fly\n");

$ixNet->execute('applyOnTheFly', $topology);

sleep(5);



################################################################################

# 7. Configure L2-L3 traffic 

################################################################################

print("Configuring L2-L3 Traffic Item\n");

my $trafficItem1 = $ixNet->add(($ixNet->getRoot()).'/traffic', 'trafficItem');

$ixNet->setMultiAttribute($trafficItem1,

    '-name', 'avb_traffic',

    '-roundRobinPacketOrdering', 'false',

    '-trafficType', 'avb1722');

$ixNet->commit();



my $trafficItem1 = ($ixNet->remapIds($trafficItem1))[0];

my $endpointSet1 = $ixNet->add($trafficItem1, 'endpointSet');

my $mcastDestination = [['false', 'none', '22:22:22:22:22:22:00:01',

    '00:00:00:00:00:00:00:00', '1'], ['false', 'none', '22:22:22:22:22:22:00:02',

    '00:00:00:00:00:00:00:00', '1']];

my $mcastReceiver = [[$listener1.'/subscribedStreams', '0', '0', '0'],

    [$listener1.'/subscribedStreams', '0', '0', '1'],

    [$listener1.'/subscribedStreams', '0', '1', '0'],

    [$listener1.'/subscribedStreams', '0', '1', '1']];

          

$ixNet->setMultiAttribute($endpointSet1,

    '-name',                  'EndpointSet-1',

    '-multicastDestinations', $mcastDestination,

    '-scalableSources',       [],

    '-multicastReceivers',    $mcastReceiver,

    '-scalableDestinations',  [],

    '-ngpfFilters',           [],

    '-trafficGroups',         [],

    '-sources',               [],

    '-destinations',          []);

$ixNet->commit();



$ixNet->setMultiAttribute($trafficItem1.'/tracking',

    '-trackBy', ['trackingenabled0', 'avbStreamName0']);

$ixNet->commit();



###############################################################################

# 9. Apply and start L2/L3 traffic

###############################################################################

print ("applying L2/L3 traffic\n");

$ixNet->execute('apply', ($ixNet->getRoot()).'/traffic');

sleep(5);



print ("starting L2/L3 traffic\n");

$ixNet->execute('start', ($ixNet->getRoot()).'/traffic');



###############################################################################

# 12. Retrieve L2/L3 traffic item statistics

###############################################################################

print("Verifying all the L2-L3 traffic stats\n");

my $viewPage = '::ixNet::OBJ-/statistics/view:"Flow Statistics"/page';

my @statcap  = $ixNet->getAttribute($viewPage, '-columnCaptions');

my @rowvals  = $ixNet->getAttribute($viewPage, '-rowValues');

my $index    = 0;

my $statValueList= '';

foreach $statValueList (@rowvals) {

    print("***************************************************\n");

    my $statVal = '';

    foreach $statVal (@$statValueList) {

	    my $statIndiv = ''; 

		$index = 0;

	    foreach $statIndiv (@$statVal) {

		    printf(" %-30s:%s\n", $statcap[$index], $statIndiv);

			$index++;

        }

    }    

}

################################################################################

# 14. Stop L2/L3 traffic

#################################################################################

print ("Stopping L2/L3 traffic\n");

$ixNet->execute('stop', ($ixNet->getRoot()).'/traffic');

sleep(5);



################################################################################

# 15. Stop all protocols

################################################################################

print ("Stopping protocols\n");

$ixNet->execute('stopAllProtocols');

print ("!!! Test Script Ends !!!");