################################################################################
#                                                                              #
#    Copyright 1997 - 2020 by IXIA  Keysight                                   #
#    All Rights Reserved.                                                      #
#                                                                              #
################################################################################

################################################################################
#                                                                              #
#                                LEGAL  NOTICE:                                #
#                                ==============                                #
# The following code and documentation (hereinafter "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 set 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 Traffic Operation API  #
#    It will create IPTV in IGMP Host topology, it will start the emulation and#
#    than it will retrieve and display few statistics                          #
#                                                                              #
################################################################################

################################################################################
# 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();
}


################################################################################
# Defining the create IPv4 Traffic Item function
################################################################################

sub createBasicIPv4TrafficItem {
my @my_resource = @_;
my $ixNet    = $my_resource[0];
my $name = $my_resource[1];
my $topo1 = $my_resource[2];
my $topo2 = $my_resource[3];
print ("- creating traffic item: %s \n",$name);

################################################################################
# Configure L2-L3 traffic 
################################################################################

print ("Congfiguring L2-L3 Traffic Item\n");
my $trafficItem1 = $ixNet->add(($ixNet->getRoot()).'/traffic', 'trafficItem');
$ixNet->setMultiAttribute($trafficItem1, '-name', $name ,
    '-roundRobinPacketOrdering', 'false',
    '-trafficType', 'ipv4');
$ixNet->commit();

$trafficItem1    = ($ixNet->remapIds($trafficItem1))[0];
my $endpointSet1 = $ixNet->add($trafficItem1, 'endpointSet');
my @source       = ($topo2.'/deviceGroup:1/ethernet:1/ipv4:1');
my @destination  = ($topo1.'/deviceGroup:1/ethernet:1/ipv4:1');

$ixNet->setMultiAttribute($endpointSet1,
    '-name',                  'EndpointSet-1',
    '-multicastDestinations', [[]],
    '-scalableSources',       [],
    '-multicastReceivers',    [[]],
    '-scalableDestinations',  [],
    '-ngpfFilters',           [],
    '-trafficGroups',         [],
    '-sources',               @source,
    '-destinations',          @destination);
$ixNet->commit();

$ixNet->setMultiAttribute($trafficItem1.'/tracking',
    '-trackBy',        ['ipv4DestIp0','trackingenabled0'],
    '-fieldWidth',     'thirtyTwoBits',
    '-protocolOffset', 'Root.0',
    '-values',         []);
$ixNet->commit();
}

################################################################################
# Defining the Ingress Tracking for Traffic Item set function
################################################################################

sub setIngressTrackingForTI {
my @my_resource = @_;
my $ixNet    = $my_resource[0];
my $ti = $my_resource[1];
my $trackingList = $my_resource[2];

    my $tiName = $ixNet->getAttribute($ti, '-name');
    print "--- Traffic Item: $tiName setting ingress tracking $trackingList \n";
    $ixNet->setMultiAttribute($ti."/tracking", '-trackBy', $trackingList);
    $ixNet->commit();
}

################################################################################
# Defining the Egress Tracking for Traffic Item set function
################################################################################    

sub setFirstEgressTrackingForTI{
	my @my_resource = @_;
	my $ixNet    = $my_resource[0];
	my $ti = $my_resource[1];
	my $stack = $my_resource[2];
	my $field = $my_resource[3];
    my $tiName = $ixNet->getAttribute($ti, '-name');
    print "--- Traffic Item: $tiName setting eggress tracking to field $field for stack $stack\n";
    $ixNet->setAttribute($ti, '-egressEnabled', 'True');
    my @et = $ixNet->getList($ti, 'egressTracking');
    $ixNet->setAttribute(@et[0], '-encapsulation', 'Any: Use Custom Settings');
    $ixNet->setAttribute(@et[0], '-offset', 'CustomByField');
    $ixNet->commit();
	my @stackList = $ixNet->getList(@et[0].'/fieldOffset', 'stack');
    foreach my $mstack (@stackList) {
		if (index($mstack, $stack) != -1) {
            my @fieldList = $ixNet->getList($mstack, 'field');
            foreach my $mfield (@fieldList) {
				if (index($mfield, $field) != -1) {
                    $ixNet->setAttribute($mfield, '-activeFieldChoice', 'True');
                    $ixNet->setAttribute($mfield, '-trackingEnabled', 'True');
                    $ixNet->setAttribute($mfield, '-valueType', 'singleValue');
                    $ixNet->commit();
                }
				}
				}
				}
				}

