diff options
| -rwxr-xr-x | trex_vm_manual.asciidoc | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/trex_vm_manual.asciidoc b/trex_vm_manual.asciidoc index 3a1e62d6..f866ec19 100755 --- a/trex_vm_manual.asciidoc +++ b/trex_vm_manual.asciidoc @@ -11,28 +11,28 @@ T-Rex Virtual Machine setup and basic usage === T-Rex traffic generator -T-Rex traffic generator is a tool design the benchmark platforms with realistic traffic. +TRex traffic generator is a tool design the benchmark platforms with realistic traffic. This is a work-in-progress product, which is under constant developement, new features are added and support for more router's fuctionality is achieved. -One of the innovative tools through which T-Rex can be learned and tested during development is a virtual machine instance, fully simulating T-Rex without the need of any additional hardware. +One of the innovative tools through which TRex can be learned and tested during development is a virtual machine instance, fully simulating TRex without the need of any additional hardware. -==== T-Rex Virtual Machine +==== TRex Virtual Machine -The T-Rex Virtual Machine is based on Oracle's Virtual Box freeware. +The TRex Virtual Machine is based on Oracle's Virtual Box freeware. -It is designed to enable T-Rex newbies to explore this tool without any special resources, and no single network cable attached. Moreover, is requires no internet or outer network connectivity. +It is designed to enable TRex newbies to explore this tool without any special resources, and no single network cable attached. Moreover, is requires no internet or outer network connectivity. == Setup and Usage === Setup -In order to use T-Rex VM, there are several super-easy steps to follow: +In order to use TRex VM, there are several super-easy steps to follow: . Download and install Oracle VM Virtual Box Manage https://www.virtualbox.org/wiki/Downloads[(VB download link)]. + During the installation you'll be asked to allow the installation of system devices component interactions. Allow it. - . Download the latest T-Rex VM by http://csi-wiki-01:8181/trex/T_Rex_162_VM_Fedora_21.ova[clicking on this link]. + . Download the latest TRex VM by http://trex-tgn.cisco.com/trex/T_Rex_162_VM_Fedora_21.ova[clicking on this link]. . Open Oracle VM Virtual Box application installed at step 1. . Under 'File' tab, select 'Import Appliance' (`ctrl+I` shorthand can be used as well). The following screen will apear: @@ -54,16 +54,16 @@ endif::backend-xhtml11[] === Launching and logging into the machine -Let's get started with running T-Rex! +Let's get started with running TRex! First, launch the virtual machine by selecting it in the VM's menu and hitting 'Start' button. ifdef::backend-docbook[] -image::images/vm_selection_screen.png[title="T-Rex VM launching screen",align="center",width=400, link="images/vm_selection_screen.png"] +image::images/vm_selection_screen.png[title="TRex VM launching screen",align="center",width=400, link="images/vm_selection_screen.png"] endif::backend-docbook[] ifdef::backend-xhtml11[] -image::images/vm_selection_screen.png[title="T-Rex VM launching screen",align="center",width=900, link="images/vm_selection_screen.png"] +image::images/vm_selection_screen.png[title="TRex VM launching screen",align="center",width=900, link="images/vm_selection_screen.png"] endif::backend-xhtml11[] @@ -93,35 +93,35 @@ Next, once the machine is finished booting, login to the machine using the follo - Password: `trex` ifdef::backend-docbook[] -image::images/trex_vm_login.png[title="T-Rex VM login",align="center",width=400, link="images/trex_vm_login.png"] +image::images/trex_vm_login.png[title="TRex VM login",align="center",width=400, link="images/trex_vm_login.png"] endif::backend-docbook[] ifdef::backend-xhtml11[] -image::images/trex_vm_login.png[title="T-Rex VM login",align="center",width=900, link="images/trex_vm_login.png"] +image::images/trex_vm_login.png[title="TRex VM login",align="center",width=900, link="images/trex_vm_login.png"] endif::backend-xhtml11[] TIP: a remote connection to the machine from anywhere in the hosting machine can be achieved by the following command: + `ssh -p 3022 trex@127.0.0.1` -=== Running T-Rex traffic generator +=== Running TRex traffic generator -Finally, we're ready to do some T-Rex magic. This is super easy and can be achived be the following steps: +Finally, we're ready to do some TRex magic. This is super easy and can be achived be the following steps: 1. Change dir to latest version supplied using: `cd /home/trex/v1.62/`. - 2. Run your desired T-Rex command. + 2. Run your desired TRex command. -IMPORTANT: When launching a T-Rex command pay attention make sure that: + +IMPORTANT: When launching a TRex command pay attention make sure that: + 1. use `sudo` prefix at the beggining of the command. + 2. Specify the `-f` argument first among all arguments. -For example, let's run T-Rex with DNS traffic generation and no latency. The Runnning command is: +For example, let's run TRex with DNS traffic generation and no latency. The Runnning command is: ---- [trex@localhost v1.62]$ sudo ./t-rex-64 -f cap2/dns.yaml -d 100 -m 1 --nc -Starting T-Rex 1.62 please wait ... +Starting TRex 1.62 please wait ... found configuration file at /etc/trex_cfg.yaml zmq publisher at: tcp://*:4500 @@ -185,11 +185,11 @@ listening on enp0s8, link-type EN10MB (Ethernet), capture size 262144 bytes Let's have a look at another example. + -We want to run T-Rex with simple http traffic generation. The running command will look like this: +We want to run TRex with simple http traffic generation. The running command will look like this: ---- [trex@localhost v1.62]$ sudo ./t-rex-64 -f cap2/http_simple.yaml -d 100 -l 1000 -m 1 --nc -Starting T-Rex 1.62 please wait ... +Starting TRex 1.62 please wait ... found configuration file at /etc/trex_cfg.yaml zmq publisher at: tcp://*:4500 @@ -263,9 +263,9 @@ listening on enp0s8, link-type EN10MB (Ethernet), capture size 262144 bytes See http://csi-wiki-01:8181/trex/doc/trex_book.pdf[T-Rex full manual] for a complete understading of the tool features and options. -=== T-Rex Live monitoring +=== TRex Live monitoring -Once we have T-Rex up and running, we can enjoy the benefit of having live monitoring on its performance, using TRexViewer application footnote:[Supported only on Windows OS] +Once we have TRex up and running, we can enjoy the benefit of having live monitoring on its performance, using TRexViewer application footnote:[Supported only on Windows OS] @@ -278,47 +278,47 @@ This can be easily done by following these steps: 2. Click the play button. ifdef::backend-docbook[] -image::images/trex_motinor_config.png[title="T-Rex viewer start screen",align="center",width=400,link="images/trex_motinor_config.png"] +image::images/trex_motinor_config.png[title="TRex viewer start screen",align="center",width=400,link="images/trex_motinor_config.png"] endif::backend-docbook[] ifdef::backend-xhtml11[] -image::images/trex_motinor_config.png[title="T-Rex viewer start screen",align="center",width=900,link="images/trex_motinor_config.png"] +image::images/trex_motinor_config.png[title="TRex viewer start screen",align="center",width=900,link="images/trex_motinor_config.png"] endif::backend-xhtml11[] 3. **That's it!** + - Now the live data from T-Rex will be displayed on the screen. + Now the live data from TRex will be displayed on the screen. ifdef::backend-docbook[] -image::images/trex_motinor_view.png[title="T-Rex viewer monitor screen",align="center",width=400,link="images/trex_motinor_view.png"] +image::images/trex_motinor_view.png[title="TRex viewer monitor screen",align="center",width=400,link="images/trex_motinor_view.png"] endif::backend-docbook[] ifdef::backend-xhtml11[] -image::images/trex_motinor_view.png[title="T-Rex viewer monitor screen",align="center",width=900,link="images/trex_motinor_view.png"] +image::images/trex_motinor_view.png[title="TRex viewer monitor screen",align="center",width=900,link="images/trex_motinor_view.png"] endif::backend-xhtml11[] [NOTE] -Make sure T-Rex is running, otherwise data will not be available at TRexViewer. +Make sure TRex is running, otherwise data will not be available at TRexViewer. === Architecture and network design -Since no hardware is used, T-Rex simulates traffic using a virtual internal network, named 'trex_intnet'. +Since no hardware is used, TRex simulates traffic using a virtual internal network, named 'trex_intnet'. -The following figure describes the virtual "wiring" of the virtual machine to support T-Rex traffic simulation. +The following figure describes the virtual "wiring" of the virtual machine to support TRex traffic simulation. ifdef::backend-docbook[] -image::images/T-Rex_vm.png[title="T-Rex virtual connectivity",align="center",width=400, link="images/T-Rex_vm.png"] +image::images/T-Rex_vm.png[title="TRex virtual connectivity",align="center",width=400, link="images/T-Rex_vm.png"] endif::backend-docbook[] ifdef::backend-xhtml11[] -image::images/T-Rex_vm.png[title="T-Rex virtual connectivity",align="center",width=900, link="images/T-Rex_vm.png"] +image::images/T-Rex_vm.png[title="TRex virtual connectivity",align="center",width=900, link="images/T-Rex_vm.png"] endif::backend-xhtml11[] -The VM runs T-Rex with single client and single server port. The traffic generated by each of those ports are switched over the 'trex_intnet' virtual network and received by the other side. +The VM runs TRex with single client and single server port. The traffic generated by each of those ports are switched over the 'trex_intnet' virtual network and received by the other side. -T-Rex identifies only the packets which were dedicately sent by one of those traffic ports and receives them in the other port. Hence, packets generated by client port will be received by the server port and vice versa. +TRex identifies only the packets which were dedicately sent by one of those traffic ports and receives them in the other port. Hence, packets generated by client port will be received by the server port and vice versa. -Ontop, network adapter #4 used to [underline]#listen# to all traffic generated by both of T-Rex's ports, therefore it is very useful in providing live data of the generated flows over the network.
\ No newline at end of file +Ontop, network adapter #4 used to [underline]#listen# to all traffic generated by both of TRex's ports, therefore it is very useful in providing live data of the generated flows over the network. |