Microsoft Corporation

Remote Desktop Load Simulation Test Controller

User Interface Reference
Hammad Butt

09

Table of Contents
Table of Contents............................................................................................................................ 2 Usage............................................................................................................................................. 3 Argument description.................................................................................................................. 3 Controller UI.................................................................................................................................... 4 Clients Dialog.................................................................................................................................. 6 er!er Dialog.................................................................................................................................. " Config Dialog.................................................................................................................................. # $eneral Tab................................................................................................................................ # Clients election Tab................................................................................................................. %% Test &rogression Tab................................................................................................................ %2 cript Tab.................................................................................................................................. %4 Add cript Dialog................................................................................................................... %' Custom Command Tab............................................................................................................. %6 Configuration (ile.......................................................................................................................... %" CA)C*+T,*))-, section.................................................................................................... %# A.AI)A/)- C,I&T section................................................................................................... %9 0script name1 section.................................................................................................................. %9

Usage
,D)oad imulationController.e2e 0TestConfig.ini1 0Auto tart1 0CloseAfterTest1

Argument description
TestConfig.ini 3 ini file containing configuration details for a single test. T4is is an optional argument. T4e test settings can be managed from t4e UI as 5ell. Auto tart 3 t4is is an optional argument. If t4is argument is pro!ided6 t4e test 5ill be launc4ed automaticall7 once t4e test re8uirements are satisfied 9enoug4 client mac4ines are connected and t4e ser!er agent is also connected:. CloseAfterTest 3 t4is is an optional argument. T4is argument 5ill onl7 5or; 5it4 Auto tart. If t4is argument is pro!ided6 t4e test controller tool 5ill e2it once t4e test run 4as been completed.

Controller UI