################################################################################
# Defining the Latency Bins for Traffic Item set function
################################################################################

sub setLatencyBinsTrackingForTI {
my @my_resource = @_;
	my $ixNet    = $my_resource[0];
	my $ti = $my_resource[1];
	my $binNo = $my_resource[2];
    my $tiName = $ixNet->getAttribute($ti, '-name');
    print "--- Traffic Item: $tiName setting latency bins tracking $binNo\n";
    my @latencyBin = $ixNet->getList($ti.'/tracking', 'latencyBin');
    $ixNet->setAttribute(@latencyBin[0], '-enabled', 'True');
    $ixNet->setAttribute(@latencyBin[0], '-numberOfBins', $binNo);
    $ixNet->commit();
}

################################################################################
# Adding ports to configuration
################################################################################

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

# Edit this variables values to match your setup
my $ixTclServer = '10.200.115.31';
my $ixTclPort   = '8009';
my @ports       = (('10.200.115.31', '5', '1'), ('10.200.115.31', '6', '1'));
# 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.50',
    '-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 @vPorts  = $ixNet->getList($ixNet->getRoot(), 'vport');
my $vportTx = $vPorts[0];
my $vportRx = $vPorts[1];
assignPorts($ixNet, @ports, $vportTx, $vportRx);
sleep(5);

print("Adding 2 topologies\n");
$ixNet->add($ixNet->getRoot(), 'topology', '-vports', $vportTx);
$ixNet->add($ixNet->getRoot(), 'topology', '-vports', $vportRx);
$ixNet->commit();

my @topologies = $ixNet->getList($ixNet->getRoot(), 'topology');
my $topo1 = $topologies[0];
my $topo2 = $topologies[1];

