Man: Function Reference

---

  ______ ___    ____  ______
 /_  __//   |  / __ \/ ____/ [T]estbed for
  / /  / /| | / /_/ / __/    [A]d-Hoc
 / /  / ___ |/ ____/ /___    [P]rotocol
/_/  /_/  |_/_/   /_____/    [E]valuation

---

List of all the function is test script (start_test/_cable):

Startup function:

name: ape_startup() 
    : Prepare for the test.
    : ape_startup

name: ape_generate_ip2mac() 
    : Request others node’s MAC address This is required for ape_mac_disable() 
      and ape_mac_enable() to work.
    : ape_generate_ip2mac

Shutdown Function

name: ape_copy_files()  
    : Copy all log file from /var/log to $LOG_WRITE_PATH.
    : ape_copy_files

name: ape_pack_files()  
    : Tar and gz  all the log file in $LOG_WRITE_PATH. 
    : ape_pack_files

Testing Function

name: ape_mac_disable() 
    : Drop the packet coming from specific node.
    : ape_mac_disable <nd> <nd>..

    <nd> : node number
    (required ape_generate_ip2mac()  been initialization first to work)

name: ape_mac_enable()  
    : Enable back packet coming from specific node after ape_mac_disable() 
      disable it.
    : ape_mac_enable <nd> <nd>..

    <nd> : node number
    (required ape_generate_ip2mac()  been initialization first to work)

name: ape_tcpdump() 
    : Dump traffic on a network. 
    : ape_tcpdump -s  <snaplen>

    <snaplen>:  Snarf snaplen bytes of data from each packet rather than the 
                default of 65535 bytes.

name: ape_ping_node()   
    : Send ICMP ECHO_REQUEST to network hosts.
    : ape_ping_node <nd> <count> <packetsize> <timeout>

    <nd> : node number.

    <count> : Stop after sending count ECHO_REQUEST packets. With deadline 
              option, ping waits for count ECHO_REPLY packets, until the 
              timeout expires.

    <packetsize> : Specifies the number of data bytes to be sent. The default 
                   is 56, which translates into 64 ICMP data bytes when combined
                   with the 8 bytes of ICMP header data.

    <timeout> : Specify a timeout, in seconds, before ping exits regardless 
                of how many packets have been sent or received. In this case 
                ping does not stop after count packet are sent, it waits either 
                for deadline expire or until count probes are answered or for 
                some error notification from network.

name: ape_iperf()   
    : Measuring maximum TCP and UDP bandwidth and performing network 
      throughput tests.
    : ape_iperf  [-s|-c host] [-p port] [-t secs] [-w bytes] ...

    Client/Server:

    -f [kmKM]  format to report: Kbits, Mbits, KBytes, MBytes
    -i         seconds between periodic bandwidth reports
    -l [KM]    length of buffer to read or write (default 8 KB)
    -m         print TCP maximum segment size (MTU - TCP/IP header)
    -p         server port to listen on/connect to
    -u         use UDP rather than TCP
    -w [KM]    TCP window size (socket buffer size)
    -B         bind to, an interface or multicast address
    -M         set TCP maximum segment size (MTU - 40 bytes)
    -N         set TCP no delay, disabling Nagle's Algorithm
    -V         Set the domain to IPv6
    -C         for use with older versions does not sent extra msgs

    Server specific:

    -s     run in server mode

    Client specific:

    -UDP_RATES [KM]    for UDP, bandwidth to send at in bits/sec
                        (default 1 Mbit/sec, implies -u)
    -REPEAT           number of repeat to send data
    -SLEEP            sleep between repeat
    -c                run in client mode, connecting to 
    -n [KM]           number of bytes to transmit (instead of -t)
    -t                time in seconds to transmit for (default 10 secs)
    -F                input the data to be transmitted from a file
    -I                input the data to be transmitted from stdin
    -P                number of parallel client threads to run
    -S                set type-of-service for outgoing packets
    -T                time-to-live, for multicast (default 1)
    -d                do a bidirectional test simultaneously
    -r                do a bidirectional test individually
    -L                port to recieve bidirectional tests back on