(igure %

(igure % s4o5s t4e main dialog of t4e ,D)oad imulationController app. T4e first list at t4e top of t4e dialog s4o5s t4e current simulated users 9or scripts: t4at are running against t4e target ,emote Des;top ser!er at an7 gi!en time. T4is list 5ill start out empt7 and as ne5 simulated users are launc4ed6 t4e7 5ill be added to t4is list. T4e second list is t4e Test &rogression 54ic4 describes t4e order and sc4edule of t4e users to be launc4ed. Launch Test Button< 5ill start t4e test according to t4e current settings Stop Progression Button< 5ill stop a currentl7 running test progression. T4is means it 5ill stop launc4ing more user. T4is 5ill not cleanup or stop t4e users t4at are alread7 running. Sa e Config Button< 5ill sa!e t4e current test settings to a configuration file 5it4 t4e name format 0Target er!er1=0script1.ini Reset Test< 5ill stop t4e test and reset t4e controller so t4at all t4e current logged on users 5ill be cleaned up. T4e controller 5ill be in a state 54ere it assumes t4at no users are logged on so far. Also6 t4e client mac4ines 5ill also clean up and disconnect all users t4at t4e7 are currentl7 running. Configure Button! opens t4e Configuration dialog 54ic4 is described in detail belo5. Clients Button! opens t4e Client mac4ines dialog 54ic4 is described in detail belo5. Ser er Button! opens t4e er!er mac4ine dialog 54ic4 is described in detail belo5. Sho" Idle Users Button < opens t4e Idle Users dialog 54ic4 lists all t4e currentl7 running users t4at 4a!e gone idle 54ile 5aiting for some e!ent.

Clients Dialog

(igure 2 (igure 2 s4o5s t4e Client >ac4ines Dialog. T4is dialog s4o5s t4e list of client mac4ines. It is useful for loo;ing at t4e client mac4ines status and running commands on t4e client mac4ines. Run Command< 5ill run t4e command in t4e custom command edit bo2 on eac4 of t4e client mac4ines t4at are selected from t4e list.

Server Dialog

(igure 3 (igure 3 s4o5s t4e ,emote Des;top er!er Dialog. T4is dialog s4o5s t4e ser!er name and connection status. It is useful for running custom commands on t4e ser!er mac4ines. Run Command< 5ill run t4e command in t4e custom command edit bo2 on t4e ser!er mac4ine.

Config Dialog
General Tab

(igure 4

(igure 4 s4o5s t4e general tab of t4e configuration dialog. /elo5 is t4e description of t4e settings on t4is dialog< Check #o$ % Run "ithout ser er agent < if enabled6 t4is setting means t4at t4e ser!er agent is not re8uired for t4is test and t4ere 5ill be no communication 5it4 t4e ser!er during t4e test. Check #o$ % Re#oot ser er #efore test< if enabled6 t4is setting 5ill ma;e t4e ser!er reboot before t4e start of t4e test and 5ait for it to come bac; up before starting t4e test Important< t4e reboot 5ill onl7 5or; if t4ere is a ?,eboot.cmd? script located in t4e 5or;ing director7 of t4e ser!er agent or or a location 54ic4 is in t4e &AT@ !ariable of t4e ser!er. T4e ,eboot.cmd script s4ould reboot t4e ser!er. Ser er Setup #efore re#oot< t4is 5ill specif7 t4e custom command t4at 5ill be run on t4e ser!er before ser!er is rebooted. T4e script or program 4as to be in t4e pat4 of t4e ser!er agent running on t4e ser!er. If t4is setting is specified6 t4e Controller 5ill 5ait for t4e command to be e2ecuted before continuing. (or e2ample6 if t4is setting specifies Test.e2e6 t4en t4e controller 5ill not proceed until t4e Test.e2e 4as e2ited on t4e ser!er. T4is is true for t4e belo5 commands as 5ell. Ser er Setup #efore test< t4is 5ill specif7 t4e custom command t4at 5ill be run on t4e ser!er before t4e test is started. Ser er cleanup after test< t4is 5ill specif7 t4e custom command t4at 5ill be run on t4e ser!er after t4e test is ended. Useful for collecting logs etc. T4is is not considered 54en Test -nd >ode 9belo5: is A ta7 Ali!eB. Check #o$ % Re#oot client #efore test< if enabled6 t4is setting 5ill ma;e t4e clients reboot before t4e start of t4e test and 5ait for t4em to come bac; up before starting t4e test Important< t4e reboot 5ill onl7 5or; if t4ere is a ?,eboot.cmd? script located in t4e 5or;ing director7 of t4e client agent or t4e &AT@ of t4e client. T4e ,eboot.cmd script s4ould reboot t4e client. Client Setup #efore re#oot< t4is 5ill specif7 t4e custom command t4at 5ill be run on t4e clients before t4e7 are rebooted. T4e script or program 4as to be in t4e pat4 of t4e client agent running on t4e client. Client Setup #efore test< t4is 5ill specif7 t4e custom command t4at 5ill be run on t4e client before t4e test is started. Client cleanup after test< t4is 5ill specif7 t4e custom command t4at 5ill be run on t4e client after t4e test is ended. Useful for collecting logs etc. T4is is not considered 54en Test -nd >ode 9belo5: is A ta7 Ali!eB. Use user inde$ onl&< t4is 5ill specif7 t4e format of t4e first argument passed to t4e script. If c4ec;ed it 5ill pass onl7 an inde2 to t4e script 54ic4 t4e script 5ill use to construct a username. If unc4ec;ed it 5ill pass t4e 54ole username to t4e script. User name pad count< t4is controls 4o5 man7 leading Ceros 5ill be in t4e user name. In t4e e2ample abo!e t4e first user 5ill be smc00%. User Prefi$< specifies t4e prefi2 to be used to construct t4e user names. User Pass"ord< specifies t4e pass5ord t4at 5ill be used b7 all users. '$change Ser er< specifies t4e name of t4e e2c4ange ser!er if an7.

Domain (ame< specifies t4e domain name of t4e users to be used for login credentials. Test 'nd Mode< describes 54en t4e test is considered to be ended. T4is 4as one of t4e follo5ing settings. - Sta& )li e< In t4is case6 it is assumed t4at t4e test doesnDt end and more users can be added to t4e test 54en all users 4a!e been launc4ed. - Users *inished< Test is onl7 considered finis4ed 54en all t4e scripts report bac; to t4e controller t4at t4e7 are finis4ed 9done using t4e -nd cript met4od defined belo5:. - Users Launched< Test is considered finis4ed 54en all t4e scripts 4a!e been launc4ed. - Users Launched and Timeout < Test is considered finis4ed 54en all t4e scripts 4a!e been launc4ed and Timeout minutes 4a!e elapsed after t4e last user 5as launc4ed. Timeout< specifies timeout in minutes. T4is is used 5it4 one of t4e Test -nd >odes. Description< used for 5riting up a test description. T4is is useful as it is sa!ed in t4e controller test log.

Clients Selection Tab

(igure ' T4is tab can used to select specific clients on 54ic4 to run t4e test. /7 default t4e test is run using all a!ailable clients. /7 enabling t4e c4ec;bo26 it is possible to remo!e some of t4e clients from t4e A elected ClientsB list and put t4em in t4e AA!ailable ClientsB list. +umber of Users per Client >ac4ines< determines 4o5 man7 users 5ill be launc4ed from eac4 client mac4ine.

Test Progression Tab

(igure 6 (igure 6 s4o5s t4e test progression tab. T4is tab is used to build t4e test progression list. T4e use of t4is list allo5s us to launc4 users at different rates t4roug4 t4e test. T4e test 5ill start using t4e first entr7 in t4e list and t4en it 5ill mo!e to t4e ne2t entr7. @ere is description of t4e !arious fields in a single progression entr7. >in User< T4e inde2 of t4e first user to be launc4ed. >a2 User< T4e inde2 of t4e last user to be launc4ed. (or e2ample6 if >a2 User is %00 and >in User is %6 a total of %00 users 5ill be launc4ed.

$roup iCe< T4e number of users in a group. User Inter!al< T4e number of seconds t4at t4e controller 5aits before starting t4e ne2t user 5it4in t4e group $roup Inter!al< T4e number of seconds t4at t4e controller 5aits before starting t4e ne2t group of users peed (actor< peed (actor is intended to specif7 4o5 fast t4e scripts 5ill be run. T4e scripts 5ill run at t4e normal speed 54en t4e speed factor is set to %. T4e7 5ill run at double speed 54en speed factor is 2 3 and so on.

(ote< T4is is 4o5 t4e speed factor is supposed to be used. T4e Controller passes t4is !alue to t4e script on t4e client mac4ine and it is up to t4e script 4o5 it uses t4e speed factor. Ee recommend t4at an7 sleeps in t4e scenario s4ould be reduced based on t4e speed factor and t7ping rate s4ould also be adFusted.

Script Tab

(igure " (igure " s4o5s t4e cripts tab 54ic4 is used to select t4e script t4at 5ill be used for running t4e test. It is possible to select multiple scripts so t4at eac4 user 5ill run a list of scripts 3 one after t4e ot4er 3 instead of running onl7 one script. T4e list of a!ailable scripts can be built up b7 clic;ing t4e Add script button. T4e test 5ill run onl7 t4e scriptGscripts t4at are in t4e H elected criptsD list.

Add Script Dialog

(igure # (igure # s4o5s t4e Add cript dialog. T4is dialog is used to add a ne5 script to t4e list of A!ailable scripts. /elo5 is t4e description of t4e settings on t4is dialog< *riendl& Script (ame< t4is can be an7 friendl7 name gi!en to t4e script. it does not 4a!e to matc4 t4e file name *ull *ile Path< (ull file pat4 of t4e script file. T4is setting can be t7ped in. Alternati!el76 7ou can use t4e /ro5se button to select t4e script file. Parameters< optional parameters to be passed to t4e script. T4is can be left empt7 if no optional parameters are re8uired Script T&pe< is not used currentl7

Custom Command Tab

(igure 9 T4is tab is used to specif7 custom commands t4at 5ill be run based on user load e!ents. In t4e figure abo!e6 t4e entr7 in t4e list specifies t4e follo5ing< 54en user %00 is launc4ed6 5ait for 30 seconds and t4en run trace.cmd on t4e ser!er mac4ines. T4ere can be multiple commands specified in t4is list.

Configuration File
/elo5 is a sample configuration file t4at can be passed to t4e controller [SCALCONTROLLER] UserIndexMode=0 ServerAgentMode=1 TClientMode=0 RebootServerMode=0 RebootClientMode=0 UserP dCo!nt=" UsersPerM #$ine=%0 TestEndMode=% Co&& ndTi&eo!t=' TestEndTi&eo!t=0 UserPre(ix=s&# UserP ss)ord=*)d +o& inN &e=Ts*er(test1 Ex#$ ngeServer=TSEx#$ nge1 ServerN &e=TestServer ServerPreRebootCo&& nd=ServerPreReboot,#&d ServerPreTestCo&& nd=Pre* reServer-orTest,#&d ServerTestCle n!*Co&& nd=ServerTestCle n!*,#&d ClientPreRebootCo&& nd=ClientPreReboot,#&d ClientPreTestCo&& nd=Pre* reClient-orTest,#&d ClientTestCle n!*Co&& nd=ClientTestCle n!*,#&d Test+es#ri*tion=T.*e/test/des#ri*tion/$ere0 ProgressionListCo!nt=1 Progression1=11%001101"01"0011 Co&& ndListCo!nt=1 Co&& ndEntr.1=1001"01tr #e,#&d S#ri*tListCo!nt=1 S#ri*tN &e1=Test,vbs [A2AILA3LESCRIPTS] S#ri*tsCo!nt=1 S#ri*tN &e1=test,vbs [test,vbs] (ile* t$=#45te&*5test,vbs * r &eters=* r &s t.*e="

ome of t4e settings are self e2planator7. /elo5 is t4e description for t4e ones t4at are not.

SCALCO T!OLL"! section

UserInde$Mode< t4is 5ill specif7 t4e format of t4e first argument passed to t4e script. If set to % it 5ill pass onl7 an inde2 to t4e script 54ic4 t4e script 5ill use to construct a username. If 0 it 5ill pass t4e 54ole username to t4e script. TClientMode< et to 0 and ignore. Ser er)gentMode< t4is 5ill determine 54et4er to use t4e ser!er agent during t4e test. If set to 0 t4e ser!er agent 5ill not be re8uired for t4e test and t4ere 5ill be no communication 5it4 t4e ser!er during t4e test. If set to %6 ser!er agent 5ill be re8uired for t4e test. UsersPerMachine< T4is setting 5ill control 4o5 man7 scripts 5ill be launc4ed on eac4 client mac4ine. CommandTimeout< T4is is t4e time in seconds t4at t4e controller 5ill 5ait after running t4e ser!er and client commands li;e er!er&re,ebootCommand etc. Test'ndMode< T4is determines 4o5 t4e test is considered ended. T4e cleanup Fobs are run on t4e ser!er and client mac4ines onl7 54en t4e test is considered ended b7 t4e controller. T4ere are 3 !alues for t4is setting 0 3 ta7 Ali!e mode. After launc4ing t4e last user6 t4e controller does not4ing. >ore users can no5 be added to t4e progression list and t4e test ma7 continue. % 3 Users (inis4ed mode. In t4is mode t4e test is considered ended onl7 after all t4e launc4ed scripts report bac; telling t4e controller t4at t4e7 4a!e ended 9t4is is done using t4e -nd cript9: met4od e2posed b7 t4e DC*> obFect: 2 3 Users )aunc4ed mode. In t4is mode t4e test is considered ended once all t4e scripts 4a!e been launc4ed and t4e controller 4as 5aited for t4e time specified b7 t4e last group inter!al. 3 3Users )aunc4ed and Timeout. Test is considered finis4ed 54en all t4e scripts 4a!e been launc4ed and Timeout minutes 4a!e elapsed after t4e last user 5as launc4ed. ProgressionListCount< 4as t4e number of entries in t4e progression list. If t4is is set to 26 t4e ini file must 4a!e t4e entries &rogression% and &rogression2. Progression+< 4as t4e settings for t4e first entr7 of t4e progression list in t4e follo5ing format. 0first user1=0last user1=0group siCe1=0user inter!al1=0group inter!al1=0speed factor1 CommandListCount< 4as t4e number of entries in t4e custom command list. If t4is is set to 26 t4e ini file must 4a!e t4e entries Command-ntr7% and Command-ntr72. Command'ntr&+< 4as t4e settings for t4e first entr7 of t4e custom command list in t4e follo5ing format. 0user inde21=0inter!al to 5ait1=0command1 T4e command 5ill be run on t4e ser!er after t4e user 5it4 0user inde21 is started 0inter!al to 5ait1 is t4e inter!al in seconds to 5ait before running command T4e script or program 4as to be in t4e pat4 of t4e ser!er agent running on t4e ser!er ScriptListCount< 4as t4e number of entries in t4e script list. If t4is is set to 26 t4e ini file must 4a!e t4e entries cript+ame% and cript+ame2 in t4is section. T4is s4ould be set to % if onl7 one script is needed to be run for t4e test.

Script(ame+< specifies t4e name of t4e script 9e2ample< Test.!bs: to be run. T4is must be one of t4e scripts listed in t4e A.AI)A/)- C,I&T section.

A#AILA$L"SC!IPTS section
T4is section describes t4e scripts a!ailable to c4oose from for t4is test. T4in; of it as t4e script librar7. ScriptCount< 4as t4e number of entries in t4e a!ailable script list. If t4is is set to 26 t4e ini file must 4a!e t4e entries cript+ame% and cript+ame2 in t4is section. T4is s4ould be set to % if onl7 one script is a!ailable. Script(ame+< specifies t4e friendl7 name of t4e script 9e2ample< Test.!bs:. T4ere must be a section in t4e I+I file 5it4 t4is name.

%script name& section

In t4e abo!e e2ample6 t4e section is 0Test.!bs1 *ilepath< (ull file pat4 of t4e script. Parameters< optional parameter to be passed to t4e script. T4is can be left empt7 if no optional parameters are re8uired T&pe< is not used currentl7