################################################################################
#                                                                              #
#    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 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 TRILL APIs             #
#                                                                              #
#    1. It will create one TRILL RBridge per topology in two ports. Behind     #
#       RBridge it will add FAT Tree network topology. Behind network topology #
#       it will add TRILL simulated edge RBRidge. Behind simulated edge, it    #
#       will add MAC pool which will serve as endpoints in traffic.            #
#    2. Start all protocols.                                                   #
#    3. Retrieve protocol statistics.                                          #
#    4. Retrieve protocol learned info.                                        #
#    5. Change some fields and apply change on the fly                         #
#    6. Configure L2-L3 traffic.                                               #
#    7. Start the L2-L3 traffic.                                               #
#    8. Retrieve L2-L3 traffic stats.                                          #
#    9. Stop L2-L3 traffic.                                                    #
#   10. Stop all protocols.                                                    #
################################################################################

# Script Starts
puts("!!! Test Script Starts !!!")





def assignPorts (ixNet, realPort1, realPort2)
     chassis1 = realPort1[0]
     chassis2 = realPort2[0]
     card1    = realPort1[1]
     card2    = realPort2[1]
     port1    = realPort1[2]
     port2    = realPort2[2]

     root = @ixNet.getRoot()
     vport1 = @ixNet.add(root, 'vport')
     @ixNet.commit()
     vport1 = @ixNet.remapIds(vport1)[0]

     vport2 = @ixNet.add(root, 'vport')
     @ixNet.commit()
     vport2 = @ixNet.remapIds(vport2)[0]

     chassisObj1 = @ixNet.add(root + '/availableHardware', 'chassis')
     @ixNet.setAttribute(chassisObj1, '-hostname', chassis1)
     @ixNet.commit()
     chassisObj1 = @ixNet.remapIds(chassisObj1)[0]

     if (chassis1 != chassis2) then
         chassisObj2 = @ixNet.add(root + '/availableHardware', 'chassis')
         @ixNet.setAttribute(chassisObj2, '-hostname', chassis2)
         @ixNet.commit()
         chassisObj2 = @ixNet.remapIds(chassisObj2)[0]
     else 
         chassisObj2 = chassisObj1
     end

     cardPortRef1 = chassisObj1 + '/card:'+card1+'/port:'+port1
     @ixNet.setMultiAttribute(vport1, '-connectedTo', cardPortRef1,
         '-rxMode', 'captureAndMeasure', '-name', 'Ethernet - 001')
     @ixNet.commit()

     cardPortRef2 = chassisObj2 + '/card:'+card2+'/port:'+port2
     @ixNet.setMultiAttribute(vport2, '-connectedTo', cardPortRef2,
         '-rxMode', 'captureAndMeasure', '-name', 'Ethernet - 002')
     @ixNet.commit()
end

################################################################################
# Import the ixnetwork library
# First add the library to Ruby's $LOAD_PATH:    $:.unshift <library_dir>
################################################################################
require 'ixnetwork'

#################################################################################
# Give chassis/client/ixNetwork server port/ chassis port HW port information
# below
#################################################################################
ixApiServer = '10.200.115.203'
ixApiPort   = '8009'
ports       = [['10.200.115.151', '4', '1'], ['10.200.115.151', '4', '2']]

# get IxNet class
@ixNet = IxNetwork.new
puts("connecting to IxNetwork client")
@ixNet.connect(ixApiServer, '-port', ixApiPort, '-version', '7.40',
     '-setAttribute', 'strict')

# cleaning up the old configfile, and creating an empty config
puts("cleaning up the old configfile, and creating an empty config")
@ixNet.execute('newConfig')

# assigning ports
assignPorts(@ixNet, ports[0], ports[1])
sleep(5)
root   = @ixNet.getRoot()
vport1 = @ixNet.getList(root, 'vport')[0]
vport2 = @ixNet.getList(root, 'vport')[1]

puts("Adding 2 topologies")
@ixNet.add(root, 'topology', '-vports', vport1)
@ixNet.add(root, 'topology', '-vports', vport2)
@ixNet.commit()

topologies = @ixNet.getList(root, 'topology')
topo1 = topologies[0]
topo2 = topologies[1]

puts("Renaming the topologies and the device groups")
@ixNet.setAttribute(topo1, '-name', 'Topology 1 for TRILL')
@ixNet.setAttribute(topo2, '-name', 'Topology 2 for TRILL')

puts("Adding 2 device groups")
@ixNet.add(topo1, 'deviceGroup')
@ixNet.add(topo2, 'deviceGroup')
@ixNet.commit()

t1devices = @ixNet.getList(topo1, 'deviceGroup')
t2devices = @ixNet.getList(topo2, 'deviceGroup')

