################################################################################
# Version 1.0    $Revision: #1 $                                                #
#                                                                              #
#    Copyright  1997 - 2015 by IXIA                                            #
#    All Rights Reserved.                                                      #
#                                                                              #
#    Revision Log:                                                             #
#    01/19/2015 - Rupam Paul   - created sample                                #
#                                                                              #
################################################################################

################################################################################
#                                                                              #
#                                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 PIM API.               #
#                                                                              #
#    1. It will create 2 PIM topologies and Ipv4 Prefix Pool under             #
#       the network group(NG)                                                  #
#    2. Start the pim protocol.                                                #
#    3. Retrieve protocol statistics.                                          #
#    4. Retrieve protocol learned info.                                        #
#    5. Modify the Range type from "*G" to "SG" in the First and Second PIM    #
#       router.And apply changes On The Fly (OTF)                              #
#    6. Retrieve protocol learned info again and notice the difference with    #
#       previously retrieved learned info.                                     #
#    7. Configure L2-L3 traffic.                                               #
#    8. Start the L2-L3 traffic.                                               #
#    9. Retrieve L2-L3 traffic stats                                           #
#   10. Stop L2-L3 traffic.                                                    #
#   11. Stop all protocols.                                                    #
#                                                                              #
# Ixia Software:                                                               #
#    IxOS      6.80  EA                                                        #
#    IxNetwork 7.40  EA                                                        #
#                                                                              #
################################################################################

################################################################################
# Utilities                                                                    #
################################################################################

# Libraries to be included
# package require Ixia
# Other procedures used in the script, that do not use HL API configuration/control procedures

# Running from Linux:

	 #use lib ".";
	 #use lib "..";
	 #use lib "../..";
	 #use lib "/root/hltapi/library/common/ixia_hl_lib-7.30";
	 #use lib "/root/hltapi/library/common/ixiangpf/perl";
	 #use lib "/root/ixos/lib/PerlApi";
	 #use ixiahlt {TclAutoPath => ['/root/ixos/lib','/root/hltapi']};
        #use ixiahlt {IXIA_VERSION => $ENV{'IXIA_VERSION'}, TclAutoPath  => [$ENV{'PERL_IXOS_LIB_PATH'}, $ENV{'PERL_IXNET_LIB_PATH'}]};


# Running from Windows: 

	# use lib "C:/Program Files (x86)/Ixia/hltapi/4.95.117.44/TclScripts/lib/hltapi/library/common/ixia_hl_lib-7.40";
	# use lib "C:/Program Files (x86)/Ixia/hltapi/4.95.117.44/TclScripts/lib/hltapi/library/common/ixiangpf/perl";

# Loading Ixia packages
use ixiangpf;

use warnings;
use strict;
use bignum;
use Carp;

# Using a hash reference for the HLP procedures (since they return values in form of hashes)
our $HashRef = {};
#Using a common variable to retain the status of each command
our $command_status = '';

my $_result_ = '';
my $_control_status_ = '';
my $_dhcp_stats_ = '';
my @status_keys = ();

################################################################################
# Connection to the chassis, IxNetwork Tcl Server                              #
################################################################################
my @chassis             = ('10.205.28.170');
my $tcl_server          = '10.205.28.170';
my @port_list           = ([ '1/5', '1/6' ]);
my $ixNetwork_client    = '10.205.28.41:8982';

print "Connecting to chassis and client\n";
$_result_ = ixiangpf::connect({
    reset                   => 1,
    device                  => @chassis,
    port_list               => @port_list,
    ixnetwork_tcl_server    => $ixNetwork_client,
    tcl_server              => $tcl_server,
    break_locks             => 1,
});
@status_keys = ixiangpf::status_item_keys();
$command_status = ixiangpf::status_item('status');
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}

# Saving the port handles, which will be used later on in the script
my $port_handles = ixiangpf::status_item('vport_list');
my @port_handles_list = split(/ /,$port_handles);


################################################################################
# Creating topology and device group                                           #
################################################################################

