################################################################################
# Version 1.0    $Revision: 1 $
#
#    Copyright © 1997 - 2006 by IXIA
#    All Rights Reserved.
#
#    Revision Log:
#    3-09-2007 : Mircea Hasegan
#
################################################################################

################################################################################
#                                                                              #
#                                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 user's 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 sample creates a Telnet client and server basic configuration.       #
#    The client and server networks are configured using IPSec.                #
#    Client is simulating the following commands: OPEN, LOGIN, PASSWORD, THINK #
#    and EXIT.                                                                 #
#    Telnet traffic is sent from clent side to server side.                    #
#    At the end statistics are being retrieved.                                #
#                                                                              #
# Module:                                                                      #
#    The sample was tested on a ALM1000T8 module.                              #
#                                                                              #
################################################################################

package require Ixia

set test_name [info script]

set chassisIP sylvester
set tclServer winston-400t
set port_list [list 4/1 4/2]

set error ""
catch {
set connect_status [::ixia::connect   \
        -reset                      \
        -device     $chassisIP      \
        -port_list  $port_list      \
        -username   ixiaApiUser     ]

if {[keylget connect_status status] != $::SUCCESS} {
    puts "FAIL - $test_name - [keylget connect_status log]"
}

set client_port [keylget \
        connect_status port_handle.$chassisIP.[lindex $port_list 0]]
set server_port [keylget \
        connect_status port_handle.$chassisIP.[lindex $port_list 1]]

################################################################################
# Client network
################################################################################
set client_network [::ixia::L47_network                 \
        -target                         client          \
        -property                       network       \
        -mode                           add              \
        -port_handle                    $client_port  \
        -grat_arp_enable                0             \
        -emulated_router_gateway        "155.0.0.2"   \
        -emulated_router_subnet         "255.255.0.0" \
        -mac_mapping_mode               macport       ]
        
if {[keylget client_network status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget client_network log]"
}
set client_network_handle [keylget client_network network_handle]

################################################################################
# Client network pool
################################################################################
set client_network_range [::ixia::L47_network             \
        -handle              $client_network_handle     \
        -property            network_pool               \
        -mode                add                        \
        -np_first_ip         "150.0.0.1"                \
        -np_network_mask     "255.255.0.0"              \
        -np_ip_incr_step     "0.0.0.1"                  \
        -np_ip_count         100                        \
        -np_range_type                  ipsec           \
        -np_role                        p2p_initiator   \
        -np_emulated_subnet             "140.0.0.0"     \
        -np_emulated_subnet_mask        "255.255.255.0" \
        -np_protected_subnet            "170.0.0.0"     \
        -np_protected_subnet_mask       "255.255.255.0" \
        -np_increment_by                "0.0.1.0"       \
        -np_peer_public_ip              "160.0.0.1"     \
        -np_emulated_hosts              1               \
        -np_pre_shared_key              "ixload"        \
        -np_ike_mode                    main            \
        -np_phase1_hash_algorithm       md5             \
        -np_dh_group                    dh2             \
        -np_phase1_encryption_algorithm 3des            \
        -np_phase1_lifetime             3600            \
        -np_ah_esp_options              esp             \
        -np_phase2_hash_algorithm       md5             \
        -np_phase2_encryption_algorithm 3des            \
        -np_phase2_lifetime             28800           \
        -np_enable_pfs                  0               \
        -np_num_retries                 0               \
        -np_retry_interval              10              \
        -np_retry_delay                 10              ]

if {[keylget client_network_range status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget client_network_range log]"
}
set client_network_range_handle [keylget client_network_range network_pool_handle]

################################################################################
# Client router pool
################################################################################
set client_network [::ixia::L47_network             \
        -handle            $client_network_handle \
        -target            client                  \
        -property          router_pool            \
        -mode              add                      \
        -rp_first_ip       "155.0.0.1"            \
        -rp_ip_count       1                      \
        -rp_first_mac      "00:9B:00:00:01:00"    ]
        
if {[keylget client_network status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget client_network log]"
}
set client_router_handle [keylget client_network router_pool_handle]

################################################################################
# Server network
################################################################################
set server_network [::ixia::L47_network                   \
        -target                         server           \
        -property                       network           \
        -mode                           add                   \
        -port_handle                    $server_port      \
        -grat_arp_enable                0               \
        -emulated_router_gateway        "155.0.0.1"     \
        -emulated_router_subnet         "255.255.0.0"   \
        -mac_mapping_mode               macport         ]


if {[keylget server_network status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget server_network log]"
}
set server_network_handle [keylget server_network network_handle]

################################################################################
# Server network pool
################################################################################
set server_network_range [::ixia::L47_network             \
        -handle             $server_network_handle      \
        -property           network_pool                \
        -mode               add                         \
        -np_first_ip        "160.0.0.1"                 \
        -np_network_mask    "255.255.0.0"               \
        -np_ip_incr_step    "0.0.0.1"                   \
        -np_ip_count        100                         \
        -np_range_type                  ipsec           \
        -np_role                        p2p_responder   \
        -np_emulated_subnet             "170.0.0.0"     \
        -np_emulated_subnet_mask        "255.255.255.0" \
        -np_protected_subnet            "140.0.0.0"     \
        -np_protected_subnet_mask       "255.255.255.0" \
        -np_increment_by                "0.0.1.0"       \
        -np_peer_public_ip              "150.0.0.1"     \
        -np_emulated_hosts              1               \
        -np_pre_shared_key              "ixload"        \
        -np_ike_mode                    main            \
        -np_phase1_hash_algorithm       md5             \
        -np_dh_group                    dh2             \
        -np_phase1_encryption_algorithm 3des            \
        -np_phase1_lifetime             3600            \
        -np_ah_esp_options              esp             \
        -np_phase2_hash_algorithm       md5             \
        -np_phase2_encryption_algorithm 3des            \
        -np_phase2_lifetime             28800           \
        -np_enable_pfs                  0               \
        -np_num_retries                 0               \
        -np_retry_interval              10              \
        -np_retry_delay                 10              ]

if {[keylget server_network_range status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget server_network_range log]"
}
set server_network_range_handle [keylget server_network_range network_pool_handle]

################################################################################
# Server router pool
################################################################################
set client_network [::ixia::L47_network             \
        -handle            $server_network_handle \
        -target            server                  \
        -property          router_pool            \
        -mode              add                      \
        -rp_first_ip       "155.0.0.2"            \
        -rp_ip_count       1                      \
        -rp_first_mac      "00:9B:00:00:02:00"    ]
        
if {[keylget client_network status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget client_network log]"
}
set server_router_handle [keylget client_network router_pool_handle]


################################################################################
# Server traffic agent
################################################################################
set server_agent [::ixia::L47_telnet_server       \
        -property             server              \
        -mode                 add                 \
        -close_command        exit                \
        -command_prompt       #                   \
        -echo_enable          1                   \
        -linemode_enable      1                   \
        -suppress_go_ahead    0                   \
        -listen_port          23                  ]

if {[keylget server_agent status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget server_agent log]"
}

set server_traffic_handle [keylget server_agent server_handle]
set server_agent_handle [keylget server_agent agent_handle]

################################################################################
# Server traffic-network mapping
################################################################################
set map_status [::ixia::L47_server_mapping                    \
        -mode                        add                    \
        -server_network_handle       $server_network_handle \
        -server_traffic_handle       $server_traffic_handle \
        -match_client_total_time     1                      \
        ]

if {[keylget map_status status] != $::SUCCESS} {
    return "FAIL - map_status - [keylget map_status log]"
}
set server_map1 [keylget map_status handles]

################################################################################
# Client agent
################################################################################
set client_agent [::ixia::L47_telnet_client             \
        -property               client                  \
        -mode                   add                     \
        -options_enable         1                       \
        -command_prompt         #                       \
        -expect_timeout         10                      ]

if {[keylget client_agent status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget client_agent log]"
}

set client_traffic_handle [keylget client_agent client_handle]
set client_agent_handle [keylget client_agent agent_handle]

################################################################################
# Client commands
################################################################################
set command_1 [::ixia::L47_telnet_client    \
        -handle       $client_agent_handle  \
        -property     command               \
        -mode         add                   \
        -c_id         open                  \
        -c_expect     login:                \
        -c_server_ip  "160.0.0.1"           ]

if {[keylget command_1 status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget command_1 log]"
}
set command_handle1 [keylget command_1 command_handle]

set command_2 [::ixia::L47_telnet_client \
        -handle     $client_agent_handle \
        -mode       add                  \
        -property   command              \
        -c_id       login                \
        -c_send     ixia                 \
        -c_expect   password:            ]

if {[keylget command_2 status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget command_2 log]"
}
set command_handle2 [keylget command_2 command_handle]

set command_3 [::ixia::L47_telnet_client  \
        -handle     $client_agent_handle  \
        -mode       add                   \
        -property   command               \
        -c_id       password              \
        -c_send     ixia                  \
        -c_expect   #                     ]

if {[keylget command_3 status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget command_3 log]"
}
set command_handle3 [keylget command_3 command_handle]

set command_4 [::ixia::L47_telnet_client      \
        -handle         $client_agent_handle  \
        -mode           add                   \
        -property       command               \
        -c_id           think                 \
        -c_max_interval 10000                 \
        -c_min_interval 10000                 ]

if {[keylget command_4 status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget command_4 log]"
}
set command_handle4 [keylget command_4 command_handle]

set command_5 [::ixia::L47_telnet_client\
        -handle    $client_agent_handle \
        -mode      add                  \
        -property  command              \
        -c_id      exit                 \
        -c_send    exit                 ]

if {[keylget command_5 status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget command_5 log]"
}
set command_handle5 [keylget command_5 command_handle]

################################################################################
# Client traffic-network mapping
################################################################################
set map_status [::ixia::L47_client_mapping                         \
        -mode                           add                      \
        -client_network_handle          $client_network_handle   \
        -client_traffic_handle          $client_traffic_handle   \
        -objective_type                 users                    \
        -objective_value                20                       \
        -ramp_up_value                  5                        \
        -sustain_time                   20                       \
        -ramp_down_time                 20                       \
        -agent_handle                   $client_agent_handle     \
        -objective_type_for_activity    crate                    \
        -objective_value_for_activity   200                      \
        -port_map_for_activity          mesh                     ]

if {[keylget map_status status] != $::SUCCESS} {
    return "FAIL - map_status - [keylget map_status log]"
}
set client_map1 [keylget map_status handles]


################################################################################
# Test settings
################################################################################

set results_dir [pwd]/results/[clock seconds]
set control_status [::ixia::L47_test                  \
        -mode                           add           \
        -map_handle                     [list         \
                            $client_map1 $server_map1]\
        -force_ownership_enable         1             \
        -reset_ports_enable             1             \
        -stats_required                 0             \
        -results_dir_enable             1             \
        -results_dir                    $results_dir  ]

if {[keylget control_status status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget control_status log]"
}
set test_handle [keylget control_status handles]

################################################################################
# Client statistics
################################################################################
set client_stats_list {
    telnet_active_conn
    telnet_total_conn_requested
    telnet_total_conn_succeeded
    telnet_total_conn_failed
    telnet_total_bytes_sent
    telnet_total_bytes_received
    telnet_total_bytes_sent_and_received
}
set stats_result [::ixia::L47_stats                \
        -mode                 add                  \
        -aggregation_type     sum                  \
        -stat_name            $client_stats_list   \
        -stat_type            client               \
        -protocol             telnet               ]

if {[keylget stats_result status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget stats_result log]"
}
set client_stat_handle [keylget stats_result handles]

################################################################################
# Server statitics
################################################################################
set server_stats_list {
    telnet_active_conn
    telnet_total_accepted_conn
    telnet_total_bytes_sent
    telnet_total_bytes_received
}

set stats_result [::ixia::L47_stats   \
        -mode                 add                  \
        -aggregation_type     sum                  \
        -stat_name            $server_stats_list   \
        -stat_type            server               \
        -protocol             telnet               ]

if {[keylget stats_result status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget stats_result log]"
}
set server_stat_handle [keylget stats_result handles]

################################################################################
# Start test
################################################################################
set control_status [::ixia::L47_test \
        -handle    $test_handle      \
        -mode      start             ]

if {[keylget control_status status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget control_status log]"
}


################################################################################
# Get statistics
################################################################################
set client_stats_result [::ixia::L47_stats       \
        -mode   get                              \
        -handle $client_stat_handle              ]

if {[keylget client_stats_result status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget client_stats_result log]"
}

set server_stats_result [::ixia::L47_stats \
        -mode   get                              \
        -handle $server_stat_handle              ]

if {[keylget server_stats_result status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget server_stats_result log]"
}

################################################################################
# Print client statistics
################################################################################

# The stat_required variable can be changed to print only one of the statistics
# e.g set stat_required ftp_file_downloads_requested

set stat_required "all"
puts "CLIENT STATISTICS:"
foreach {stat_handle} [keylkeys client_stats_result] {
    if {$stat_handle != "status"} {
        set stat_handle_kl [keylget client_stats_result $stat_handle]
        foreach {stat_type} [keylkeys stat_handle_kl] {
            set stat_type_kl [keylget stat_handle_kl $stat_type]
            foreach {stat_name} [keylkeys stat_type_kl] {
                if {$stat_name != $stat_required && $stat_required != "all" } {
                        continue
                }
                set stat_name_kl [keylget stat_type_kl $stat_name]
                foreach {time_stamp} $stat_name_kl {
                    foreach {key value} $time_stamp {
                        if {$key == ""} { set key N/A }
                        if {$value == ""} { set value N/A }
                        puts  -nonewline [format \
                                "%10s %10s %40s" $stat_handle $stat_type $stat_name]
                        
                        puts [format "%15s %15s" $key $value]
                    }
                }                
            }
        }
    }
}


################################################################################
# Print server statistics
################################################################################
set stat_required "all"
puts "Server STATISTICS:"
foreach {stat_handle} [keylkeys server_stats_result] {
    if {$stat_handle != "status"} {
        set stat_handle_kl [keylget server_stats_result $stat_handle]
        foreach {stat_type} [keylkeys stat_handle_kl] {
            set stat_type_kl [keylget stat_handle_kl $stat_type]
            foreach {stat_name} [keylkeys stat_type_kl] {
                if {$stat_name != $stat_required && $stat_required != "all" } {
                        continue
                }
                set stat_name_kl [keylget stat_type_kl $stat_name]
                foreach {time_stamp} $stat_name_kl {
                    foreach {key value} $time_stamp {
                        if {$key == ""} { set key N/A }
                        if {$value == ""} { set value N/A }
                        puts  -nonewline [format \
                                "%10s %10s %40s" $stat_handle $stat_type $stat_name]
                        
                        puts [format "%15s %15s" $key $value]
                    }
                }                
            }
        }
    }
}
} error
 
set cleanup_status [::ixia::cleanup_session ]

if {[keylget cleanup_status status] != $::SUCCESS} {
    return "FAIL - $test_name - [keylget cleanup_status log]"
}

return "SUCCESS - $test_name - [clock format [clock seconds]]"