t1dev1 = t1devices[0]
t2dev1 = t2devices[0]

puts("Configuring the multipliers (number of sessions)")
@ixNet.setAttribute(t1dev1, '-multiplier', 1)
@ixNet.setAttribute(t2dev1, '-multiplier', 1)
@ixNet.commit()

puts("Adding ethernet/mac endpoints")
@ixNet.add(t1dev1, 'ethernet')
@ixNet.add(t2dev1, 'ethernet')
@ixNet.commit()

mac1 = @ixNet.getList(t1dev1, 'ethernet')[0]
mac2 = @ixNet.getList(t2dev1, 'ethernet')[0]

puts("Configuring the mac addresses")
@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()

puts("Adding TRILL interfaces")
@ixNet.add(mac1, 'isisTrill')
@ixNet.add(mac2, 'isisTrill')
@ixNet.commit()

trillIf1 = @ixNet.getList(mac1, 'isisTrill')[0]
trillIf2 = @ixNet.getList(mac2, 'isisTrill')[0]

puts("Setting discard LSP off in TRILL Routers")
trillRouter1 = @ixNet.getList(t1dev1, 'isisTrillRouter')[0]
trillRouter2 = @ixNet.getList(t2dev1, 'isisTrillRouter')[0]
mv1 = @ixNet.getAttribute(trillRouter1, '-discardLSPs')
mv2 = @ixNet.getAttribute(trillRouter2, '-discardLSPs')
@ixNet.setAttribute(mv1, '-pattern', 'singleValue')
@ixNet.setAttribute(mv2, '-pattern', 'singleValue')
@ixNet.commit()

@ixNet.setAttribute(mv1 + '/singleValue', '-value', 'false')
@ixNet.setAttribute(mv2 + '/singleValue', '-value', 'false')
@ixNet.commit()

puts("Setting Mulitcast IPv4 group in TRILL Router 2")
@ixNet.setAttribute(trillRouter2, '-trillMCastIpv4GroupCount', 1)
@ixNet.commit()

trillMcastIpv4GroupList = @ixNet.getList(trillRouter2, 'trillMCastIpv4GroupList')[0]
mvMcastAddrCount = @ixNet.getAttribute(trillMcastIpv4GroupList, '-mcastAddrCnt')
mvStartMcastAddr = @ixNet.getAttribute(trillMcastIpv4GroupList, '-startMcastAddr')

@ixNet.setAttribute(mvMcastAddrCount, '-pattern', 'singleValue')
@ixNet.setAttribute(mvMcastAddrCount + '/singleValue', '-value', 2)
@ixNet.setAttribute(mvStartMcastAddr, '-pattern', 'singleValue')
@ixNet.setAttribute(mvStartMcastAddr + '/singleValue', '-value', '230.0.0.1')
@ixNet.commit()

puts("Setting Multicast MAC Groups in TRILL Router 2")
@ixNet.setAttribute(trillRouter2, '-trillMCastMacGroupCount', 1)
@ixNet.commit()

trillMCastMacGroupList = @ixNet.getList(trillRouter2, 'trillMCastMacGroupList')[0]

mvMcastAddrCount = @ixNet.getAttribute(trillMCastMacGroupList, '-mcastAddrCnt')
mvStartMcastAddr = @ixNet.getAttribute(trillMCastMacGroupList, '-startMcastAddr')

@ixNet.setAttribute(mvMcastAddrCount, '-pattern', 'singleValue')
@ixNet.setAttribute(mvMcastAddrCount + '/singleValue', '-value', 2)
@ixNet.setAttribute(mvStartMcastAddr, '-pattern', 'singleValue')
@ixNet.setAttribute(mvStartMcastAddr + '/singleValue', '-value', '01:55:55:55:55:55')
@ixNet.commit()

puts("Setting Mulitcast IPv6 group in TRILL Router 2")
@ixNet.setAttribute(trillRouter2, '-trillMCastIpv6GroupCount', 1)
@ixNet.commit()

trillMcastIpv6GroupList = @ixNet.getList(trillRouter2, 'trillMCastIpv6GroupList')[0]
mvMcastAddrCount = @ixNet.getAttribute(trillMcastIpv6GroupList, '-mcastAddrCnt')
mvStartMcastAddr = @ixNet.getAttribute(trillMcastIpv6GroupList, '-startMcastAddr')

@ixNet.setAttribute(mvMcastAddrCount, '-pattern', 'singleValue')
@ixNet.setAttribute(mvMcastAddrCount + '/singleValue', '-value', 2)
@ixNet.setAttribute(mvStartMcastAddr, '-pattern', 'singleValue')
@ixNet.setAttribute(mvStartMcastAddr + '/singleValue', '-value', 'ff03::1111')
@ixNet.commit()