# Creating a topology on first port
print "Adding topology 1 on port 1\n";     
my $topology_1_status = ixiangpf::topology_config ({
    topology_name      => "{PIM Topology 1}",
    port_handle        => $port_handles_list[0],
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
	my $error = ixiangpf::status_item('log');
	print "Error: $error";
	return "FAILED - $error";
}
my $topology_1_handle = $HashRef->{'topology_handle'};

# Creating a device group in topology 
print "Creating device group 1 in topology 1\n";      
my $device_group_1_status = ixiangpf::topology_config ({
    topology_handle              => "$topology_1_handle",
    device_group_name            => "{Device Group 1}",
    device_group_multiplier      => "1",
    device_group_enabled         => "1",
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $deviceGroup_1_handle = $HashRef->{'device_group_handle'};
    

# Creating a topology on second port
print "Adding topology 2 on port 2\n";
my $topology_2_status = ixiangpf::topology_config ({
    topology_name      => "{PIM Topology 2}",
    port_handle        => $port_handles_list[1],
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $topology_2_handle = $HashRef->{'topology_handle'};

# Creating a device group in topology
print "Creating device group 2 in topology 2\n";
my $device_group_2_status = ixiangpf::topology_config ({
    topology_handle              => "$topology_2_handle",
    device_group_name            => "{Device Group 2}",
    device_group_multiplier      => "1",
    device_group_enabled         => "1",
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $deviceGroup_2_handle = $HashRef->{'device_group_handle'};

################################################################################
#  Configure protocol interfaces                                               #
################################################################################

# Creating ethernet stack for the first Device Group 
print "Creating ethernet stack for the first Device Group\n";
my $ethernet_1_status = ixiangpf::interface_config ({
    protocol_name                => "{Ethernet 1}",
    protocol_handle              => "$deviceGroup_1_handle",
    mtu                          => "1500",
    src_mac_addr                 => "18.03.73.c7.6c.b1",
    src_mac_addr_step            => "00.00.00.00.00.00",
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $ethernet_1_handle = $HashRef->{'ethernet_handle'};

# Creating ethernet stack for the second Device Group
print "Creating ethernet for the second Device Group\n";
my $ethernet_2_status = ixiangpf::interface_config ({
    protocol_name                => "{Ethernet 2}",
    protocol_handle              => "$deviceGroup_2_handle",
    mtu                          => "1500",
    src_mac_addr                 => "18.03.73.c7.6c.01",
    src_mac_addr_step            => "00.00.00.00.00.00",
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $ethernet_2_handle = $HashRef->{'ethernet_handle'};

# Creating IPv4 Stack on top of Ethernet Stack for the first Device Group                                 
print "Creating IPv4 Stack on top of Ethernet Stack for the first Device Group\n";     
my $ipv4_1_status = ixiangpf::interface_config ({
    protocol_name                     => "{IPv4 1}",
    protocol_handle                   => "$ethernet_1_handle",
    ipv4_resolve_gateway              => "1",
    ipv4_manual_gateway_mac           => "00.00.00.00.00.01",
    ipv4_manual_gateway_mac_step      => "00.00.00.00.00.00",
    gateway                           => "20.20.20.1",
    gateway_step                      => "0.0.0.0",
    intf_ip_addr                      => "20.20.20.2",
    intf_ip_addr_step                 => "0.0.0.0",
    netmask                           => "255.255.255.0",
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $ipv4_1_handle = $HashRef->{'ipv4_handle'};

# Creating IPv4 Stack on top of Ethernet Stack for the second Device Group 
print "Creating IPv4 2 stack on ethernet 2 stack for the second Device Group\n";
my $ipv4_2_status = ixiangpf::interface_config ({
    protocol_name                     => "{IPv4 2}",
    protocol_handle                   => "$ethernet_2_handle",
    ipv4_resolve_gateway              => "1",
    ipv4_manual_gateway_mac           => "00.00.00.00.00.01",
    ipv4_manual_gateway_mac_step      => "00.00.00.00.00.00",
    gateway                           => "20.20.20.2",
    gateway_step                      => "0.0.0.0",
    intf_ip_addr                      => "20.20.20.1",
    intf_ip_addr_step                 => "0.0.0.0",
    netmask                           => "255.255.255.0",
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $ipv4_2_handle = $HashRef->{'ipv4_handle'};


################################################################################
# Other protocol configurations                                                # 
################################################################################

# This will Create PIMv4 Stack on top of IPv4 Stack of Topology1

print "Creating PIMv4 Stack on top of IPv4 1 stack\n";
my $pim_v4_interface_1_status = ixiangpf::emulation_pim_config ({
    mode                           => "create",
    handle                         => "$ipv4_1_handle",
    ip_version                     => "4",
    });
		
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4Interface_1_handle = $HashRef->{'pim_v4_interface_handle'};

#Creating Multicast Group address

print "Creating Multicast Group address\n";
my $pim_v4_join_prune_list_2_status = ixiangpf::emulation_multicast_group_config ({
    mode               => "create",
    ip_addr_start      => "226.0.0.0",
    num_groups         => "1",
    active             => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}

my $pimV4JoinPruneList_1_handle_group = $HashRef->{'multicast_group_handle'};
        
#Creating Multicast Source address

print "Creating Multicast Source address\n";	
my $pim_v4_join_prune_list_3_status = ixiangpf::emulation_multicast_source_config ({
    mode               => "create",
    ip_addr_start      => "0.0.0.1",
    num_sources        => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4JoinPruneList_1_handle_source = $HashRef->{'multicast_source_handle'};
	
#Creating PIM Join-Prune List
print "Creating Join Prune List\n";	
my $pim_v4_join_prune_list_4_status = ixiangpf::emulation_pim_group_config ({
    mode                               => "create",
    session_handle                     => "$pimV4Interface_1_handle",
    group_pool_handle                  => "$pimV4JoinPruneList_1_handle_group",
    source_pool_handle                 => "$pimV4JoinPruneList_1_handle_source",
    rp_ip_addr                         => "60.60.60.1",
    group_pool_mode                    => "send",
    join_prune_aggregation_factor      => "1",
    flap_interval                      => "60",
    register_stop_trigger_count        => "10",
    source_group_mapping               => "fully_meshed",
    switch_over_interval               => "5",
    group_range_type                   => "startogroup",
    enable_flap_info                   => "false",
    prune_source_address               => "0.0.0.0",
    prune_source_mask_width            => "32",
    prune_source_address_count         => "0",
    join_prune_group_mask_width        => "32",
    join_prune_source_mask_width       => "32",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4JoinPruneList_1_handle = $HashRef->{'pim_v4_join_prune_handle'};
 
#Creating Multicast Group address

print "Creating Multicast Group address\n"; 
my $pim_v4_sources_list_2_status = ixiangpf::emulation_multicast_group_config ({
    mode               => "create",
    ip_addr_start      => "225.0.0.0",
    num_groups         => "1",
    });
	$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4SourcesList_1_handle_group = $HashRef->{'multicast_group_handle'};
	
#Creating Multicast Source address

print "Creating Multicast Source address\n"; 
my $pim_v4_sources_list_3_status = ixiangpf::emulation_multicast_source_config ({
    mode               => "create",
    ip_addr_start      => "0.0.0.1",
    num_sources        => "1",
    active             => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4SourcesList_1_handle_source = $HashRef->{'multicast_source_handle'};
	
#Creating PIM Source List
 
print "Creating PIM Source List\n";  
my $pim_v4_sources_list_4_status = ixiangpf::emulation_pim_group_config ({
    mode                               => "create",
    session_handle                     => "$pimV4Interface_1_handle",
    group_pool_handle                  => "$pimV4SourcesList_1_handle_group",
    source_pool_handle                 => "$pimV4SourcesList_1_handle_source",
    rp_ip_addr                         => "0.0.0.0",
    group_pool_mode                    => "register",
    register_tx_iteration_gap          => "30000",
    register_udp_destination_port      => "3000",
    register_udp_source_port           => "3000",
    switch_over_interval               => "0",
    send_null_register                 => "0",
    discard_sg_join_states             => "true",
    multicast_data_length              => "64",
    supression_time                    => "60",
    register_probe_time                => "5",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4SourcesList_1_handle = $HashRef->{'pim_v4_source_handle'};
  
#Creating Group Address for Candidate RP 

print "Creating Group Address for Candidate RP\n"; 
my $pim_v4_candidate_r_ps_list_1_status = ixiangpf::emulation_multicast_group_config ({
    mode               => "create",
    ip_addr_start      => "225.0.0.0",
    num_groups         => "1",
    active             => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4CandidateRPsList_1_handle = $HashRef->{'multicast_group_handle'};
		
#Creating PIM Candidate RP List
  
print "Creating PIM Candidate RP List\n";  
my $pim_v4_candidate_r_ps_list_2_status = ixiangpf::emulation_pim_group_config ({
    mode                       => "create",
    session_handle             => "$pimV4Interface_1_handle",
    group_pool_handle          => "$pimV4CandidateRPsList_1_handle",
    adv_hold_time              => "150",
    back_off_interval          => "3",
    crp_ip_addr                => "0.0.0.1",
    group_pool_mode            => "candidate_rp",
    periodic_adv_interval      => "60",
    pri_change_interval        => "60",
    pri_type                   => "same",
    pri_value                  => "180",
    router_count               => "1",
    source_group_mapping       => "fully_meshed",
    trigger_crp_msg_count      => "3",
    crp_group_mask_len         => "32",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
$pimV4CandidateRPsList_1_handle = $HashRef->{'pim_v4_candidate_rp_handle'};
		
# Creating and Adding IPv4-prefix pool under Network Group1

print "Creating ipv4 prefix network address\n";
my $multivalue_2_status = ixiangpf::multivalue_config ({
    pattern                => "counter",
    counter_start          => "200.1.0.0",
    counter_step           => "0.1.0.0",
    counter_direction      => "increment",
    nest_step              => "0.0.0.1,0.1.0.0",
    nest_owner             => "$deviceGroup_1_handle,$topology_1_handle",
    nest_enabled           => "0,1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $multivalue_2_handle = $HashRef->{'multivalue_handle'};

print "Creating and Adding IPv4-prefix pool under Network Group1\n";	
my $network_group_1_status = ixiangpf::network_group_config ({
    protocol_handle                      => "$deviceGroup_1_handle",
    protocol_name                        => "{Network Group 1}",
    multiplier                           => "1",
    enable_device                        => "1",
    connected_to_handle                  => "$ethernet_1_handle",
    type                                 => "ipv4-prefix",
    ipv4_prefix_network_address          => "$multivalue_2_handle",
    ipv4_prefix_length                   => "24",
    ipv4_prefix_number_of_addresses      => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $networkGroup_1_handle = $HashRef->{'network_group_handle'};
my $ipv4PrefixPools_1_handle = $HashRef->{'ipv4_prefix_pools_handle'};
               
# This will Create PIMv4 Stack on top of IPv4 Stack of Topology1

print "Creating PIMv4 Stack on top of IPv4 Stack of Topology2\n";	 
my $pim_v4_interface_2_status = ixiangpf::emulation_pim_config ({
    mode                           => "create",
    handle                         => "$ipv4_2_handle",
    ip_version                     => "4",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4Interface_2_handle = $HashRef->{'pim_v4_interface_handle'};
 
#Creating Multicast Group address

print "Creating Multicast Group address\n"; 
my $pim_v4_join_prune_list_6_status = ixiangpf::emulation_multicast_group_config ({
    mode               => "create",
    ip_addr_start      => "226.0.0.0",
    num_groups         => "1",
    active             => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4JoinPruneList_5_handle_group = $HashRef->{'multicast_group_handle'};
	
#Creating Multicast Source address

print "Creating Multicast Source address\n";       
my $pim_v4_join_prune_list_7_status = ixiangpf::emulation_multicast_source_config ({
    mode               => "create",
    ip_addr_start      => "0.0.0.1",
    num_sources        => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4JoinPruneList_5_handle_source = $HashRef->{'multicast_source_handle'};
		
#Creating PIM Join Prune List

print "Creating PIM Join Prune List\n";       
my $pim_v4_join_prune_list_8_status = ixiangpf::emulation_pim_group_config ({
    mode                               => "create",
    session_handle                     => "$pimV4Interface_2_handle",
    group_pool_handle                  => "$pimV4JoinPruneList_5_handle_group",
    source_pool_handle                 => "$pimV4JoinPruneList_5_handle_source",
    rp_ip_addr                         => "60.60.60.1",
    group_pool_mode                    => "send",
    join_prune_aggregation_factor      => "1",
    flap_interval                      => "60",
    register_stop_trigger_count        => "10",
    source_group_mapping               => "fully_meshed",
    switch_over_interval               => "5",
    group_range_type                   => "startogroup",
    enable_flap_info                   => "false",
    prune_source_address               => "0.0.0.0",
    prune_source_mask_width            => "32",
    prune_source_address_count         => "0",
    join_prune_group_mask_width        => "32",
    join_prune_source_mask_width       => "32",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4JoinPruneList_2_handle = $HashRef->{'pim_v4_join_prune_handle'};

#Creating Group address for Join-Prune list 

print "Creating Group address for Join-Prune list\n";       
my $pim_v4_sources_list_6_status = ixiangpf::emulation_multicast_group_config ({
    mode               => "create",
    ip_addr_start      => "225.0.0.0",
    num_groups         => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4SourcesList_5_handle_group = $HashRef->{'multicast_group_handle'};

#Creating Source address for Join-Prune list 

print "Creating Source address for Join-Prune list\n";         
my $pim_v4_sources_list_7_status = ixiangpf::emulation_multicast_source_config ({
    mode               => "create",
    ip_addr_start      => "0.0.0.1",
    num_sources        => "1",
    active             => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4SourcesList_5_handle_source = $HashRef->{'multicast_source_handle'};
	
#Creating PIM Source List
 
print "Creating PIM Source List\n"; 
my $pim_v4_sources_list_8_status = ixiangpf::emulation_pim_group_config ({
    mode                               => "create",
    session_handle                     => "$pimV4Interface_2_handle",
    group_pool_handle                  => "$pimV4SourcesList_5_handle_group",
    source_pool_handle                 => "$pimV4SourcesList_5_handle_source",
    rp_ip_addr                         => "0.0.0.0",
    group_pool_mode                    => "register",
    register_tx_iteration_gap          => "30000",
    register_udp_destination_port      => "3000",
    register_udp_source_port           => "3000",
    switch_over_interval               => "0",
    send_null_register                 => "0",
    discard_sg_join_states             => "true",
    multicast_data_length              => "64",
    supression_time                    => "60",
    register_probe_time                => "5",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4SourcesList_5_handle = $HashRef->{'pim_v4_source_handle'};

#Creating Group Address for Candidate RP

print "Creating Group Address for Candidate RP\n";
my $pim_v4_candidate_r_ps_list_3_status = ixiangpf::emulation_multicast_group_config ({
    mode               => "create",
    ip_addr_start      => "225.0.0.0",
    num_groups         => "1",
    active             => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $pimV4CandidateRPsList_3_handle = $HashRef->{'multicast_group_handle'};
	
#Creating PIM Candidate RP List      
 
print "Creating PIM Candidate RP List\n"; 
my $pim_v4_candidate_r_ps_list_4_status = ixiangpf::emulation_pim_group_config ({
    mode                       => "create",
    session_handle             => "$pimV4Interface_2_handle",
    group_pool_handle          => "$pimV4CandidateRPsList_3_handle",
    adv_hold_time              => "150",
    back_off_interval          => "3",
    crp_ip_addr                => "0.0.0.1",
    group_pool_mode            => "candidate_rp",
    periodic_adv_interval      => "60",
    pri_change_interval        => "60",
    pri_type                   => "same",
    pri_value                  => "190",
    router_count               => "1",
    source_group_mapping       => "fully_meshed",
    trigger_crp_msg_count      => "3",
    crp_group_mask_len         => "32",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
$pimV4CandidateRPsList_3_handle = $HashRef->{'pim_v4_candidate_rp_handle'};
	
# Creating and Adding IPv4-prefix pool under Network Group2

print "Creating ipv4 prefix network address\n";
my $multivalue_4_status = ixiangpf::multivalue_config ({
    pattern                => "counter",
    counter_start          => "201.1.0.0",
    counter_step           => "0.1.0.0",
    counter_direction      => "increment",
    nest_step              => "0.0.0.1,0.1.0.0",
    nest_owner             => "$deviceGroup_2_handle,$topology_2_handle",
    nest_enabled           => "0,1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $multivalue_4_handle = $HashRef->{'multivalue_handle'};

print "Creating and Adding IPv4-prefix pool under Network Group2\n";    
my $network_group_2_status = ixiangpf::network_group_config ({
    protocol_handle                      => "$deviceGroup_2_handle",
    protocol_name                        => "{Network Group 2}",
    multiplier                           => "1",
    enable_device                        => "1",
    connected_to_handle                  => "$ethernet_2_handle",
    type                                 => "ipv4-prefix",
    ipv4_prefix_network_address          => "$multivalue_4_handle",
    ipv4_prefix_length                   => "24",
    ipv4_prefix_number_of_addresses      => "1",
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
my $networkGroup_2_handle = $HashRef->{'network_group_handle'};
my $ipv4PrefixPools_2_handle = $HashRef->{'ipv4_prefix_pools_handle'};
	
############################################################################
# Start PIM protocol                                                       #
############################################################################
	
print "Waiting 5 seconds before starting protocol(s) ...\n";
sleep(5);
	
print "Starting All Protocols\n";

my $startProtocol = ixiangpf::test_control({action => 'start_all_protocols'});
@status_keys = ixiangpf::status_item_keys();
$command_status = ixiangpf::status_item('status');
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
	
print "Waiting for 60 Seconds\n";
sleep(60);
	
############################################################################
# Retrieve protocol statistics                                             # 
############################################################################
print "fetching pimv4 aggregated statistics\n";
my $protostats = ixiangpf::emulation_pim_info({
    handle => $pimV4Interface_2_handle,
    mode   => 'aggregate'
}); 
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
@status_keys = ixiangpf::status_item_keys();
foreach (@status_keys) {
    my $my_key = $_;
    my $allStats = ixiangpf::status_item($my_key);
    print "==================================================================\n";
    print "\n$my_key: $allStats\n\n";
    print "==================================================================\n";
}
      	
############################################################################
# Retrieve protocol learned info                                           #
############################################################################
print "Fetching pim learned info";
$protostats = ixiangpf::emulation_pim_info({
    handle => $pimV4Interface_1_handle,
    mode   => 'learned_crp'
}); 
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
@status_keys = ixiangpf::status_item_keys();
foreach (@status_keys) {
    my $my_key = $_;
    my $learnedinfo = ixiangpf::status_item($my_key);
    print "==================================================================\n";
    print "\n$my_key: $learnedinfo\n\n";
    print "==================================================================\n";
}
 	
############################################################################
# Modifying the GroupRange Type from *G to SG and Enabling Bootstrap       #
############################################################################

#Modifying the GroupRange Type from *G to SG for Topology1
print "Modifying the GroupRange Type from *G to SG for Topology1"; 

my $modify1 = ixiangpf::emulation_pim_group_config ({
        handle                   => $pimV4JoinPruneList_1_handle,
        mode                     => 'modify',
        group_range_type         => 'sourcetogroup',
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}

#Modifying the GroupRange Type from *G to SG for Topology2
print "Modifying the GroupRange Type from *G to SG for Topology2\n";
 
my $modify2 = ixiangpf::emulation_pim_group_config ({
        handle                   => $pimV4JoinPruneList_2_handle,
        mode                     => 'modify',
        group_range_type         => 'sourcetogroup',
    });
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}

#Enabling Bootstrap for Topology1   	
print "Enabling Bootstrap for Topology1\n";

my $modify3 = ixiangpf::emulation_pim_config ({
        handle            => $pimV4Interface_1_handle,                                    
        mode              => 'modify',
        ip_version        => '4',                                                      
        bootstrap_enable  =>  '1',
		});
		
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
	
#Enabling Bootstrap and Modifying Priority for Topology2
print "Enabling Bootstrap and Modifying Priority for Topology2\n";

my $modify4 = ixiangpf::emulation_pim_config ({
        handle             => $pimV4Interface_2_handle,                                    
        mode               => 'modify',
        ip_version         => '4',                                                      
        bootstrap_enable   => '1',
		bootstrap_priority => '74',
		});
		
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}

#Applying changes on the fly		
print "Applying changes on the fly\n";
my $applyChanges = ixiangpf::test_control({
   handle => $pimV4Interface_1_handle,
   action => 'apply_on_the_fly_changes',
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}   

print "Applying changes on the fly\n";
my $applyChanges = ixiangpf::test_control({
   handle => $pimV4Interface_2_handle,
   action => 'apply_on_the_fly_changes',
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}

print "Waiting for 60 seconds\n";
sleep(60);
	
############################################################################
# Retrieve protocol learned info again after RangeType modification        #
############################################################################
print "Fetching pim learned info\n";
$protostats = ixiangpf::emulation_pim_info({
    handle => $pimV4Interface_1_handle,
    mode   => 'learned_crp'
}); 
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
@status_keys = ixiangpf::status_item_keys();
foreach (@status_keys) {
    my $my_key = $_;
    my $learnedinfo = ixiangpf::status_item($my_key);
    print "==================================================================\n";
    print "\n$my_key: $learnedinfo\n\n";
    print "==================================================================\n";
}
	
############################################################################ 
# Configure L2-L3 traffic                                                  #
# 1. Endpoints : Source->IPv4, Destination->Multicast group                #
# 2. Type      : Multicast IPv4 traffic                                    #
# 3. Flow Group: On IPv4 Destination Address                               #
# 4. Rate      : 1000 packets per second                                   #
# 5. Frame Size: 512 bytes                                                 #
# 6. Tracking  : IPv4 Destination Address                                  #	
############################################################################

print "Configuring L2-L3 traffic\n";
$_result_ = ixiangpf::traffic_config({
    mode                                        => 'create',
    traffic_generator                           => 'ixnetwork_540',
    endpointset_count                           => 1,
    emulation_src_handle                        => $ipv4PrefixPools_1_handle,
    emulation_dst_handle                        => $ipv4PrefixPools_2_handle,
    name                                        => 'Traffic_Item_1',
    circuit_endpoint_type                       => 'ipv4',
    transmit_distribution                       => 'ipv4DestIp0',                             
    rate_pps                                    => 1000,                                    
    frame_size                                  => 512,
    track_by                                    => 'trackingenabled0 ipv4DestIp0'
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
	
############################################################################
#  Start L2-L3 traffic configured earlier                                  #
############################################################################
print "Running Traffic...\n";
$_result_ = ixiangpf::traffic_control({
    action              => 'run',
    traffic_generator   => 'ixnetwork_540',
    type                => 'l23',
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}

print "Let the traffic run for 20 seconds ...\n";
sleep(20);
	
	   
############################################################################                                 
# Retrieve L2-L3 traffic stats                                             #
############################################################################
print "Retrieving L2-L3 traffic stats\n";
$protostats = ixiangpf::traffic_stats({
    mode              => 'all',
    traffic_generator => 'ixnetwork_540',
    measure_mode      => 'mixed',
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}   
@status_keys = ixiangpf::status_item_keys();
 foreach (@status_keys) {
    my $my_key = $_;
    my $allStats = ixiangpf::status_item($my_key);
    print "==================================================================\n";
    print "\n$my_key: $allStats\n\n";
    print "==================================================================\n";
 }
  
############################################################################
# Stop L2-L3 traffic started earlier                                       #
############################################################################
print "Stopping Traffic...\n";

$_result_ = ixiangpf::traffic_control({
    action            => 'stop',
    traffic_generator => 'ixnetwork_540',
    type              => 'l23',
});
$HashRef = ixiangpf::get_result_hash();
$command_status = $HashRef->{'status'};
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
sleep(5);
   
############################################################################
# Stop all protocols                                                       #
############################################################################
print "Stopping all protocol(s) ...\n";
my $stopProtocol = ixiangpf::test_control({action => 'stop_all_protocols'});
@status_keys = ixiangpf::status_item_keys();
$command_status = ixiangpf::status_item('status');
if ($command_status != $ixiangpf::SUCCESS) {
    my $error = ixiangpf::status_item('log');
    print "Error: $error";
    return "FAILED - $error";
}
sleep(2);

print "!!! Test Script Ends !!!\n";           
print "SUCCESS - $0\n";