print("Adding 2 device groups\n");
$ixNet->add($topo1, '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];

print("Configuring the multipliers (number of sessions)\n");
$ixNet->setAttribute($t1dev1, '-multiplier', '1');
$ixNet->setAttribute($t2dev1, '-multiplier', '1');
$ixNet->commit();

print("Adding ethernet/mac endpoints\n");
$ixNet->add($t1dev1, 'ethernet');
$ixNet->add($t2dev1, 'ethernet');
$ixNet->commit();

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

print("Configuring the mac addresses\n");
$ixNet->setMultiAttribute($ixNet->getAttribute($mac1, '-mac').'/counter',
        '-direction', 'increment',
        '-start',     '18:03:73:C7:6C:B1',
        '-step',      '00:00:00:00:00:01');

$ixNet->setAttribute($ixNet->getAttribute($mac2, '-mac').'/singleValue',
        '-value', '18:03:73:C7:6C:01');
$ixNet->commit();

print("Add ipv4\n");
$ixNet->add($mac1, 'ipv4');
$ixNet->add($mac2, 'ipv4');
$ixNet->commit();

my $ip1 = ($ixNet->getList($mac1, 'ipv4'))[0];
my $ip2 = ($ixNet->getList($mac2, 'ipv4'))[0];

my $mvAdd1 = $ixNet->getAttribute($ip1, '-address');
my $mvAdd2 = $ixNet->getAttribute($ip2, '-address');
my $mvGw1  = $ixNet->getAttribute($ip1, '-gatewayIp');
my $mvGw2  = $ixNet->getAttribute($ip2, '-gatewayIp');

print("configuring ipv4 addresses\n");
$ixNet->setAttribute($mvAdd1.'/singleValue', '-value', '20.20.20.2');
$ixNet->setAttribute($mvAdd2.'/singleValue', '-value', '20.20.20.1');
$ixNet->setAttribute($mvGw1.'/singleValue', '-value', '20.20.20.1');
$ixNet->setAttribute($mvGw2.'/singleValue', '-value', "20.20.20.2");

$ixNet->setAttribute($ixNet->getAttribute($ip1, '-prefix').'/singleValue', '-value', '24');
$ixNet->setAttribute($ixNet->getAttribute($ip2, '-prefix').'/singleValue', '-value', '24');

$ixNet->setMultiAttribute($ixNet->getAttribute($ip1, '-resolveGateway').'/singleValue', '-value', 'true');
$ixNet->setMultiAttribute($ixNet->getAttribute($ip2, '-resolveGateway').'/singleValue', '-value', 'true');
$ixNet->commit();
sleep(5);

################################################################################
# Start protocol 
################################################################################

print("Starting protocol\n");
$ixNet->execute('startAllProtocols');
print("Running the protocol for 10 seconds ..\n");
sleep(10);

################################################################################
# Retrieve protocol statistics.
################################################################################

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 my $statValueList (@rowvals) {
    print("***************************************************\n");
    my $statVal = '';
    foreach my $statVal (@$statValueList) {
	    my $statIndiv = ''; 
		$index = 0;
	    foreach $statIndiv (@$statVal) {
		    printf(" %-30s:%s\n", $statcap[$index], $statIndiv);
			$index++;
        }
    }    
}
print("***************************************************\n");
sleep(5);

###############################################################################
# Apply and start L2/L3 traffic
###############################################################################


print "Creating 2 Traffic Items for IPv4";
createBasicIPv4TrafficItem($ixNet, "TI 1 IPv4",$topo1,$topo2);
createBasicIPv4TrafficItem($ixNet, "TI 2 IPv4",$topo2,$topo1);

################################################################################
# Performing the Traffic Actions Samples
################################################################################

print "Traffic Actions Samples:\n";
print "- Disable TI 1 IPv4\n";
my @ti = $ixNet->getList('/traffic','trafficItem');
my $ti1 = @ti[0];
my $ti2 = @ti[1];
$ixNet->setAttribute($ti1, '-enabled', 'False');
$ixNet->commit();
print "- Enable TI 1 IPv4\n";
$ixNet->setAttribute($ti1, '-enabled', 'True');
$ixNet->commit();
print "- Duplicate TI 1 IPv4 3 times\n";
$ixNet->execute('duplicate', $ti1, 3);
print "- Remove a Traffic Item copy\n";
my @ti_remove = $ixNet->getList('/traffic', 'trafficItem');
$ixNet->remove(@ti_remove[2]);
$ixNet->remove(@ti_remove[3]);
$ixNet->remove(@ti_remove[4]);
$ixNet->commit();
print "- Adding Ingress Tracking for bot Traffic Items\n";
my $trackingList = "sourceDestValuePair0";
setIngressTrackingForTI($ixNet, $ti1, $trackingList);
setIngressTrackingForTI($ixNet, $ti2, $trackingList);
print "- Adding Egress Tracking for both Traffic Items\n";
setFirstEgressTrackingForTI($ixNet, $ti1, "ipv4", "ipv4.header.version-1");
setFirstEgressTrackingForTI($ixNet, $ti2, "ipv4", "ipv4.header.version-1");
print "- Adding Latency Bins Tracking for both Traffic Items\n";
setLatencyBinsTrackingForTI($ixNet, $ti1, 4);
setLatencyBinsTrackingForTI($ixNet, $ti2, 4);

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');
sleep(30);

print("Stopping L2/L3 traffic\n");
$ixNet->execute('stop', ($ixNet->getRoot()).'/traffic');
sleep(5);

################################################################################
# Stop Protocols
################################################################################

print "Stop All Protocols\n";
$ixNet->execute('stopAllProtocols');
print "Test Finished\n";