puts("Adding network group with FAT tree topology")
@ixNet.add(t1dev1, 'networkGroup')
@ixNet.add(t2dev1, 'networkGroup')
@ixNet.commit()

netGroup1 = @ixNet.getList(t1dev1, 'networkGroup')[0]
netGroup2 = @ixNet.getList(t2dev1, 'networkGroup')[0]

@ixNet.add(netGroup1, 'networkTopology')
@ixNet.add(netGroup2, 'networkTopology')
@ixNet.commit()

netTopo1 = @ixNet.getList(netGroup1, 'networkTopology')[0]
netTopo2 = @ixNet.getList(netGroup2, 'networkTopology')[0]

@ixNet.add(netTopo1, 'netTopologyFatTree')
@ixNet.add(netTopo2, 'netTopologyFatTree')
@ixNet.commit()

puts("Adding device group behind network group")
@ixNet.add(netGroup1, 'deviceGroup')
@ixNet.add(netGroup2, 'deviceGroup')
@ixNet.commit()

t1dev2 = @ixNet.getList(netGroup1, 'deviceGroup')[0]
t2dev2 = @ixNet.getList(netGroup2, 'deviceGroup')[0]

puts("Adding ethernet")
@ixNet.add(t1dev2, 'ethernet')
@ixNet.add(t2dev2, 'ethernet')
@ixNet.commit()

mac3 = @ixNet.getList(t1dev2, 'ethernet')[0]
mac4 = @ixNet.getList(t2dev2, 'ethernet')[0]

puts("Adding TRILL Simulated Egde")
@ixNet.add(mac3, 'isisTrillSimRouter')
@ixNet.add(mac4, 'isisTrillSimRouter')
@ixNet.commit()

puts("Adding MAC Pools behind TRILL Simulated Edge Device")
@ixNet.add(t1dev2, 'networkGroup')
@ixNet.add(t2dev2, 'networkGroup')
@ixNet.commit()

netGroup3 = @ixNet.getList(t1dev2, 'networkGroup')[0]
netGroup4 = @ixNet.getList(t2dev2, 'networkGroup')[0]
@ixNet.add(netGroup3, 'macPools')
@ixNet.add(netGroup4, 'macPools')
@ixNet.commit()

macPool1 = @ixNet.getList(netGroup3, 'macPools')[0]
macPool2 = @ixNet.getList(netGroup4, 'macPools')[0]

mvMac1 = @ixNet.getAttribute(macPool1, '-mac')
mvMac2 = @ixNet.getAttribute(macPool2, '-mac')

@ixNet.setAttribute(mvMac1, '-pattern', 'counter')
@ixNet.setAttribute(mvMac2, '-pattern', 'counter')
@ixNet.commit()

mvCounter1 = @ixNet.getList(mvMac1, 'counter')[0]
mvCounter2 = @ixNet.getList(mvMac2, 'counter')[0]

@ixNet.setMultiAttribute(mvCounter1, '-step', '00:00:00:00:00:01', '-start', '22:22:22:22:22:22', '-direction', 'increment')
@ixNet.setMultiAttribute(mvCounter2, '-step', '00:00:00:00:00:01', '-start', '44:44:44:44:44:44', '-direction', 'increment')
@ixNet.commit()

puts("Starting protocols and waiting for 60 seconds for protocols to come up")
@ixNet.execute('startAllProtocols')
sleep(60)

################################################################################
# 2. Retrieve protocol statistics.
################################################################################
puts("Fetching all Protocol Summary Stats\n")
viewPage = '::ixNet::OBJ-/statistics/view:"TRILL RTR Per Port"/page'
statcap = @ixNet.getAttribute(viewPage, '-columnCaptions')
for statValList in @ixNet.getAttribute(viewPage, '-rowValues')
    for  statVal in statValList
        puts("***************************************************")
        index = 0
        for satIndv in statVal
            puts(statcap[index]+" "+satIndv)
            index = index + 1
        end
    end
end
puts("***************************************************")

###############################################################################
# 3. Retrieve protocol learned info
###############################################################################
puts("Fetching TRILL Learned Info")
@ixNet.execute('getLearnedInfo', trillIf1, 1)
sleep(5)
linfo1 = @ixNet.getList(trillIf1, 'learnedInfo')[0]

linfoTables  = @ixNet.getList(linfo1, 'table')
table1 = linfoTables[0]
table2 = linfoTables[1]
table3 = linfoTables[2]
table4 = linfoTables[3]
table5 = linfoTables[4]
table6 = linfoTables[5]

values = @ixNet.getAttribute(table1, '-values')
column = @ixNet.getAttribute(table1, '-columns')
puts("***************************************************")
for index in (0..(values.length-1)) do
    rowValue = values[index]
    for col in (0..(column.length-1)) do
        puts(column[col]+' '+ rowValue[col])
    end
end

values = @ixNet.getAttribute(table2, '-values')
column = @ixNet.getAttribute(table2, '-columns')
puts("***************************************************")
for index in (0..(values.length-1)) do
    rowValue = values[index]
    for col in (0..(column.length-1)) do
        puts(column[col]+' '+ rowValue[col])
    end
end

values = @ixNet.getAttribute(table3, '-values')
column = @ixNet.getAttribute(table3, '-columns')
puts("***************************************************")
for index in (0..(values.length-1)) do
    rowValue = values[index]
    for col in (0..(column.length-1)) do
        puts(column[col]+' '+ rowValue[col])
    end
end

values = @ixNet.getAttribute(table4, '-values')
column = @ixNet.getAttribute(table4, '-columns')
puts("***************************************************")
for index in (0..(values.length-1)) do
    rowValue = values[index]
    for col in (0..(column.length-1)) do
        puts(column[col]+' '+ rowValue[col])
    end
end

values = @ixNet.getAttribute(table5, '-values')
column = @ixNet.getAttribute(table5, '-columns')
puts("***************************************************")
for index in (0..(values.length-1)) do
    rowValue = values[index]
    for col in (0..(column.length-1)) do
        puts(column[col]+' '+ rowValue[col])
    end
end

values = @ixNet.getAttribute(table6, '-values')
column = @ixNet.getAttribute(table6, '-columns')
puts("***************************************************")
for index in (0..(values.length-1)) do
    rowValue = values[index]
    for col in (0..(column.length-1)) do
        puts(column[col]+' '+ rowValue[col])
    end
end
puts("***************************************************")

###############################################################################
# 4. Apply on the fly
###############################################################################
trillMCastMacGroupList = @ixNet.getList(trillRouter2, 'trillMCastMacGroupList')[0]
mvMcastAddrCount = @ixNet.getAttribute(trillMCastMacGroupList, '-mcastAddrCnt')

@ixNet.setAttribute(mvMcastAddrCount, '-pattern', 'singleValue')
@ixNet.setAttribute(mvMcastAddrCount + '/singleValue', '-value', 10)
@ixNet.commit()

globals = root + '/globals'
topology = globals + '/topology'
puts("Applying changes on the fly")

begin
    @ixNet.execute('applyOnTheFly', topology)
rescue
    puts("error in applying on the fly change")
end
sleep(5)

################################################################################
# 5. Configure L2-L3 traffic 
################################################################################
puts("Congfiguring L2-L3 Traffic Item")
trafficItem1 = @ixNet.add(root + '/traffic', 'trafficItem')
@ixNet.setMultiAttribute(trafficItem1, 
    '-name', 'Traffic Item 1',
    '-roundRobinPacketOrdering', 'false',
    '-trafficType', 'ethernetVlan',
    '-biDirectional', 1)
@ixNet.commit()

trafficItem1 = @ixNet.remapIds(trafficItem1)[0]
endpointSet1 = @ixNet.add(trafficItem1, 'endpointSet')
source = netGroup3
destination = netGroup4

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

@ixNet.setMultiAttribute(trafficItem1 + '/tracking',
    '-trackBy',        ['sourceDestEndpointPair0', 'trackingenabled0'],
    '-fieldWidth',     'thirtyTwoBits',
    '-protocolOffset', 'Root.0',
    '-values',         [])
@ixNet.commit()

###############################################################################
# 6. Apply and start L2/L3 traffic
###############################################################################
puts("applying L2/L3 traffic")
@ixNet.execute('apply', root + '/traffic')
sleep(5)

puts("starting L2/L3 traffic")
@ixNet.execute('start', root + '/traffic')

###############################################################################
# 7. Retrieve L2/L3 traffic item statistics
###############################################################################
puts('Verifying all the L2-L3 traffic stats')
viewPage = '::ixNet::OBJ-/statistics/view:"Flow Statistics"/page'
statcap =  @ixNet.getAttribute(viewPage, '-columnCaptions')
for statValList in @ixNet.getAttribute(viewPage, '-rowValues')
    for  statVal in statValList
        puts("***************************************************")
        index = 0
        for satIndv in statVal
            puts(statcap[index]+" "+satIndv)
            index = index + 1
        end
    end
end
puts("***************************************************")

################################################################################
# 8. Stop L2/L3 traffic
#################################################################################
puts('Stopping L2/L3 traffic')
@ixNet.execute('stop', @ixNet.getRoot() + '/traffic')
sleep(5)

################################################################################
# 9. Stop all protocols
################################################################################
puts('Stopping protocols')
@ixNet.execute('stopAllProtocols')
puts('!!! Test Script Ends !!!')
