mu 5.7.35 → 5.7.36

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. data/Mu_Gem.html +1287 -1077
  2. data/README.md +1305 -0
  3. data/version.rb +1 -1
  4. metadata +18 -18
  5. data/README.rdoc +0 -586
data/Mu_Gem.html CHANGED
@@ -243,6 +243,62 @@ table.wide th {
243
243
  padding-left: 6px;
244
244
  }
245
245
 
246
+ /*********** begin outline tables ***********/
247
+ table.outline {
248
+ border: 1px silver solid;
249
+ width: 580px;
250
+ background: #FFFFFF;
251
+ border-collapse: collapse;
252
+ text-align: left;
253
+ margin: 1% 1% 1% 10px;
254
+ padding: 1px;
255
+ }
256
+
257
+ table.outline th, table.outline td {
258
+ border-width: 0px;
259
+ }
260
+
261
+ table.outline th {
262
+ background: #CFEBFF;
263
+ text-align: left;
264
+ vertical-align: middle;
265
+ font-family: Arial, Helvetica, sans-serif;
266
+ font-size: 9pt;
267
+ font-weight: bold;
268
+ color: #333333;
269
+ padding: 6px 2px 4px 4px;
270
+ }
271
+
272
+ table.outline-auto {
273
+ border: 1px silver solid;
274
+ width: 90%;
275
+ background: #FFFFFF;
276
+ border-collapse: collapse;
277
+ text-align: left;
278
+ margin: 1% 1% 1% 40px;
279
+ padding: 1px;
280
+ }
281
+
282
+ table.outline-auto th, table.outline-auto td {
283
+ border-width: 0px;
284
+ }
285
+
286
+ table.outline-auto th {
287
+ background: #CFEBFF;
288
+ text-align: left;
289
+ vertical-align: middle;
290
+ font-family: Arial, Helvetica, sans-serif;
291
+ font-size: 9pt;
292
+ font-weight: bold;
293
+ color: #333333;
294
+ padding: 6px 2px 4px 4px;
295
+ }
296
+
297
+ #content ul li ul li {
298
+ margin-left: -20px;
299
+ }
300
+
301
+
246
302
  #important{
247
303
  float: clear;
248
304
  color: #333333;
@@ -265,28 +321,60 @@ table.wide th {
265
321
  .code{
266
322
  font-family: Courier, monospace;
267
323
  font-size: 9pt
268
- }
324
+ }
325
+
326
+ .code_blue_background {
327
+ border:1px solid silver;
328
+ font-size: 9pt;
329
+ background-color: #CFEBFF;
330
+ width: 95%;
331
+ margin: 8px 4px 4px 2%;
332
+ font-family: Courier, monospace;
333
+ color: #333;
334
+ font-weight: normal;
335
+ padding: 2px;
336
+ }
269
337
 
338
+ .code_teal_background {
339
+ border:1px solid silver;
340
+ font-size: 9pt;
341
+ width: 95%;
342
+ margin: 8px 4px 4px 2%;
343
+ font-family: Courier, monospace;
344
+ color: #333;
345
+ background-color: #E0E0FF;
346
+ padding: 2px;
347
+ }
270
348
 
271
- /*********** end wide tables ***********/
349
+ .code_black_background {
350
+ border:1px solid silver;
351
+ font-size: 9pt;
352
+ width: 90%;
353
+ margin: 8px 4px 4px 2%;
354
+ font-family: Courier, monospace;
355
+ font-weight: normal;
356
+ background-color: #333;
357
+ color: #FFF;
358
+ padding: 2px;
359
+ }
272
360
 
273
- -->
274
- </style>
361
+ </style>
275
362
  </head>
276
363
  <body>
277
364
  <div id="masthead">
278
- <h1>Mu Ruby Gem</h1>
365
+ <h1><font class="body"><a name="top" id="cmd_runscale4"></a></font>Mu Ruby Gem</h1>
279
366
  <p align="center" class="subhead">API Commands for the Mu System</p>
280
367
  </div>
281
368
 
282
369
  <div id="content">
283
- <p><font class="body"><a name="top" id="cmd_runscale4"></a></font>The Mu.gem contains command line application (executables) designed to help you work with Scenarios, Test Sets, Scale tests and all results generated from those tests. In addition, the Mu.gem also supports older REST API commands that you can use to configure the Mu network, get system status, or even access the Mu CLI. Finally, the Mu. gem exposes API library classes that you can use in your own custom gems. </p>
370
+ <p>The Mu.gem contains command line application (executables) designed to help you work with Scenarios, Test Sets, Scale tests and all results generated from those tests. In addition, the Mu.gem also supports older REST API commands that you can use to configure the Mu network, get system status, or even access the Mu CLI. Finally, the Mu. gem exposes API library classes that you can use in your own custom gems. </p>
284
371
  <div id="important">
285
372
  <p><strong>Before Using This Gem</strong>:</p>
286
373
  <ul>
287
- <li><strong><em>Ensure that you have installed the necessary software</strong></em>
288
- You must have installed ruby 1.8.6 and the following gems. (type <strong>sudo gem install</strong><em>&lt;gem&gt;</em>):
374
+ <li><strong><em>Ensure that you have installed the necessary software</em></strong>. You must have installed ruby 1.8.6 and the following gems (type <strong>sudo gem
375
+ install</strong> <em> gem</em>):
289
376
  <ul>
377
+ <li><em>hexy</em>. This ensures that hex dumps print pretty :)</li>
290
378
  <li><em>json_pure</em>. Don't confuse this with the json gem (that won't work).</li>
291
379
  <li><em>nokogiri</em>. See http://nokogiri.org/tutorials/installing_nokogiri.html for help.</li>
292
380
  <li><em>rest-client</em>. Used for HTTP calls. </li>
@@ -297,18 +385,14 @@ table.wide th {
297
385
  <ul>
298
386
  <li><em><span class="MsoNormal1">MU_IP</span></em><span class="MsoNormal1">. Set the default IP addr</span>ess of the Mu management interface.</li>
299
387
  <li><em>MU_ADMIN_USER</em>. Set the default name of the admin user.</li>
300
- <li><em>MU_ADMIN_PASS</em>. Set the default <span class="MsoNormal1">admin user password</span>(do not use the ':' or '@' characters in the password).</li>
388
+ <li><em>MU_ADMIN_PASS</em>. Set the default <span class="MsoNormal1">admin user password</span>.</li>
301
389
  </ul></li></ul></div>
302
390
  <p>The following table lists each API section and the associated commands:</p>
303
391
  <table width="500" border="1" cellpadding="1" cellspacing="1" class="wide">
304
392
  <tr>
305
- <th width="68%" scope="col">&nbsp;</th>
306
- <th width="32%" scope="col">&nbsp;</th>
307
- </tr>
308
- <tr>
309
- <td><p class="MsoNormal"><strong>Executables</strong>&nbsp;&nbsp;&nbsp;<a href="#executables">&nbsp;&nbsp;&nbsp;go to section &raquo;</a></p>
393
+ <td width="68%"><p class="MsoNormal"><strong>Executables</strong>&nbsp;&nbsp;&nbsp;<a href="#executables">&nbsp;&nbsp;&nbsp;go to section &raquo;</a></p>
310
394
  <p class="MsoNormal">These command-line applications are used for loading and verifying Scenarios, creating and running Test Sets, and configuring and running Scale tests.</p></td>
311
- <td><ul>
395
+ <td width="32%"><ul>
312
396
  <li><a href="#cmd_appid">cmd_appid</a><span
313
397
  style="mso-spacerun: yes">&nbsp;&nbsp;&nbsp; </span></li>
314
398
  <li><a href="#cmd_runscale">cmd_runscale</a></li>
@@ -351,1230 +435,1356 @@ style="mso-spacerun: yes">&nbsp;&nbsp;&nbsp; </span></li>
351
435
  <li><a href="#cmd_runscale">cmd_runscale</a></li>
352
436
  <li><a href="#cmd_runverify">cmd_runverify</a></li>
353
437
  <li><a href="#cmd_runscenario">cmd_runscenario</a> </li>
438
+ <li><a href="#cmd_musl">cmd_musl</a></li>
354
439
  </ul>
355
440
  <h2><a name="cmd_appid" id="features4"></a>cmd_appid</h2>
356
- <p>Use to run Scale tests for a multi-host App-ID .msl file or a directory of .msl files. Supports command-line options for setting test parameters (such as concurrency and pattern) and for configuring a client/server &quot;passthrough&quot; Test Bed. Mu Studio automatically collapses all hosts in the App-ID Scenario to just two hosts, which must be set to two Mu interfaces. </p>
357
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
441
+ <p>Use to run Scale tests for a multi-host App-ID .msl file or a directory of .msl files. Supports command-line options for setting test parameters (such as concurrency and pattern) and for configuring a client/server passthrough Test Bed. Mu Studio automatically collapses all hosts in the App-ID Scenario to just two hosts, which must be set to two Mu interfaces. </p>
442
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
358
443
  <tr>
359
- <th>Command</th>
360
- <th>Description &amp; Examples</th>
361
- </tr>
362
- <tr>
363
- <td><em>help</em></td>
444
+ <th width="102">Command</th>
445
+ <th width="469">Examples</th>
446
+ </tr>
447
+ <tr>
448
+ <td valign="top"><p><em>help</em></p></td>
364
449
  <td><p>Gets help for all cmd_appid commands: <strong>help</strong></p>
365
- <h6 class="code">mu cmd_appid:help</h6></td>
450
+ <p class="code_black_background">mu cmd_appid:help</p></td>
366
451
  </tr>
367
452
  <tr>
368
- <td><h5>run_file</h5></td>
453
+ <td valign="top"><p><em>run_file</em></p></td>
369
454
  <td><p> Runs the specified .msl file: <strong>run_file -s</strong> <em>msl-filename</em></p>
370
- <h6><span class="code">mu cmd_appid:run_file -s msl_file -i a1,a2 -m
371
- admin:admin@10.10.2.2 -p 1-10000:60</span></h6></td>
455
+ <p class="code_black_background">mu cmd_appid:run_file -s msl_file -i a1,a2 -m
456
+ admin:admin@10.10.2.2 -p 1-10000:60</p></td>
372
457
  </tr>
373
458
  <tr>
374
- <td><em>run_dir</em></td>
459
+ <td valign="top"><p><em>run_dir</em></p></td>
375
460
  <td><p>Runs all .msl files in the specified directory: <strong>run_dir -d</strong> <em>msl-directory</em></p>
376
- <h6><span class="code">mu cmd_appid:run_dir -d msl_file_directory -i a1-10000,a2
377
- -m admin:admin@10.10.2.2 -p 1-100000:360</span></h6>
378
- <p></p></td>
461
+ <p class="code_black_background">mu cmd_appid:run_dir -d msl_file_directory -i a1-10000,a2
462
+ -m admin:admin@10.10.2.2 -p 1-100000:360</p></td>
379
463
  </tr>
380
464
  <tr>
381
- <td><em>running?</em></td>
465
+ <td height="72" valign="top"><p><em>running?</em></p></td>
382
466
  <td><p>Gets status of the scale player: <strong>running?</strong></p>
383
- <h6><span class="code">mu cmd_appid:running?</span></h6></td>
384
- </tr>
385
- </table>
386
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
387
- <tr>
388
- <th colspan="2">Options (short &amp; long form)</th>
389
- <th width="60%">Description</th>
390
- </tr>
391
- <tr>
392
- <td width="4%">-a</td>
393
- <td width="36%"><strong>--vector_address_pairing</strong></td>
394
- <td>Sets vectorAddressPairing to true, which limits and maps concurrencies to the rows in the testset.</td>
395
- </tr>
396
- <tr>
397
- <td width="4%">-c</td>
398
- <td width="36%"><strong>--csv</strong> <em>csv-filename</em></td>
399
- <td>Specify the filename of the .csv file that contains the test cases to run.</td>
467
+ <p class="code_black_background">mu cmd_appid:running?</p></td>
400
468
  </tr>
401
469
  <tr>
402
- <td>-d</td>
403
- <td><strong>--dir</strong> <em>directory</em></td>
404
- <td>Specify the directory that contains .msl files to run(required for run_dir).</td>
470
+ <th colspan="2"><strong>Options</strong></th>
405
471
  </tr>
406
472
  <tr>
407
- <td>-h</td>
408
- <td><strong>--help</strong></td>
409
- <td>Get help on command line options.</td>
473
+ <td colspan="2"><p><strong>-c</strong>/<strong>--csv</strong><em> &lt;</em>csv-filename&gt;</p>
474
+ <blockquote>
475
+ <p> Specify the .csv filename with test cases to run.</p>
476
+ </blockquote></td>
410
477
  </tr>
411
478
  <tr>
412
- <td>-i</td>
413
- <td><strong>--interfaces</strong> <em>interfaces</em></td>
414
- <td>Specify Mu interfaces as a comma-separated list. Example: <span class="code">b1, b2</span>. When using an IP range, specify range and offset. Example: <span class="code">b1-1000:0,b2</span></td>
479
+ <td colspan="2"><p><strong>-d</strong>/<strong>--dir</strong> &lt;directory&gt;</p>
480
+ <blockquote>
481
+ <p>Specify the directory with .msl files to run (required for run_dir).</p>
482
+ </blockquote></td>
415
483
  </tr>
416
484
  <tr>
417
- <td>-l</td>
418
- <td><strong>--delay</strong> <em>delay_value</em></td>
419
- <td>Intra-scenario delay value, in milliseconds. Default is 0.</td>
485
+ <td colspan="2"><p><strong>-h</strong>/<strong>--help</strong></p>
486
+ <blockquote>
487
+ <p>Get help on command line options.</p>
488
+ </blockquote></td>
420
489
  </tr>
421
490
  <tr>
422
- <td>-m</td>
423
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
424
- <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
491
+ <td colspan="2"><p><strong>-i</strong>/<strong>--interfaces</strong> &lt;interfaces&gt;</p>
492
+ <blockquote>
493
+ <p>Specify Mu interfaces as a comma-separated list. Example: b1, b2. When using an IP range, specify range and offset. Example: b1-1000:0,b2</p>
494
+ </blockquote></td>
425
495
  </tr>
426
496
  <tr>
427
- <td>-n</td>
428
- <td><strong>--no_verify</strong> </td>
429
- <td>Option to not call verify before start.</td>
497
+ <td colspan="2"><p><strong>-m</strong>/<strong>--mu_string</strong> <em>&lt;</em>user:pass@mu-ip&gt;</p>
498
+ <blockquote>
499
+ <p>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
500
+ </blockquote></td>
430
501
  </tr>
431
502
  <tr>
432
- <td>-o</td>
433
- <td><strong>--output</strong> <em>filename</em></td>
434
- <td>Specify the filename to which you want to output logs.</td>
503
+ <td colspan="2"><p><strong>-o</strong>/<strong>--output</strong> &lt;filename&gt;</p>
504
+ <blockquote>
505
+ <p>Specify the filename to which you want to output logs.</p>
506
+ </blockquote></td>
435
507
  </tr>
436
508
  <tr>
437
- <td>-p</td>
438
- <td><strong>--pattern</strong> <em>con-start</em>:<em>dur</em>,<em>con-end</em>:<em>dur</em></td>
439
- <td>Specify pattern as concurrency_start:duration,concurrency-end:duration. Duration is in seconds. Example:
440
- <span class="code">1-10000:60,10000-1:30</span>. </td>
441
- </tr>
442
- <tr>
443
- <td>-r</td>
444
- <td><strong>--recursive</strong> </td>
445
- <td>for run_dir command, recurse through the specified directory </td>
509
+ <td colspan="2"><p><strong>-p</strong>/<strong>--pattern</strong> &lt;start:dur,end:dur&gt;</p>
510
+ <blockquote>
511
+ <p>Specify pattern as concurrency-start:duration, concurrency-end:duration. Duration is in seconds. Example: <span class="code">1-10000:60,10000-1:30</span>. </p>
512
+ </blockquote></td>
446
513
  </tr>
447
514
  <tr>
448
- <td>-s</td>
449
- <td><strong>--scenario</strong> <em>msl-filename</em></td>
450
- <td>Specify the .msl filename (required for
451
- run_msl)</td>
515
+ <td colspan="2"><p><strong>-s</strong>/<strong>--scenario</strong> &lt;msl-filename&gt;</p>
516
+ <blockquote>
517
+ <p>Specify the .msl filename (required for
518
+ run_msl)</p>
519
+ </blockquote></td>
452
520
  </tr>
453
521
  <tr>
454
- <td>-t</td>
455
- <td><strong>--test</strong></td>
456
- <td>Run a verification check only.</td>
522
+ <td colspan="2"><p><strong>-t</strong>/<strong>--test</strong></p>
523
+ <blockquote>
524
+ <p>Run a verification check only.</p>
525
+ </blockquote></td>
457
526
  </tr>
458
527
  <tr>
459
- <td>-v</td>
460
- <td><strong>--verbose</strong></td>
461
- <td>Set
462
- the Logger::DEBUG level.</td>
528
+ <td colspan="2"><p><strong>-v</strong>/<strong>--verbose</strong></p>
529
+ <blockquote>
530
+ <p>Set
531
+ the Logger::DEBUG level.</p>
532
+ </blockquote></td>
463
533
  </tr>
464
534
  </table>
465
535
  <p><a href="#top">back to top &uarr;</a></p>
466
536
  <h2><a name="cmd_runscale" id="cmd_runscale"></a>cmd_runscale</h2>
467
537
  <p>Use to run Scale tests by specifying a Scenario .msl file or a directory of .msl files. Supports command-line options for setting test parameters (such as concurrency and pattern) and for configuring the Test Bed with Mu interfaces and/or network hosts. </p>
468
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
538
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
469
539
  <tr>
470
- <th>Command</th>
471
- <th>Commands &amp; Examples</th>
540
+ <th width="76">Command</th>
541
+ <th width="495">Examples</th>
472
542
  </tr>
473
543
  <tr>
474
- <td><em>help</em></td>
544
+ <td valign="top" class="outline"><p><em>help</em></p></td>
475
545
  <td><p>Gets help for all cmd_runscale commands: <strong>help</strong></p>
476
- <h6 class="code">mu cmd_runscale:help</h6></td>
477
- </tr>
478
- <tr>
479
- <td><h5>run_file</h5></td>
480
- <td><p>Runs the specified .msl file: <strong>run_file -s</strong> <em>msl-filename</em><strong>&nbsp; -i </strong><em>interfaces/hosts</em> <strong>-p</strong> <em>pattern</em></p>
481
- <h6 class="code">mu cmd_runscale:run_file -s msl_file -i a1,dell-9 -p 1-10000:30</h6></td>
546
+ <p class="code_black_background">mu cmd_runscale:help</p></td>
482
547
  </tr>
483
548
  <tr>
484
- <td><em>run_dir</em></td>
485
- <td><p>Runs all .msl files in the specified directory: <strong>run_dir -d </strong><em>msl_directory</em></p>
486
- <h6 class="code">mu cmd_runscale:run_dir -d msl_file_directory</h6>
487
- <p></p></td>
549
+ <td valign="top" class="outline"><p><em>run_file</em></p></td>
550
+ <td><p>Runs a Scale test for the specified .msl file: <strong>run_file -s</strong> <em>msl-filename</em><strong>&nbsp; -i </strong><em>interfaces/hosts</em> <strong>-p</strong> <em>pattern</em></p>
551
+ <p class="code_black_background">mu cmd_runscale:run_file -s msl_file -i a1,dell-9 -p 1-100:30</p></td>
488
552
  </tr>
489
553
  <tr>
490
- <td><em>running?</em></td>
491
- <td><p>Gets status of the scale player: <strong>running?</strong></p>
492
- <h6><span class="code">mu cmd_runscale:running?</span></h6></td>
554
+ <td valign="top" class="outline"><p><em>run_dir</em></p></td>
555
+ <td><p>Runs a Scale test for all .msl files in the specified directory. To include all .msl files in nested directories, use <strong>-r</strong> to perform a recursive directory search. <strong>run_dir -d </strong><em>msl_directory </em><strong>-r</strong></p>
556
+ <p class="code_black_background">mu cmd_runscale:run_dir -d msl_file_directory</p></td>
493
557
  </tr>
494
- </table>
495
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
496
558
  <tr>
497
- <th colspan="2">Options (short &amp; long form)</th>
498
- <th width="60%">Description</th>
559
+ <td valign="top" class="outline"><p><em>running?</em></p></td>
560
+ <td><p>Gets status of the Scale player: <strong>running?</strong></p>
561
+ <p class="code_black_background">mu cmd_runscale:running?</p></td>
499
562
  </tr>
500
563
  <tr>
501
- <td width="4%">-c</td>
502
- <td width="36%"><strong>--csv</strong> <em>csv-filename</em></td>
503
- <td>Specify the filename of the .csv file that contains the test cases to run.</td>
564
+ <td height="78" valign="top" class="outline"><p><em>run_files</em></p></td>
565
+ <td><p>Runs a Scale test for each .msl file in the specified directory (optionally, you can specify single .msl file). To include all .msl files in nested directories, use <strong>-r</strong> to perform a recursive directory search. <strong>run_file -d</strong> <em>msl-directory</em><strong> -r -i </strong><em>interfaces/hosts</em> <strong>-p</strong> <em>pattern</em></p>
566
+ <p class="code_black_background">mu cmd_runscale:run_file -d msl_file_directory -r -i a1,dell-9 -p 1-100:30</p></td>
504
567
  </tr>
505
568
  <tr>
506
- <td>-d</td>
507
- <td><strong>--dir</strong> <em>directory</em></td>
508
- <td>Specify the directory that contains .msl files to run(required for run_dir).</td>
569
+ <th colspan="2" class="outline"><strong>Options</strong></th>
509
570
  </tr>
510
571
  <tr>
511
- <td>-f</td>
512
- <td><strong>--default_host</strong> <em>default-host</em></td>
513
- <td>Specify the default host. This host is used for all hosts in the scenario which have not been explicitly assigned</td>
572
+ <td colspan="2" class="outline"><p><strong>-c/--csv</strong> <em>csv-filename</em></p>
573
+ <blockquote>
574
+ <p>Specify the filename of the .csv file that contains the test cases to run.</p>
575
+ </blockquote></td>
514
576
  </tr>
515
577
  <tr>
516
- <td>-h</td>
517
- <td><strong>--help</strong></td>
518
- <td>Get help on command line options.</td>
578
+ <td colspan="2" class="outline"><p><strong>-d/--dir</strong> <em>directory</em></p>
579
+ <blockquote>
580
+ <p>Specify the directory that contains .msl files to run (required for <span class="code">run_dir</span>). Does not include nested directories. </p>
581
+ </blockquote></td>
519
582
  </tr>
520
583
  <tr>
521
- <td>-i</td>
522
- <td><strong>--interfaces</strong> <em>interfaces</em></td>
523
- <td>Specify Mu interfaces as a comma-separated list. Example: <span class="code">b1, b2</span>. When using an IP range, specify range and offset. Example: <span class="code">b1-1000:0,b2</span></td>
584
+ <td colspan="2" class="outline"><p><strong>-f/--default_host</strong> <em>default-host</em></p>
585
+ <blockquote>
586
+ <p>Specify the default host. This host is used for all hosts in the scenario which have not been explicitly assigned. </p>
587
+ </blockquote></td>
524
588
  </tr>
525
589
  <tr>
526
- <td>-l</td>
527
- <td><strong>--delay</strong> <em>delay_value</em></td>
528
- <td>Intra-scenario delay value, in milliseconds. Default is 0.</td>
590
+ <td colspan="2" class="outline"><p><strong>-h/--help</strong></p>
591
+ <blockquote>
592
+ <p>Get help on command line options.</p>
593
+ </blockquote></td>
529
594
  </tr>
530
595
  <tr>
531
- <td>-m</td>
532
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
533
- <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
596
+ <td colspan="2" class="outline"><p><strong>-i/--interfaces</strong> <em>interfaces</em></p>
597
+ <blockquote>
598
+ <p>Specify Mu interfaces as a comma-separated list. Example: <span class="code">b1,</span> <span class="code">b2</span>. When using an IP range, specify range and offset. Example: <span class="code">b1-1000:0,b2</span></p>
599
+ </blockquote></td>
534
600
  </tr>
535
601
  <tr>
536
- <td>-n</td>
537
- <td><strong>--no_verify</strong> </td>
538
- <td>Option to not call verify before start.</td>
602
+ <td colspan="2" class="outline"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
603
+ <blockquote>
604
+ <p>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
605
+ </blockquote></td>
539
606
  </tr>
540
607
  <tr>
541
- <td>-o</td>
542
- <td><strong>--output</strong> <em>filename</em></td>
543
- <td>Specify the filename to which you want to output logs.</td>
608
+ <td colspan="2" class="outline"><p><strong>-o/--output</strong> <em>filename</em></p>
609
+ <blockquote>
610
+ <p>Specify the filename to which you want to output logs.</p>
611
+ </blockquote></td>
544
612
  </tr>
545
613
  <tr>
546
- <td>-p</td>
547
- <td><strong>--pattern</strong> <em>con-start</em>:<em>dur</em>,<em>con-end</em>:<em>dur</em></td>
548
- <td>Specify pattern as concurrency_start:duration,concurrency-end:duration. Duration is in seconds. Example:
549
- <span class="code">1-10000:60,10000-1:30</span>. </td>
614
+ <td colspan="2" class="outline"><p><strong>-p/--pattern</strong> <em>con-start</em>:<em>dur</em>,<em>con-end</em>:<em>dur</em></p>
615
+ <blockquote>
616
+ <p>Specify pattern as concurrency_start:duration,concurrency-end:duration. Duration is in seconds. Example: <span class="code">1-10000:60,10000-1:30</span>. </p>
617
+ </blockquote></td>
550
618
  </tr>
551
619
  <tr>
552
- <td>-r</td>
553
- <td><strong>--recursive</strong> </td>
554
- <td>for run_dir command, recurse through the specified directory </td>
620
+ <td colspan="2" class="outline"><p><strong>-r/--recursive</strong></p>
621
+ <blockquote>
622
+ <p>Perform a recursive directory search. Use with <span class="code">run_dir</span> and <span class="code">run_files</span> to run Scale tests for all .msl files contained in nested directories.</p>
623
+ </blockquote></td>
555
624
  </tr>
556
625
  <tr>
557
- <td>-s</td>
558
- <td><strong>--scenario</strong> <em>msl-filename</em></td>
559
- <td>Specify the .msl filename (required for
560
- run_msl)</td>
626
+ <td colspan="2" class="outline"><p><strong>-s/--scenario</strong> <em>msl-filename</em></p>
627
+ <blockquote>
628
+ <p>Specify the .msl filename (required for <span class="code">run_msl</span>).</p>
629
+ </blockquote></td>
561
630
  </tr>
562
631
  <tr>
563
- <td>-t</td>
564
- <td><strong>--test</strong></td>
565
- <td>Run a verification check only.</td>
632
+ <td colspan="2" class="outline"><p><strong>-t/--test</strong></p>
633
+ <blockquote>
634
+ <p>Run a verification check only.</p>
635
+ </blockquote></td>
566
636
  </tr>
567
637
  <tr>
568
- <td>-v</td>
569
- <td><strong>--verbose</strong></td>
570
- <td>Set
571
- the Logger::DEBUG level.</td>
638
+ <td colspan="2" class="outline"><p><strong>-v/--verbose</strong></p>
639
+ <blockquote>
640
+ <p>Set
641
+ the Logger::DEBUG level.</p>
642
+ </blockquote></td>
572
643
  </tr>
573
644
  </table>
574
645
  <p><a href="#top">back to top &uarr;</a></p>
575
646
  <h2><a name="cmd_runverify" id="cmd_runscale2"></a>cmd_runverify</h2>
576
647
  <p>Use to load a Scenario and Test Set template (.xml files) and run a Test Set in Studio Verify. Supports command-line options for setting option values and for configuring the Test Bed with Mu interfaces and/or network hosts.</p>
577
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
648
+ <table border="0" cellpadding="1" cellspacing="1" class="outline">
578
649
  <tr>
579
- <th>Command</th>
580
- <th>Commands &amp; Examples</th>
650
+ <th width="101">Command</th>
651
+ <th width="470">Examples</th>
581
652
  </tr>
582
653
  <tr>
583
- <td><em>help</em></td>
654
+ <td valign="top"><p><em>help</em></p></td>
584
655
  <td><p>Gets help for all cmd_runverify commands: <strong>help</strong></p>
585
- <h6 class="code">mu cmd_runverify:help</h6></td>
586
- </tr>
587
- <tr>
588
- <td><h5>run</h5></td>
589
- <td><p>Runs the specified Test Set template for the specified Scenario: <strong>run -s</strong> <em>scenario.xml</em><strong> -t </strong><em>test-set.xml</em> <strong>-i</strong><em> interfaces/hosts</em></p>
590
- <h6 class="code">mu cmd_runverify:run -s my_scenario -t my_testset -i a1,my-server</h6></td>
591
- </tr>
592
- </table>
593
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
594
- <tr>
595
- <th colspan="2">Options (short &amp; long form)</th>
596
- <th width="60%">Description</th>
597
- </tr>
598
- <tr>
599
- <td width="4%">-c</td>
600
- <td width="36%"><strong>--channels</strong> <em>hosts</em></td>
601
- <td>Specify channel hosts as a comma-separated list. </td>
602
- </tr>
603
- <tr>
604
- <td>-d</td>
605
- <td><strong>--dir</strong> <em>directory</em></td>
606
- <td>Specify the directory with Scenario templates to run.</td>
607
- </tr>
608
- <tr>
609
- <td>-h</td>
610
- <td><strong>--help</strong></td>
611
- <td>Get help on command line options.</td>
612
- </tr>
613
- <tr>
614
- <td>-i</td>
615
- <td><strong>--interfaces</strong> <em>interfaces</em></td>
616
- <td>Specify Mu interfaces and network hosts as a comma-separated list. Example: <span class="code">b1, b2</span>. When using an IP range, specify range/offset. Example: <span class="code">b1-1000:0,web-server</span></td>
617
- </tr>
618
- <tr>
619
- <td>-m</td>
620
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
621
- <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
622
- </tr>
623
- <tr>
624
- <td>-o</td>
625
- <td><strong>--output</strong> <em>filename</em></td>
626
- <td>Specify the filename to which you want to output logs.</td>
627
- </tr>
628
- <tr>
629
- <td>-p</td>
630
- <td><strong>--options</strong><em> option:value</em></td>
631
- <td>Specify option/value pairs as a comma-separated list. Example: <span class="code">user:jane,email:jsmith@itemp.com</span></td>
632
- </tr>
633
- <tr>
634
- <td>-s</td>
635
- <td><strong>--scenario</strong> <em>scenario-template</em></td>
636
- <td>Specify the Scenario template to run (must be xml).</td>
637
- </tr>
638
- <tr>
639
- <td>-t</td>
640
- <td><strong>--testset </strong><em>testset-template</em></td>
641
- <td>Specify the Test Set template to run (must be xml).</td>
642
- </tr>
643
- <tr>
644
- <td>-v</td>
645
- <td><strong>--verbose</strong></td>
646
- <td>Set
647
- the Logger::DEBUG level.</td>
656
+ <p class="code_black_background">mu cmd_runverify:help</p></td>
657
+ </tr>
658
+ <tr>
659
+ <td valign="top"><p><em>run</em></p></td>
660
+ <td><p>Runs the specified Test Set template for the specified Scenario: <strong>run -s</strong> <em>scenario.xml</em><strong> -t </strong><em>test-set.xml</em> <strong>-i</strong><em> interfaces/hosts</em></p>
661
+ <p class="code_black_background">mu cmd_runverify:run -s my_scenario -t my_testset -i a1,my-server</p></td>
662
+ </tr>
663
+ <tr>
664
+ <th colspan="2">Options</th>
665
+ </tr>
666
+ <tr class="wide">
667
+ <td colspan="2"><p><strong>-c/--channels</strong> <em>hosts</em></p>
668
+ <blockquote>
669
+ <p>Specify channel hosts as a comma-separated list. </p>
670
+ </blockquote></td>
671
+ </tr>
672
+ <tr class="wide">
673
+ <td colspan="2"><p><strong>-d/--dir</strong> <em>directory</em></p>
674
+ <blockquote>
675
+ <p>Specify the directory with Scenario templates to run.</p>
676
+ </blockquote></td>
677
+ </tr>
678
+ <tr class="wide">
679
+ <td colspan="2"><p><strong>-h/--help</strong></p>
680
+ <blockquote>
681
+ <p>Get help on command line options.</p>
682
+ </blockquote></td>
683
+ </tr>
684
+ <tr class="wide">
685
+ <td colspan="2"><p><strong>-i/--interfaces</strong> <em>interfaces</em></p>
686
+ <blockquote>
687
+ <p>Specify Mu interfaces and network hosts as a comma-separated list. Example: <span class="code">b1, b2</span>. When using an IP range, specify range/offset. Example: <span class="code">b1-1000:0,web-server</span></p>
688
+ </blockquote></td>
689
+ </tr>
690
+ <tr class="wide">
691
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
692
+ <blockquote>
693
+ <p>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
694
+ </blockquote></td>
695
+ </tr>
696
+ <tr class="wide">
697
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
698
+ <blockquote>
699
+ <p>Specify the filename to which you want to output logs.</p>
700
+ </blockquote></td>
701
+ </tr>
702
+ <tr class="wide">
703
+ <td colspan="2"><p><strong>-p/--options</strong><em> option:value</em></p>
704
+ <blockquote>
705
+ <p>Specify option/value pairs as a comma-separated list. Example: <span class="code">user:jane,email:jsmith@itemp.com</span></p>
706
+ </blockquote></td>
707
+ </tr>
708
+ <tr class="wide">
709
+ <td colspan="2"><p><strong>-s/--scenario</strong> <em>scenario-template</em></p>
710
+ <blockquote>
711
+ <p>Specify the Scenario template to run (must be xml).</p>
712
+ </blockquote></td>
713
+ </tr>
714
+ <tr class="wide">
715
+ <td colspan="2"><p><strong>-t/--testset </strong><em>testset-template</em></p>
716
+ <blockquote>
717
+ <p>Specify the Test Set template to run (must be xml).</p>
718
+ </blockquote></td>
719
+ </tr>
720
+ <tr class="wide">
721
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
722
+ <blockquote>
723
+ <p>Set
724
+ the Logger::DEBUG level.</p>
725
+ </blockquote></td>
648
726
  </tr>
649
727
  </table>
650
728
  <p><a href="#top">back to top &uarr;</a></p>
651
729
  <h2><a name="cmd_runscenario" id="cmd_runscale3"></a>cmd_runscenario</h2>
652
730
  <p>Use to load and verify a Scenario template (.xml file). Supports command-line options for configuring the Test Bed with Mu interfaces and/or network hosts.</p>
653
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
731
+ <table border="0" cellpadding="1" cellspacing="1" class="outline">
654
732
  <tr>
655
- <th>Command</th>
656
- <th>Commands &amp; Examples</th>
733
+ <th width="97">Command</th>
734
+ <th width="470">Examples</th>
657
735
  </tr>
658
736
  <tr>
659
- <td><em>help</em></td>
737
+ <td valign="top"><p><em>help</em></p></td>
660
738
  <td><p>Gets help for all cmd_runscenario commands: <strong>help</strong></p>
661
- <h6 class="code">mu cmd_runscenario:help</h6></td>
739
+ <p class="code_black_background">mu cmd_runscenario:help</p></td>
662
740
  </tr>
663
741
  <tr>
664
- <td><h5>run</h5></td>
742
+ <td height="69" valign="top"><p><em>run</em></p></td>
665
743
  <td><p>Runs the specified Scenario template: <strong>run -s</strong> <em>scenario.xml</em><strong> -i</strong><em> interfaces/hosts</em></p>
666
- <h6 class="code">mu cmd_runscenario:run -s my_scenario -i a1,my-server</h6></td>
667
- </tr>
668
- </table>
669
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
670
- <tr>
671
- <th colspan="2">Options (short &amp; long form)</th>
672
- <th width="60%">Description</th>
673
- </tr>
674
- <tr>
675
- <td width="4%">-c</td>
676
- <td width="36%"><strong>--channels</strong> <em>hosts</em></td>
677
- <td>Specify channel hosts as a comma-separated list. </td>
678
- </tr>
679
- <tr>
680
- <td>-d</td>
681
- <td><strong>--dir</strong> <em>directory</em></td>
682
- <td>Specify the directory with Scenario templates to run.</td>
683
- </tr>
684
- <tr>
685
- <td>-h</td>
686
- <td><strong>--help</strong></td>
687
- <td>Get help on command line options.</td>
688
- </tr>
689
- <tr>
690
- <td>-i</td>
691
- <td><strong>--interfaces</strong> <em>interfaces</em></td>
692
- <td>Specify Mu interfaces and network hosts as a comma-separated list. Example: <span class="code">b1, b2</span>. When using an IP range, specify range/offset. Example: <span class="code">b1-1000:0,web-server</span></td>
693
- </tr>
694
- <tr>
695
- <td>-m</td>
696
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
697
- <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
698
- </tr>
699
- <tr>
700
- <td>-o</td>
701
- <td><strong>--output</strong> <em>filename</em></td>
702
- <td>Specify the filename to which you want to output logs.</td>
703
- </tr>
704
- <tr>
705
- <td>-s</td>
706
- <td><strong>--scenario</strong> <em>scenario-template</em></td>
707
- <td>Specify the Scenario template to run (must be xml).</td>
708
- </tr>
709
- <tr>
710
- <td>-v</td>
711
- <td><strong>--verbose</strong></td>
712
- <td>Set
713
- the Logger::DEBUG level.</td>
714
- </tr>
715
- </table>
716
- <p><a href="#top">back to top &uarr;</a></p>
717
- <p>&nbsp;</p>
718
- <h3><a name="api-methods" id="features"></a>API Methods</h3>
719
- <p>These commands provide access to legacy REST API commands supported by the Mu system. </p>
720
- <ul>
721
- <li><a href="#cmd_muapi">cmd_muapi</a></li>
722
- <li><a href="#cmd_netconfig">cmd_netconfig</a></li>
723
- <li><a href="#cmd_ddt">cmd_ddt</a></li>
724
- <li><a href="#cmd_scale">cmd_scale</a></li>
725
- <li><a href="#cmd_homepage">cmd_homepage</a></li>
726
- <li><a href="#cmd_system">cmd_system</a></li>
727
- <li><a href="#cmd_cli">cmd_cli</a> </li>
728
- </ul>
729
- <h2><a name="cmd_muapi" id="cmd_runscale5"></a>cmd_muapi</h2>
730
- <p>Use to access the legacy REST API for Test Runs (Protocol Mutation, Scenario Mutation, DoS, and PV tests). </p>
731
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
732
- <tr>
733
- <th>Command</th>
734
- <th>Description &amp; Examples</th>
735
- </tr>
736
- <tr>
737
- <td><em>help</em></td>
738
- <td>Gets help for all cmd_muapi commands: <strong>help</strong>
739
- <h6 class="code">mu cmd_muapi:help</h6></td>
740
- </tr>
741
- <tr>
742
- <td><em>archive</em></td>
743
- <td>Manage archives (reports) for Test Runs. The status and get commands require the job_id returned by the run command. <strong>archive</strong> <strong>-c</strong><em> command </em><strong>-u</strong><em> uuid/job-id</em><br>
744
- <br>
745
- <h6 class="code">mu cmd_muapi:archive -c run -u 52add3cf-9040-42ce-b263-8233039931d5</h6>
746
- <p>Get the status of the archive report:</p>
747
- <h6><span class="code">mu cmd_muapi:archive -c status -u 1296064526931</span></h6>
748
- <p>Download the archive report:
749
- </p>
750
- <h6><span class="code">mu cmd_muapi:archive -c get -u 1296064526931</span></h6></td>
751
- </tr>
752
- <tr>
753
- <td><em>backup</em></td>
754
- <td>Manage system backup files. <strong>backup</strong> <strong>-c</strong><em> command</em>
755
- <p>Generate system backup:</p>
756
- <h6 class="code">mu cmd_muapi:backup -c run</h6>
757
- <p>Get the status of the backup job:</p>
758
- <h6><span class="code">mu cmd_muapi:backup -c status</span></h6>
759
- <p>Download the backup file (requires a name): <strong>backup</strong> <strong>-c</strong> <strong>get -n</strong><em> filename</em></p>
760
- <h6><span class="code">mu cmd_muapi:backup -c get -n my-backup</span></h6>
761
- <p>The Mu system automatically appends the .dat extension to all backup files.</p></td>
762
- </tr>
763
- <tr>
764
- <td><em>capture</em></td>
765
- <td>Manage pcaps recorded by the Mu system. The <strong>status</strong> and <strong>get</strong> commands require the job-id returned by the run command: <strong>capture</strong> <strong>-c</strong><em> command </em><strong>-p</strong><em> port-number</em><strong> -u</strong><em> job-id</em>
766
- <p>Start recording packets (this command returns the job-id):</p>
767
- <h6 class="code">mu cmd_muapi:capture -c run -p a1</h6>
768
- <p>Get the status of the packet recording job:</p>
769
- <h6><span class="code">mu cmd_muapi:capture -c status -p a1 -u 1296064526931</span></h6>
770
- <p>Download the recorded packet capture: </p>
771
- <h6><span class="code">mu cmd_muapi:capture -c get -p a1 -u 1296064526931</span></h6></td>
772
- </tr>
773
- <tr>
774
- <td><em>delete</em></td>
775
- <td>Delete the specified Test Run or template: <strong>delete -u</strong> <em>uuid</em>
776
- <h6 class="code">mu cmd_muapi:delete -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
777
- </tr>
778
- <tr>
779
- <td><em>export_by_name</em></td>
780
- <td>Export the specified template: <strong>export_by_name -n</strong> <em>name</em>
781
- <strong>-t</strong> <em>type</em>
782
- <h6 class="code">mu cmd_muapi:export_by_name -n my_monitor -t monitor</h6></td>
783
- </tr>
784
- <tr>
785
- <td><em>get_faults</em></td>
786
- <td>Get a list of faults (xml format) from a Test Run: <strong>get_faults -u</strong> <em>uuid</em> <strong>-v</strong>
787
- <h6 class="code">mu cmd_muapi:get_faults -u 52add3cf-9040-42ce-b263-8233039931d5 -v</h6></td>
788
- </tr>
789
- <tr>
790
- <td><em>get_name</em></td>
791
- <td>Get details for the specified Test Run or template: <strong>get_name -u</strong> <em>uuid</em>
792
- <h6><span class="code">mu cmd_muapi:get_name -u 52add3cf-9040-42ce-b263-8233039931d5</span></h6></td>
793
- </tr>
794
- <tr>
795
- <td><em>list</em></td>
796
- <td>&nbsp;Get a list of templates by type: <strong>list -t</strong> <em>template-type</em> <h6 class="code">mu cmd_muapi:list -t monitor</h6></td>
797
- </tr>
798
- <tr>
799
- <td><em>list_by_status</em></td>
800
- <td>Get a list of Test Runs by status: <strong>list_by_status -s</strong><em> status</em>
801
- <h6 class="code">mu cmd_muapi:list_by_status -s finished</h6></td>
802
- </tr>
803
- <tr>
804
- <td><em>pause</em></td>
805
- <td>Pause a Test Run: <strong>pause -u</strong> <em>uuid</em>
806
- <h6 class="code">mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
807
- </tr>
808
- <tr>
809
- <td><em>resume</em></td>
810
- <td>Resume a Test Run: <strong>resume -u</strong> <em>uuid</em>
811
- <h6 class="code">mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
812
- </tr>
813
- <tr>
814
- <td><em>run</em></td>
815
- <td>Start a Test Run (to rename, use the -b argument): <strong>run -u</strong> <em>uuid</em> [<strong>-b</strong> <em>new-name</em>]
816
- <h6 class="code">mu cmd_muapi:run -u 52add3cf-9040-42ce-b263-8233039931d5 -b true</h6></td>
817
- </tr>
818
- <tr>
819
- <td><em>status</em></td>
820
- <td>Get the status of a Test Run: <strong>status -u</strong> <em>uuid</em>
821
- <h6 class="code">mu cmd_muapi:status -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
822
- </tr>
823
- <tr>
824
- <td><em>stop</em></td>
825
- <td>Stop a Test Run: <strong>stop -u</strong> <em>uuid</em>
826
- <h6 class="code">mu cmd_muapi:stop -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
827
- </tr>
828
- <tr>
829
- <td><em>types</em></td>
830
- <td>Get a list of all template types: <strong>types</strong><em></em>
831
- <h6 class="code">mu cmd_muapi:types</h6></td>
832
- </tr>
833
- </table>
834
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
835
- <tr>
836
- <th colspan="2">Options (short &amp; long form)</th>
837
- <th width="60%">Description</th>
838
- </tr>
839
- <tr>
840
- <td width="4%">-b</td>
841
- <td width="36%"><strong>--boolean</strong> <em>value</em></td>
842
- <td>Specify a boolean value (<span class="code">true</span> or <span class="code">false</span>). </td>
843
- </tr>
844
- <tr>
845
- <td>-c</td>
846
- <td><strong>--command</strong><em> command</em></td>
847
- <td>Specify the command to run (run, get, status, etc.)</td>
848
- </tr>
849
- <tr>
850
- <td>-m</td>
851
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
852
- <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
853
- </tr>
854
- <tr>
855
- <td>-n</td>
856
- <td><strong>--name</strong> <em>name</em></td>
857
- <td>Specify a Test Run or template name.</td>
858
- </tr>
859
- <tr>
860
- <td>-o</td>
861
- <td><strong>--output</strong> <em>filename</em></td>
862
- <td>Specify the filename to which you want to output logs.</td>
863
- </tr>
864
- <tr>
865
- <td>-p</td>
866
- <td><strong>--port</strong> <em>port-number</em></td>
867
- <td>Specify the port number.</td>
868
- </tr>
869
- <tr>
870
- <td>-s</td>
871
- <td><strong>--status</strong> <em>status</em></td>
872
- <td>Specify the status filter (<span class="code">running</span>, <span class="code">finished</span>, <span class="code">aborted</span> <span class="code">queued</span>, or <span class="code">failed</span>)</td>
873
- </tr>
874
- <tr>
875
- <td>-t</td>
876
- <td><strong>--type</strong><em> template-type</em></td>
877
- <td>Specify the type of template.</td>
878
- </tr>
879
- <tr>
880
- <td>-u</td>
881
- <td><strong>--uuid</strong><em> uuid/job-id</em></td>
882
- <td>Specify the UUID of the template to run. For archive, backup, and capture commands, this option takes a job-id value.</td>
883
- </tr>
884
- <tr>
885
- <td>-v</td>
886
- <td><strong>--verbose</strong></td>
887
- <td>Set
888
- the Logger::DEBUG level.</td>
889
- </tr>
890
- </table>
891
- <p><a href="#top">back to top &uarr;</a></p>
892
- <h2><a name="cmd_netconfig" id="cmd_runscale6"></a>cmd_netconfig</h2>
893
- <p>Use to access the legacy REST API for configuring Mu interfaces, network hosts, and routes.</p>
894
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
895
- <tr>
896
- <th>Command</th>
897
- <th>Description &amp; Examples</th>
898
- </tr>
899
- <tr>
900
- <td><em>help</em></td>
901
- <td>Gets help for all cmd_netconfig commands: <strong>help</strong>
902
- <h6 class="code">mu cmd_netconfig:help</h6></td>
903
- </tr>
904
- <tr>
905
- <td><em>clear_hosts</em></td>
906
- <td><p>Remove all network hosts configured in the Mu system: <strong>clear_hosts</strong></p>
907
- <h6><span class="code">mu cmd_netconfig:clear_hosts</span></h6></td>
908
- </tr>
909
- <tr>
910
- <td><em>clear_interfaces</em></td>
911
- <td><p>Clear settings for specified Mu interfaces: <strong>clear_interfaces -i</strong> <em>interfaces</em></p>
912
- <h6><span class="code">mu cmd_netconfig:clear_interfaces -i b1,b2</span></h6></td>
913
- </tr>
914
- <tr>
915
- <td><em>clear_routes</em></td>
916
- <td><p>Remove all user-configured routes in the Mu system: <strong>clear_routes</strong></p>
917
- <h6><span class="code">mu cmd_netconfig:clear_routes</span></h6></td>
918
- </tr>
919
- <tr>
920
- <td><em>clear_vlans</em></td>
921
- <td><p>Remove all vlans for all Mu interfaces: <strong>clear_vlans</strong></p>
922
- <h6><span class="code">mu cmd_netconfig:clear_vlans</span></h6></td>
923
- </tr>
924
- <tr>
925
- <td><em>create</em></td>
926
- <td><p>Create a network object such as a host or route: <strong>create -j </strong><em>object</em><strong> -e </strong><em>value</em> </p>
927
- <h6><span class="code">mu cmd_netconfig:create -j {&quot;default&quot;: false,&quot;direct&quot;: false,&quot;dst&quot;: &quot;10.0.0.0&quot;,&quot;dst_pfx_len&quot;: 8,&quot;gateway&quot;: &quot;192.168.100.1&quot;,&quot;interface&quot;: &quot;a1&quot;,&quot;interface_display_name&quot;: &quot;A1&quot;,&quot;metric&quot;: 1,&quot;readonly&quot;: false} -e route</span></h6></td>
744
+ <p class="code_black_background">mu cmd_runscenario:run -s my_scenario -i a1,my-server</p></td>
928
745
  </tr>
929
746
  <tr>
930
- <td><em>delete</em></td>
931
- <td><p>Delete a network object such as host or route: <strong>delete </strong><strong>-e </strong><em>value</em> </p>
932
- <h6><span class="code">mu cmd_netconfig:delete -e Web-Server</span></h6></td>
747
+ <th colspan="2">Options</th>
933
748
  </tr>
934
749
  <tr>
935
- <td><em>get</em></td>
936
- <td><p>Get details for a network object: <strong>get </strong><strong>-e </strong><em>value</em></p>
937
- <h6><span class="code">mu cmd_netconfig:get -e a1</span></h6></td>
750
+ <td colspan="2"><p><strong>-c/--channels</strong> <em>hosts</em></p>
751
+ <blockquote>
752
+ <p>Specify channel hosts as a comma-separated list. </p>
753
+ </blockquote></td>
938
754
  </tr>
939
755
  <tr>
940
- <td><em>modify</em></td>
941
- <td><p>Modify a network object such as a host or route:<strong>modify -j </strong><em>object </em><strong>-e </strong><em>value</em></p>
942
- <h6><span class="code">mu cmd_netconfig:modify -j {&quot;mac&quot;: &quot;&quot;,&quot;name&quot;: &quot;Web-Server&quot;,&quot;notes&quot;: &quot;&quot;,&quot;v4_addr&quot;: &quot;192.168.112.205&quot;,&quot;v6_global_addr&quot;: &quot;&quot;,&quot;v6_local_addr&quot;: &quot;&quot;} -e host</span></h6></td>
756
+ <td colspan="2"><p><strong>-d/--dir</strong> <em>directory</em></p>
757
+ <blockquote>
758
+ <p>Specify the directory with Scenario templates to run.</p>
759
+ </blockquote></td>
943
760
  </tr>
944
761
  <tr>
945
- <td><em>resolve_hosts</em></td>
946
- <td><p>Get IP address for specified network host: <strong>resolve_hosts </strong><em>host</em></p>
947
- <h6><span class="code">mu cmd_netconfig:resolve_hosts Web-Server</span></h6></td>
762
+ <td colspan="2"><p><strong>-h/--help</strong></p>
763
+ <blockquote>
764
+ <p>Get help on command line options.</p>
765
+ </blockquote></td>
948
766
  </tr>
949
767
  <tr>
950
- <td><em>restore</em></td>
951
- <td><p>Restore from specified file (to overwrite existing object, use the -b argument): <strong>restore -f </strong><em>filepath </em>[<strong>-b</strong> <em>clear-existing</em>]</p>
952
- <h6><span class="code">mu cmd_netconfig:restore -f my_muhosts/web-server.json true</span></h6></td>
768
+ <td colspan="2"><p><strong>-i/--interfaces</strong> <em>interfaces</em></p>
769
+ <blockquote>
770
+ <p>Specify Mu interfaces and network hosts as a comma-separated list. Example: <span class="code">b1, b2</span>. When using an IP range, specify range/offset. Example: <span class="code">b1-1000:0,web-server</span></p>
771
+ </blockquote></td>
953
772
  </tr>
954
773
  <tr>
955
- <td><em>save</em></td>
956
- <td><p>Save changes to the Mu system: <strong>save</strong></p>
957
- <h6><span class="code">mu cmd_netconfig:save</span></h6></td>
958
- </tr>
959
- </table>
960
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
961
- <tr>
962
- <th colspan="2">Options (short &amp; long form)</th>
963
- <th width="60%">Description</th>
964
- </tr>
965
- <tr>
966
- <td width="4%">-b</td>
967
- <td width="36%"><strong>--boolean</strong> <em>value</em></td>
968
- <td>Specify a boolean value (true or false). </td>
969
- </tr>
970
- <tr>
971
- <td>-e</td>
972
- <td><strong>--element</strong><em> value</em></td>
973
- <td>Specify a value for the associated command. Example: <span class="code">interfaces</span> or <span class="code">interfaces/a1</span></td>
974
- </tr>
975
- <tr>
976
- <td>-f</td>
977
- <td><strong>--filepath</strong><em> filepath</em></td>
978
- <td>Specify the path to a file. </td>
979
- </tr>
980
- <tr>
981
- <td>-h</td>
982
- <td><strong>--help</strong></td>
983
- <td>Get help on command line options.</td>
984
- </tr>
985
- <tr>
986
- <td>-i</td>
987
- <td><strong>--interfaces</strong> <em>interface-or-host</em></td>
988
- <td>Specify Mu interfaces or network hosts as a comma-separated list. Example: <span class="code">b1, web-server</span>. </td>
989
- </tr>
990
- <tr>
991
- <td>-j</td>
992
- <td><strong>--json</strong> <em>object</em></td>
993
- <td>Specify a json object as a text string.</td>
774
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
775
+ <blockquote>
776
+ <p>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
777
+ </blockquote></td>
994
778
  </tr>
995
779
  <tr>
996
- <td>-m</td>
997
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
998
- <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
780
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
781
+ <blockquote>
782
+ <p>Specify the filename to which you want to output logs.</p>
783
+ </blockquote></td>
999
784
  </tr>
1000
785
  <tr>
1001
- <td>-o</td>
1002
- <td><strong>--output</strong> <em>filename</em></td>
1003
- <td>Specify the filename to which you want to output logs.</td>
786
+ <td colspan="2"><p><strong>-s/--scenario</strong> <em>scenario-template</em></p>
787
+ <blockquote>
788
+ <p>Specify the Scenario template to run (must be xml).</p>
789
+ </blockquote></td>
1004
790
  </tr>
1005
791
  <tr>
1006
- <td>-v</td>
1007
- <td><strong>--verbose</strong></td>
1008
- <td>Set
1009
- the Logger::DEBUG level.</td>
792
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
793
+ <blockquote>
794
+ <p>Set
795
+ the Logger::DEBUG level.</p>
796
+ </blockquote></td>
1010
797
  </tr>
1011
798
  </table>
1012
799
  <p><a href="#top">back to top &uarr;</a></p>
1013
- <h2><a name="cmd_ddt" id="cmd_runscale7"></a>cmd_ddt</h2>
1014
- <p>Use to access the legacy REST API for Test Sets (Studio Verify).</p>
1015
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1016
- <tr>
1017
- <th>Command</th>
1018
- <th>Description &amp; Examples</th>
1019
- </tr>
1020
- <tr>
1021
- <td><em>display_results</em></td>
1022
- <td>Displays results for the current Test Set:
1023
- <strong>display_results</strong> <h6 class="code">mu cmd_ddt:display_results</h6></td>
1024
- </tr>
1025
- <tr>
1026
- <td><em>new_session</em></td>
1027
- <td>Create a new session: <strong>new_session</strong>
1028
- <h6 class="code">mu cmd_ddt:new_session</h6></td>
1029
- </tr>
1030
- <tr>
1031
- <td><em>load_scenario</em></td>
1032
- <td>Load the specified Scenario template:
1033
- <strong>load_scenario -u </strong><em>uuid</em> <h6 class="code">mu cmd_ddt:load_scenario -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
1034
- </tr>
1035
- <tr>
1036
- <td><em>get_hosts</em></td>
1037
- <td>Get a list of hosts in the Test Bed:
1038
- <strong>get_hosts</strong> <h6 class="code">mu cmd_ddt:get_hosts</h6></td>
1039
- </tr>
1040
- <tr>
1041
- <td><em>set_hosts</em></td>
1042
- <td>Configure the hosts in the Test Bed: <strong>set_hosts</strong>
1043
- <strong>-r</strong> <em>role</em> <strong>-n</strong> <em>name</em> <strong>-y</strong> <em>type</em> <h6 class="code">mu cmd_ddt:set_hosts -r HTTP_Client,HTTP_Server -n a1,Web-Server -y v4</h6></td>
1044
- </tr>
1045
- <tr>
1046
- <td><em>get_channels</em></td>
1047
- <td>Get a list of channels in the Test Bed: <strong>get_channels</strong>
1048
- <h6 class="code">mu cmd_ddt:get_channels</h6></td>
1049
- </tr>
1050
- <tr>
1051
- <td><em>set_channels</em></td>
1052
- <td>Configure the channels in the Test Bed: <strong>set_channels</strong> <strong>-r</strong> <em>role</em> <strong>-n</strong> <em>name</em>
1053
- <h6 class="code">mu cmd_ddt:set_channels -r SSH_Channel -n Web-Server</h6></td>
1054
- </tr>
1055
- <tr>
1056
- <td><em>get_options</em></td>
1057
- <td>Get a list of options in the Test Set: <strong>get_options</strong>
1058
- <h6 class="code">mu cmd_ddt:get_options</h6></td>
1059
- </tr>
1060
- <tr>
1061
- <td><em>set_options</em></td>
1062
- <td>Configure the option values for the Test Set: <strong>set_options</strong> <strong>-n</strong> <em>name</em> <strong>-p</strong> <em>value</em>
1063
- <h6 class="code">mu cmd_ddt:set_options -n username -p jsmith</h6></td>
1064
- </tr>
1065
- <tr>
1066
- <td><em>get_sessions</em></td>
1067
- <td>Get a list of all sessions: <strong>get_sessions</strong>
1068
- <h6 class="code">mu cmd_ddt:get_sessions</h6></td>
1069
- </tr>
1070
- <tr>
1071
- <td><em>setup_test</em></td>
1072
- <td>Setup the Test Bed, reserving the Mu interfaces:
1073
- <strong>setup_test</strong> <h6 class="code">mu cmd_ddt:setup_test</h6></td>
1074
- </tr>
1075
- <tr>
1076
- <td><em>run</em></td>
1077
- <td>Run a Test Set: <strong>run</strong>
1078
- <h6 class="code">mu cmd_ddt:run</h6></td>
1079
- </tr>
1080
- <tr>
1081
- <td><em>run_testset</em></td>
1082
- <td>Run the specified Test Set: <strong>run_testset -u</strong> <em>uuid</em> <h6 class="code">mu cmd_ddt:run_testset -u 04aa248a-0b9b-4bf6-97e1-aab691d0acf1</h6></td>
1083
- </tr>
800
+ <h2><a name="cmd_musl" id="cmd_runscale13"></a>cmd_musl</h2>
801
+ <p>Use to create .msl files from <strong>H</strong>TTP <strong>Ar</strong>chive (.har) files, which capture web page loading information in JSON format. You can use the <strong>from_har</strong> command to transform a .har file into a Scenario (in .msl format) suitable for import into Mu Studio.</p>
802
+ <table border="0" cellpadding="1" cellspacing="1" class="outline">
1084
803
  <tr>
1085
- <td><em>get_testset_results</em></td>
1086
- <td>Get results for the current Test Set: <strong>get_testset_results</strong>
1087
- <h6 class="code">mu cmd_ddt:get_testset_results</h6></td>
804
+ <th width="97">Command</th>
805
+ <th width="470">Examples</th>
1088
806
  </tr>
1089
807
  <tr>
1090
- <td><em>get_testset_status</em></td>
1091
- <td>Get status for the current Test Set: <strong>get_testset_status</strong>
1092
- <h6 class="code">mu cmd_ddt:get_testset_status</h6></td>
808
+ <td valign="top"><p><em>help</em></p></td>
809
+ <td><p>Gets help for all cmd_musl commands: <strong>help</strong></p>
810
+ <p class="code_black_background"><strong>mu cmd_musl:help</strong></p></td>
1093
811
  </tr>
1094
812
  <tr>
1095
- <td><em>teardown_test</em></td>
1096
- <td>Unsets the Test Bed selections, releasing the Mu interfaces: <strong>teardown_test</strong>
1097
- <h6 class="code">mu cmd_ddt:teardown_test</h6></td>
813
+ <td height="69" valign="top"><p><em>from_har</em></p></td>
814
+ <td><p>Creates a .msl file from the specified .har file: <strong>from_har </strong><em>options</em><strong> -s</strong><em>scenario_filename.msl har_filename.har</em> . If you omit the scenario filename, the output .msl file uses the har_filename. </p>
815
+ <p class="code_black_background"><strong>mu cmd_musl:from_har --ignore-images -s </strong>my_scenario.msl my_har_file<strong>.har</strong></p></td>
1098
816
  </tr>
1099
817
  <tr>
1100
- <td><em>close_session</em></td>
1101
- <td>Closes the current session: <strong>close_session</strong>
1102
- <h6 class="code">mu cmd_ddt:close_session</h6></td>
818
+ <td height="69" valign="top"><p><em>escape</em></p></td>
819
+ <td><p>Escape special javascript characters ( $ , &quot; , ' ) in the return payload of the .msl file<strong> : escape </strong><strong> -s</strong> <em>filename.msl</em></p>
820
+ <p class="code_black_background"><strong>mu cmd_musl:escape -s</strong> <em>my_scenario</em><strong>.msl</strong> <strong>-o</strong> escaped_characters.js</p></td>
1103
821
  </tr>
1104
822
  <tr>
1105
- <td><em>close_all_sessions</em></td>
1106
- <td>Closes all existing sessions: <strong>close_all_sessions</strong>
1107
- <h6 class="code">mu cmd_ddt:close_all_sessions</h6></td>
1108
- </tr>
1109
- tr>
1110
- <td><em>csv_export</em></td>
1111
- <td>Exports a Test Set from the Mu system to a. csv file: <strong>csv_export</strong>
1112
- <strong>-u</strong> <em>uuid</em> <h6 class="code">mu cmd_ddt:csv_export -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
823
+ <td height="69" valign="top"><p><em>bin2hex</em></p></td>
824
+ <td><p>Convert a binary file into a hex string that can be included in a Scenario response: <strong>bin2hex </strong><strong> -s</strong> <em>filename.msl</em></p>
825
+ <p class="code_black_background"><strong>mu cmd_musl:bin2hex -s</strong> <em>my_scenario</em><strong>.msl</strong> <strong>-o</strong> hex_string_file</p></td>
1113
826
  </tr>
1114
- tr>
1115
- <td><em>csv_import</em></td>
1116
- <td>Imports a .csv file to create a Test Set on the Mu system: <strong>csv_import</strong>
1117
- <strong>-t</strong><em> filename.csv</em>
1118
- <h6 class="code">mu cmd_ddt:csv_import -t my-testset.csv</h6></td>
1119
- </tr>
1120
- </table>
1121
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1122
827
  <tr>
1123
- <th colspan="2">Options (short &amp; long form)</th>
1124
- <th width="60%">Description</th>
828
+ <th colspan="2">Options</th>
1125
829
  </tr>
1126
830
  <tr>
1127
- <td width="4%">-f</td>
1128
- <td width="36%"><strong>--filename</strong><em> filename</em></td>
1129
- <td>Specify the template name for saving an imported Test Set.</td>
831
+ <td colspan="2"><p><strong>-h/--help</strong></p>
832
+ <blockquote>
833
+ <p>Get help on command line options.<br>
834
+ </p>
835
+ </blockquote></td>
1130
836
  </tr>
1131
837
  <tr>
1132
- <td>-h</td>
1133
- <td><strong>--help</strong></td>
1134
- <td>Get help on command line options.</td>
838
+ <td colspan="2"><p><strong>--ignore-non-essentials</strong></p>
839
+ <blockquote>
840
+ <p>Ignore unknown application files, Javascript (js) files, Cascading Style Sheet (css) files, and all image files.</p>
841
+ </blockquote></td>
1135
842
  </tr>
1136
843
  <tr>
1137
- <td>-m</td>
1138
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1139
- <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
844
+ <td colspan="2"><p><strong>--ignore-images</strong></p>
845
+ <blockquote>
846
+ <p>Ignore image files.</p>
847
+ </blockquote></td>
1140
848
  </tr>
1141
849
  <tr>
1142
- <td>-n</td>
1143
- <td><strong>--names</strong> <em>name-array</em></td>
1144
- <td>Specify host names or channel names in a comma-separated array. Example: <span class="code">a1,Web-Serve</span>r</td>
850
+ <td colspan="2"><p><strong>--ignore-css</strong></p>
851
+ <blockquote>
852
+ <p>Ignore CSS files.</p>
853
+ </blockquote></td>
1145
854
  </tr>
1146
855
  <tr>
1147
- <td>-o</td>
1148
- <td><strong>--output</strong> <em>filename</em></td>
1149
- <td>Specify the filename to which you want to output logs.</td>
856
+ <td colspan="2"><p><strong>--ignore-js</strong></p>
857
+ <blockquote>
858
+ <p>Ignore Javascript (js) files.</p>
859
+ </blockquote></td>
1150
860
  </tr>
1151
861
  <tr>
1152
- <td>-p</td>
1153
- <td><strong>--option_values</strong> <em>value-array</em></td>
1154
- <td>Specify values for Test Set options in a comma-separated array. Example: <span class="code">bob,jane,mary,tom</span></td>
862
+ <td colspan="2"><p><strong>--ignore-payload</strong></p>
863
+ <blockquote>
864
+ <p>Ignore the content payload.</p>
865
+ </blockquote></td>
1155
866
  </tr>
1156
867
  <tr>
1157
- <td>-r</td>
1158
- <td><strong>--roles</strong> <em>role-array</em></td>
1159
- <td>Specify host roles in a comma-separated array. Example: <span class="code">HTTP_Client,HTTP_Server</span></td>
868
+ <td colspan="2"><p><strong>--strip-large-content </strong>[<em>size</em>] </p>
869
+ <blockquote>
870
+ <p>Replace large blocks of response content with a repeated field.</p>
871
+ </blockquote></td>
1160
872
  </tr>
1161
873
  <tr>
1162
- <td>-t</td>
1163
- <td><strong>--testset</strong> <em>filename.csv</em></td>
1164
- <td>Specify the name of the .csv file to import. </td>
874
+ <td colspan="2"><p><strong>--skip-ssl-passthru</strong><strong> </strong>[<em>size</em>] </p>
875
+ <blockquote>
876
+ <p>Skip all SSL transport options and structure as TCP. </p>
877
+ </blockquote></td>
1165
878
  </tr>
1166
879
  <tr>
1167
- <td>-u</td>
1168
- <td><strong>--uuid</strong> <em>uuid</em></td>
1169
- <td>Specify the UUID of the Scenario or Test Set.</td>
880
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
881
+ <blockquote>
882
+ <p>Specify the filename of the output file. For <span class="code"><strong>escape</strong></span> output, the output file is typically a .js file. For <span class="code"><strong>bin2hex</strong></span> output, you can assign the file extension of your choice.</p>
883
+ </blockquote></td>
1170
884
  </tr>
1171
885
  <tr>
1172
- <td>-v</td>
1173
- <td><strong>--verbose</strong></td>
1174
- <td>Set
1175
- the Logger::DEBUG level.</td>
886
+ <td colspan="2"><p><strong>-s/--scenario</strong> <em>filename</em></p>
887
+ <blockquote>
888
+ <p>Specify the name of the msl file. When this option is not used in the command, the system uses the har filename as the msl filename. </p>
889
+ </blockquote></td>
1176
890
  </tr>
1177
891
  <tr>
1178
- <td>-y</td>
1179
- <td><strong>--type</strong> <em>type</em></td>
1180
- <td>Specify network layer (v4, v6, l2) for all hosts in the Test Bed. Example: <span class="code">v4</span></td>
1181
- </tr>
1182
- </table>
1183
- <p><a href="#top">back to top &uarr;</a></p>
1184
- <h2><a name="cmd_scale" id="cmd_runscale8"></a>cmd_scale</h2>
1185
- <p>Use to access the legacy REST API for Scale tests (Studio Scale). </p>
1186
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1187
- <tr>
1188
- <th>Command</th>
1189
- <th>Description &amp; Examples</th>
1190
- </tr>
1191
- <tr>
1192
- <td><em>about</em></td>
1193
- <td>Lists information for the Scale Player and all active and inactive Scale Engines: <strong>about</strong>
1194
- <h6 class="code">mu cmd_scale:about</h6></td>
1195
- </tr>
1196
- <tr>
1197
- <td><em>configure</em></td>
1198
- <td>Configure any element of the scale json object : <strong>configure -p </strong><em>parameter</em><strong> -pv </strong><em>value
1199
- </em>
1200
- <h6 class="code">mu cmd_scale:configure -p json_element -pv json_element_value</h6></td>
1201
- </tr>
1202
- <tr>
1203
- <td><em>data</em></td>
1204
- <td>Gets chart data for the Scale test: <strong>data -w</strong> <em>view</em> <strong> -z</strong> <em>zoom</em> <strong>-ps</strong> <em>position</em> <strong>-b</strong> <em>bot_id</em> <h6 class="code">mu cmd_scale:data -w TIMELINE -z 1 -ps 0 -b bots_10.10.6.200:1</h6></td>
1205
- </tr>
1206
- <tr>
1207
- <td><em>delete_scale_engine </em></td>
1208
- <td>Delete the specified Scale Engine:<strong>delete_scale_engine -b</strong> <em>bot_id</em> <h6 class="code">mu cmd_scale:delete_scale_engine -b bots_10.10.6.200:1</h6></td>
1209
- </tr>
1210
- <tr>
1211
- <td><em>help</em></td>
1212
- <td>Gets help for all cmd_scale commands: <strong>help</strong>
1213
- <h6 class="code">mu cmd_scale:help</h6></td>
1214
- </tr>
1215
- <tr>
1216
- <td><em>list</em></td>
1217
- <td>Returns the current Scale Player's UUID: <strong>list</strong>
1218
- <h6 class="code">mu cmd_scale:list</h6></td>
1219
- </tr>
1220
- <tr>
1221
- <td><em>pattern</em></td>
1222
- <td>Gets the pattern for the Scale test: <strong>pattern </strong><strong>-z</strong> <em>zoom</em> <strong>-ps</strong> <em>position</em>
1223
- <h6 class="code">mu cmd_scale:pattern -z 1 -ps 0</h6></td>
1224
- </tr>
1225
- <tr>
1226
- <td><em>pcap</em></td>
1227
- <td>Gets a pcap from a specific Scale Engine: <strong>pcap </strong> <strong>-b</strong> <em>bot_id</em> <strong>-f</strong> <em>filename</em> <h6 class="code">mu cmd_scale:pcap -b bots_10.10.6.200:1 -f bot_1_pcap</h6></td>
1228
- </tr>
1229
- <tr>
1230
- <td><em>release</em></td>
1231
- <td>Release the Scale Player:
1232
- <strong>release</strong> <h6 class="code">mu cmd_scale:release</h6></td>
1233
- </tr>
1234
- <tr>
1235
- <td><em>release_scale_engine </em></td>
1236
- <td>Releases the specified Scale Engine:<strong>release_scale_engine -b</strong> <em>bot_id</em>
1237
- <h6 class="code">mu cmd_scale:release_scale_engine -b bots_10.10.6.200:1</h6></td>
1238
- </tr>
1239
- <tr>
1240
- <td><em>reserve_scale_engine </em></td>
1241
- <td>Reserves the specified Scale Engine:<strong>reserve_scale_engine -b</strong> <em>bot_id</em>
1242
- <h6 class="code">mu cmd_scale:reserve_scale_engine -b bots_10.10.6.200:1</h6></td>
1243
- </tr>
1244
- <tr>
1245
- <td><em>session</em></td>
1246
- <td>Create a new Scale Player session:
1247
- <strong>session</strong> <h6 class="code">mu cmd_scale:session</h6></td>
1248
- </tr>
1249
- <tr>
1250
- <td><em>start</em></td>
1251
- <td>Start the Scale test: <strong>start</strong>
1252
- <strong>-c</strong> <em>scale-test</em> <strong>-m</strong> <em>user:pass@mu-ip</em> <h6 class="code">mu cmd_scale:start -c scale.json -m admin:admin@10.10.2.2</h6></td>
1253
- </tr>
1254
- <tr>
1255
- <td><em>status</em></td>
1256
- <td>Gets information about the currently running Scale test: <strong>status</strong>
1257
- <h6 class="code">mu cmd_scale:status</h6></td>
1258
- </tr>
1259
- <tr>
1260
- <td><em>statuses</em></td>
1261
- <td>Gets the status of all active and inactive Scale engines: <strong>statuses</strong>
1262
- <h6 class="code">mu cmd_scale:statuses</h6></td>
1263
- </tr>
1264
- <tr>
1265
- <td><em>stop</em></td>
1266
- <td>Stops the Scale test: <strong>stop</strong>
1267
- <h6 class="code">mu cmd_scale:stop</h6></td>
1268
- </tr>
1269
- <tr>
1270
- <td><em>update</em></td>
1271
- <td>Update the pattern dynamically (while the Scale test is running):
1272
- <strong>update -p </strong><em>parameter</em> <strong>-pv</strong> <em>parameter-value</em> <h6 class="code">mu cmd_scale:update -p delay -pv 250 -p volume -pv 100000</h6></td>
1273
- </tr>
1274
- <tr>
1275
- <td><em>verify</em></td>
1276
- <td>Verifies a Scale test: <strong>verify</strong>
1277
- <h6 class="code">mu cmd_scale:verify</h6></td>
1278
- </tr>
1279
- </table>
1280
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1281
- <tr>
1282
- <th colspan="2">Options (short &amp; long form)</th>
1283
- <th width="57%">Description</th>
1284
- </tr>
1285
- <tr>
1286
- <td>-b</td>
1287
- <td><strong>--bot-id</strong> <em>scale-engine-id</em></td>
1288
- <td>Specify a Scale Engine using its bot-id value.</td>
1289
- </tr>
1290
- <tr>
1291
- <td>-c</td>
1292
- <td><strong>--config-file</strong> <em>json-filename</em></td>
1293
- <td>Specify a .json file that contains the configuration data.</td>
1294
- </tr>
1295
- <tr>
1296
- <td width="5%">-f</td>
1297
- <td width="38%"><strong>--filename</strong><em> pcap-filename</em></td>
1298
- <td>Specify a name for the .pcap file.</td>
1299
- </tr>
1300
- <tr>
1301
- <td>-h</td>
1302
- <td><strong>--help</strong></td>
1303
- <td>Get help on command line options.</td>
1304
- </tr>
1305
- <tr>
1306
- <td>-m</td>
1307
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1308
- <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1309
- </tr>
1310
- <tr>
1311
- <td>-o</td>
1312
- <td><strong>--output</strong> <em>filename</em></td>
1313
- <td>Specify the filename to which you want to output logs.</td>
1314
- </tr>
1315
- <tr>
1316
- <td>-p</td>
1317
- <td><strong>--params</strong><em> parameters</em></td>
1318
- <td>Specify parameters for initial configuration or for update. Supports <span class="code">delay</span> and <span class="code">volume</span> parameters.</td>
1319
- </tr>
1320
- <tr>
1321
- <td>-ps</td>
1322
- <td><strong>--view_position</strong><em> value</em></td>
1323
- <td>Specify the position in the timeline view for which to return data. At this time, only position <span class="code">0</span> is supported.</td>
1324
- </tr>
1325
- <tr>
1326
- <td>-pv</td>
1327
- <td><strong>--param_value</strong> <em>value</em></td>
1328
- <td>Specify a value for a parameter.</td>
1329
- </tr>
1330
- <tr>
1331
- <td>-v</td>
1332
- <td><strong>--verbose</strong></td>
1333
- <td>Set
1334
- the Logger::DEBUG level.</td>
1335
- </tr>
1336
- <tr>
1337
- <td>-w</td>
1338
- <td><strong>--view</strong> <em>view</em></td>
1339
- <td>Specify the view (<span class="code">RUNTIME</span> or <span class="code">CALLGRAPH</span>) for which to return data.</td>
1340
- </tr>
1341
- <tr>
1342
- <td>-z</td>
1343
- <td><strong>--zoom</strong> <em>zoom-level</em></td>
1344
- <td>Specify the zoom level (<span class="code">0</span>, <span class="code">.5</span>, or <span class="code">1</span>) in the timeline view for which to return data. 1 returns data for 100% of the time range, 0.5 returns data for 50% of the time range, and 0 returns only the last minute of data. </td>
1345
- </tr>
1346
- </table>
1347
- <p><a href="#top">back to top &uarr;</a></p>
1348
- <h2><a name="cmd_homepage" id="cmd_runscale9"></a>cmd_homepage</h2>
1349
- <p>Use to access information displayed on the Mu UI homepage, such as recent updates, backup status, or a list of latest test results.</p>
1350
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1351
- <tr>
1352
- <th>Command</th>
1353
- <th>Description &amp; Examples</th>
1354
- </tr>
1355
- <tr>
1356
- <td><em>all</em></td>
1357
- <td>Gets the complete set of information displayed on the Mu home page: <strong>all</strong>
1358
- <h6 class="code">mu cmd_homepage:all</h6></td>
1359
- </tr>
1360
- <tr>
1361
- <td><em>help</em></td>
1362
- <td>Gets help for all cmd_homepage commands:
1363
- <strong>help</strong> <h6 class="code">mu cmd_homepage:help</h6></td>
1364
- </tr>
1365
- <tr>
1366
- <td><em>latest_test</em></td>
1367
- <td>Gets an array of the latest test results:
1368
- <strong>latest_test</strong> <h6 class="code">mu cmd_homepage:latest_test</h6></td>
1369
- </tr>
1370
- <tr>
1371
- <td><em>queue_test</em></td>
1372
- <td>Gets an array of tests in the Test Queue: <strong>queue_test</strong>
1373
- <h6 class="code">mu cmd_homepage:queue_test</h6></td>
1374
- </tr>
1375
- <tr>
1376
- <td><em>recent</em></td>
1377
- <td>Gets the "What's New" section from the Mu homepage:
1378
- <strong>recent</strong> <h6 class="code">mu cmd_homepage:recent</h6></td>
1379
- </tr>
1380
- <tr>
1381
- <td><em>status</em></td>
1382
- <td>Gets system status for licenses, backup, and updates: <strong>status</strong>
1383
- <h6 class="code">mu cmd_homepage:status</h6></td>
1384
- </tr>
1385
- </table>
1386
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1387
- <tr>
1388
- <th colspan="2">Options (short &amp; long form)</th>
1389
- <th width="57%">Description</th>
1390
- </tr>
1391
- <tr>
1392
- <td>-h</td>
1393
- <td><strong>--help</strong></td>
1394
- <td>Get help on command line options.</td>
1395
- </tr>
1396
- <tr>
1397
- <td>-m</td>
1398
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1399
- <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1400
- </tr>
1401
- <tr>
1402
- <td>-o</td>
1403
- <td><strong>--output</strong> <em>filename</em></td>
1404
- <td>Specify the filename to which you want to output logs.</td>
1405
- </tr>
1406
- <tr>
1407
- <td>-v</td>
1408
- <td><strong>--verbose</strong></td>
1409
- <td>Set
1410
- the Logger::DEBUG level.</td>
1411
- </tr>
1412
- </table>
1413
- <p><a href="#top">back to top &uarr;</a></p>
1414
- <h2><a name="cmd_system" id="cmd_runscale10"></a>cmd_system</h2>
1415
- <p>Use to restart system services or to get status details for the Mu system. </p>
1416
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1417
- <tr>
1418
- <th>Command</th>
1419
- <th>Description &amp; Examples</th>
1420
- </tr>
1421
- <tr>
1422
- <td><em>restart</em></td>
1423
- <td>Restart Mu system services (this does not reboot the appliance):
1424
- <strong>restart</strong> <h6 class="code">mu cmd_system:restart</h6></td>
1425
- </tr>
1426
- <tr>
1427
- <td><em>status</em></td>
1428
- <td>Gets all information from the system status page: <strong>status</strong><em></em>
1429
- <h6 class="code">mu cmd_system:status</h6></td>
1430
- </tr>
1431
- <tr>
1432
- <td><em>status2</em></td>
1433
- <td>Gets additional system information such as hard drive status, platform model, serial number: <strong>status2</strong> <h6 class="code">mu cmd_system:status2</h6></td>
1434
- </tr>
1435
- </table>
1436
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1437
- <tr>
1438
- <th colspan="2">Options (short &amp; long form)</th>
1439
- <th width="57%">Description</th>
1440
- </tr>
1441
- <tr>
1442
- <td width="5%">-h</td>
1443
- <td width="38%"><strong>--help</strong></td>
1444
- <td>Get help on command line options.</td>
1445
- </tr>
1446
- <tr>
1447
- <td>-m</td>
1448
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1449
- <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1450
- </tr>
1451
- <tr>
1452
- <td>-o</td>
1453
- <td><strong>--output</strong> <em>filename</em></td>
1454
- <td>Specify the filename to which you want to output logs.</td>
1455
- </tr>
1456
- <tr>
1457
- <td>-v</td>
1458
- <td><strong>--verbose</strong></td>
1459
- <td>Set
1460
- the Logger::DEBUG level.</td>
892
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
893
+ <blockquote>
894
+ <p>Set
895
+ the Logger::DEBUG level.</p>
896
+ </blockquote></td>
1461
897
  </tr>
1462
898
  </table>
1463
899
  <p><a href="#top">back to top &uarr;</a></p>
900
+ <h3><a name="api-methods" id="cmd_runscale12"></a>Legacy API Commands </h3>
901
+ <p>These commands provide access to legacy REST API commands supported by the Mu system. </p>
902
+ <ul>
903
+ <li><a href="#cmd_muapi">cmd_muapi</a></li>
904
+ <li><a href="#cmd_netconfig">cmd_netconfig</a></li>
905
+ <li><a href="#cmd_ddt">cmd_ddt</a></li>
906
+ <li><a href="#cmd_scale">cmd_scale</a></li>
907
+ <li><a href="#cmd_homepage">cmd_homepage</a></li>
908
+ <li><a href="#cmd_system">cmd_system</a></li>
909
+ <li><a href="#cmd_cli">cmd_cli</a></li>
910
+ </ul>
911
+ <h2><a name="cmd_muapi" id="cmd_runscale5"></a>cmd_muapi</h2>
912
+ <p>Use to access the legacy REST API for Test Runs (Protocol Mutation, Scenario Mutation, Denial-of-Service, and Published Vulnerability tests). </p>
913
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
914
+ <tr>
915
+ <th colspan="2">cmd_muapi Commands</th>
916
+ </tr>
917
+ <tr>
918
+ <td valign="top"><p><em>help</em></p>
919
+ <p>&nbsp;</p></td>
920
+ <td class="outline"><p>Gets help for all cmd_muapi commands: <strong>help</strong> </p>
921
+ <p class="code_black_background">mu cmd_muapi:help</p></td>
922
+ </tr>
923
+ <tr>
924
+ <td valign="top"><p><em>archive</em></p></td>
925
+ <td class="outline"><p>Manage archives (reports) for Test Runs. The status and get commands require the job_id returned by the run command. <strong>archive</strong> <strong>-c</strong><em> command </em><strong>-u</strong><em> uuid/job-id</em></p>
926
+ <p class="code_black_background">mu cmd_muapi:archive -c run -u 52add3cf-9040-42ce-b263-8233039931d5</p>
927
+ <p>Get the status of the archive report:</p>
928
+ <p class="code_black_background">mu cmd_muapi:archive -c status -u 1296064526931</p>
929
+ <p>Download the archive report: </p>
930
+ <p class="code_black_background">mu cmd_muapi:archive -c get -u 1296064526931</p></td>
931
+ </tr>
932
+ <tr>
933
+ <td valign="top"><p><em>backup</em></p></td>
934
+ <td class="outline"><p>Manage system backup files. <strong>backup</strong> <strong>-c</strong><em> command</em> </p>
935
+ <p>Generate system backup:</p>
936
+ <p class="code_black_background">mu cmd_muapi:backup -c run</p>
937
+ <p>Get the status of the backup job:</p>
938
+ <p class="code_black_background">mu cmd_muapi:backup -c status</p>
939
+ <p>Download the backup file (requires a name): <strong>backup</strong> <strong>-c</strong> <strong>get -n</strong><em> filename</em></p>
940
+ <p class="code_black_background">mu cmd_muapi:backup -c get -n my-backup</p>
941
+ <p>The Mu system automatically appends the .dat extension to all backup files.</p></td>
942
+ </tr>
943
+ <tr>
944
+ <td valign="top"><p><em>capture</em></p></td>
945
+ <td class="outline"><p>Manage packet captures recorded using the Mu system. The <strong>status</strong> and <strong>get</strong> commands require the job-id returned by the run command: <strong>capture</strong> <strong>-c</strong><em> command </em><strong>-p</strong><em> port-number</em><strong> -u</strong><em> job-id</em> </p>
946
+ <p>Start recording packets (this command returns the job-id):</p>
947
+ <p class="code_black_background">mu cmd_muapi:capture -c run -p a1</p>
948
+ <p>Get the status of the packet recording job:</p>
949
+ <p class="code_black_background">mu cmd_muapi:capture -c status -p a1 -u 1296064526931</p>
950
+ <p>Download the recorded packet capture: </p>
951
+ <p class="code_black_background">mu cmd_muapi:capture -c get -p a1 -u 1296064526931</p></td>
952
+ </tr>
953
+ <tr>
954
+ <td valign="top"><p><em>delete</em></p></td>
955
+ <td class="outline"><p>Delete the specified Test Run or template: <strong>delete -u</strong> <em>uuid</em> </p>
956
+ <p class="code_black_background">mu cmd_muapi:delete -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
957
+ </tr>
958
+ <tr>
959
+ <td valign="top"><p><em>export_by_name</em></p></td>
960
+ <td class="outline"><p>Export the specified template: <strong>export_by_name -n</strong> <em>name</em> <strong>-t</strong> <em>type</em> </p>
961
+ <p class="code_black_background">mu cmd_muapi:export_by_name -n my_monitor -t monitor</p></td>
962
+ </tr>
963
+ <tr>
964
+ <td valign="top"><p><em>get_faults</em></p></td>
965
+ <td class="outline"><p>Get a list of faults (xml format) from a Test Run: <strong>get_faults -u</strong> <em>uuid</em> <strong>-v</strong> </p>
966
+ <p class="code_black_background">mu cmd_muapi:get_faults -u 52add3cf-9040-42ce-b263-8233039931d5 -v</p></td>
967
+ </tr>
968
+ <tr>
969
+ <td valign="top"><p><em>get_name</em></p></td>
970
+ <td class="outline"><p>Get details for the specified Test Run or template: <strong>get_name -u</strong> <em>uuid</em> </p>
971
+ <p class="code_black_background">mu cmd_muapi:get_name -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
972
+ </tr>
973
+ <tr>
974
+ <td valign="top"><p><em>list</em></p></td>
975
+ <td class="outline"><p>&nbsp;Get a list of templates by type: <strong>list -t</strong> <em>template-type</em> </p>
976
+ <p class="code_black_background">mu cmd_muapi:list -t monitor</p></td>
977
+ </tr>
978
+ <tr>
979
+ <td valign="top"><p><em>list_by_status</em></p></td>
980
+ <td class="outline"><p>Get a list of Test Runs by status: <strong>list_by_status -s</strong><em> status</em> </p>
981
+ <p class="code_black_background">mu cmd_muapi:list_by_status -s finished</p></td>
982
+ </tr>
983
+ <tr>
984
+ <td valign="top"><p><em>list_type</em></p></td>
985
+ <td class="outline"><p>Get a list of all template types: <strong>list_types</strong> </p>
986
+ <p class="code_black_background">mu cmd_muapi:list_types</p></td>
987
+ </tr>
988
+ <tr>
989
+ <td valign="top"><p><em>pause</em></p></td>
990
+ <td class="outline"><p>Pause a Test Run: <strong>pause -u</strong> <em>uuid</em> </p>
991
+ <p class="code_black_background">mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
992
+ </tr>
993
+ <tr>
994
+ <td valign="top"><p><em>resume</em></p></td>
995
+ <td class="outline"><p>Resume a Test Run: <strong>resume -u</strong> <em>uuid</em> </p>
996
+ <p class="code_black_background">mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
997
+ </tr>
998
+ <tr>
999
+ <td valign="top"><p><em>run</em></p></td>
1000
+ <td class="outline"><p>Start a Test Run (to rename, use the -b argument): <strong>run -u</strong> <em>uuid</em> [<strong>-b</strong> <em>new-name</em>] </p>
1001
+ <p class="code_black_background">mu cmd_muapi:run -u 52add3cf-9040-42ce-b263-8233039931d5 -b true</p></td>
1002
+ </tr>
1003
+ <tr>
1004
+ <td valign="top"><p><em>status</em></p></td>
1005
+ <td class="outline"><p>Get the status of a Test Run: <strong>status -u</strong> <em>uuid</em> </p>
1006
+ <p class="code_black_background">mu cmd_muapi:status -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
1007
+ </tr>
1008
+ <tr>
1009
+ <td height="70" valign="top"><p><em>stop</em></p></td>
1010
+ <td class="outline"><p>Stop a Test Run: <strong>stop -u</strong> <em>uuid</em> </p>
1011
+ <p class="code_black_background">mu cmd_muapi:stop -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
1012
+ </tr>
1013
+ <tr class="wide">
1014
+ <th colspan="2">cmd_muapi Options</th>
1015
+ </tr>
1016
+ <tr class="wide">
1017
+ <td colspan="2"><p><strong>-b/--boolean</strong> <em>value</em></p>
1018
+ <blockquote>
1019
+ <p>Specify a boolean value (<span class="code">true</span> or <span class="code">false</span>). </p>
1020
+ </blockquote></td>
1021
+ </tr>
1022
+ <tr class="wide">
1023
+ <td colspan="2"><p><strong>-c/--command</strong><em> command</em></p>
1024
+ <blockquote>
1025
+ <p>Specify the command to run (run, get, status, etc.)</p>
1026
+ </blockquote></td>
1027
+ </tr>
1028
+ <tr class="wide">
1029
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
1030
+ <blockquote>
1031
+ <p>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
1032
+ </blockquote></td>
1033
+ </tr>
1034
+ <tr class="wide">
1035
+ <td colspan="2"><p><strong>-n/--name</strong> <em>name</em></p>
1036
+ <blockquote>
1037
+ <p>Specify a Test Run or template name.</p>
1038
+ </blockquote></td>
1039
+ </tr>
1040
+ <tr class="wide">
1041
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
1042
+ <blockquote>
1043
+ <p>Specify the filename to which you want to output logs.</p>
1044
+ </blockquote></td>
1045
+ </tr>
1046
+ <tr class="wide">
1047
+ <td colspan="2"><p><strong>-p/--port</strong> <em>port-number</em></p>
1048
+ <blockquote>
1049
+ <p>Specify the port number.</p>
1050
+ </blockquote></td>
1051
+ </tr>
1052
+ <tr class="wide">
1053
+ <td colspan="2"><p><strong>-s/--status</strong> <em>status</em></p>
1054
+ <blockquote>
1055
+ <p>Specify the status filter (<span class="code">running</span>, <span class="code">finished</span>, <span class="code">aborted</span> <span class="code">queued</span>, or <span class="code">failed</span>)</p>
1056
+ </blockquote></td>
1057
+ </tr>
1058
+ <tr class="wide">
1059
+ <td colspan="2"><p><strong>-t/--type</strong><em> template-type</em></p>
1060
+ <blockquote>
1061
+ <p>Specify the type of template.</p>
1062
+ </blockquote></td>
1063
+ </tr>
1064
+ <tr class="wide">
1065
+ <td colspan="2"><p><strong>-u/--uuid</strong><em> uuid/job-id</em></p>
1066
+ <blockquote>
1067
+ <p>Specify the UUID of the template to run. For archive, backup, and capture commands, this option takes a job-id value.</p>
1068
+ </blockquote></td>
1069
+ </tr>
1070
+ <tr class="wide">
1071
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
1072
+ <blockquote>
1073
+ <p>Set
1074
+ the Logger::DEBUG level.</p>
1075
+ </blockquote></td>
1076
+ </tr>
1077
+ </table>
1078
+ <p><a href="#top">back to top &uarr;</a></p>
1079
+ <h2><a name="cmd_netconfig" id="cmd_runscale6"></a>cmd_netconfig</h2>
1080
+ <p>Use to access the legacy REST API for configuring Mu interfaces, network hosts, and routes.</p>
1081
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
1082
+ <tr>
1083
+ <th colspan="2">cmd_netconfig Commands</th>
1084
+ </tr>
1085
+ <tr>
1086
+ <td valign="top"><p class="outline"><em>help</em></p></td>
1087
+ <td><p class="outline">Gets help for all cmd_netconfig commands: <strong>help</strong> </p>
1088
+ <p class="code_black_background">mu cmd_netconfig:help</p></td>
1089
+ </tr>
1090
+ <tr>
1091
+ <td valign="top"><p class="outline"><em>clear_hosts</em></p></td>
1092
+ <td><p>Remove all network hosts configured in the Mu system: <strong>clear_hosts</strong></p>
1093
+ <p class="code_black_background">mu cmd_netconfig:clear_hosts</p></td>
1094
+ </tr>
1095
+ <tr>
1096
+ <td valign="top"><p class="outline"><em>clear_interfaces</em></p></td>
1097
+ <td><p>Clear settings for specified Mu interfaces: <strong>clear_interface -i</strong> <em>interfaces</em></p>
1098
+ <p class="code_black_background">mu cmd_netconfig:clear_interface -i b1,b2</p></td>
1099
+ </tr>
1100
+ <tr>
1101
+ <td valign="top"><p class="outline"><em>clear_routes</em></p></td>
1102
+ <td><p>Remove all user-configured routes in the Mu system: <strong>clear_routes</strong></p>
1103
+ <p class="code_black_background">mu cmd_netconfig:clear_routes</p></td>
1104
+ </tr>
1105
+ <tr>
1106
+ <td valign="top"><p class="outline"><em>clear_vlans</em></p></td>
1107
+ <td><p>Remove all vlans for all Mu interfaces: <strong>clear_vlans</strong></p>
1108
+ <p class="code_black_background">mu cmd_netconfig:clear_vlans</p></td>
1109
+ </tr>
1110
+ <tr>
1111
+ <td valign="top"><p class="outline"><em>create</em></p></td>
1112
+ <td><p>Create a network object such as a host or route: <strong>create -j </strong><em>object</em><strong> -e </strong><em>value</em></p>
1113
+ <p class="code_black_background">mu cmd_netconfig:create -j &quot;{&quot;default&quot;: false,&quot;direct&quot;: false,&quot;dst&quot;: &quot;10.0.0.0&quot;,&quot;dst_pfx_len&quot;: 8,&quot;gateway&quot;: &quot;192.168.100.1&quot;,&quot;interface&quot;: &quot;a1&quot;,&quot;interface_display_name&quot;: &quot;A1&quot;,&quot;metric&quot;: 1,&quot;readonly&quot;: false}&quot; -e routes</p></td>
1114
+ </tr>
1115
+ <tr>
1116
+ <td valign="top"><p class="outline"><em>delete</em></p></td>
1117
+ <td><p>Delete a network object such as host or route: <strong>delete -e </strong><em>value</em></p>
1118
+ <p class="code_black_background">mu cmd_netconfig:delete -e Web-Server</p></td>
1119
+ </tr>
1120
+ <tr>
1121
+ <td valign="top"><p class="outline"><em>get</em></p></td>
1122
+ <td><p>Get details for a network object: <strong>get -e </strong><em>value</em></p>
1123
+ <p class="code_black_background">mu cmd_netconfig:get -e a1</p></td>
1124
+ </tr>
1125
+ <tr>
1126
+ <td valign="top"><p class="outline"><em>modify</em></p></td>
1127
+ <td><p>Modify a network object such as a host or route:<strong>modify -j </strong><em>object </em><strong>-e </strong><em>value</em></p>
1128
+ <p class="code_black_background">mu cmd_netconfig:modify -j {&quot;mac&quot;: &quot;&quot;,&quot;name&quot;: &quot;Web-Server&quot;,&quot;notes&quot;: &quot;&quot;,&quot;v4_addr&quot;: &quot;192.168.112.205&quot;,<br>
1129
+ &quot;v6_global_addr&quot;: &quot;&quot;,&quot;v6_local_addr&quot;: &quot;&quot;} -e host</p></td>
1130
+ </tr>
1131
+ <tr>
1132
+ <td valign="top"><p class="outline"><em>resolve_hosts</em></p></td>
1133
+ <td><p>Get IP address for specified network host: <strong>resolve_hosts </strong><em>host</em></p>
1134
+ <p class="code_black_background">mu cmd_netconfig:resolve_hosts Web-Server</p></td>
1135
+ </tr>
1136
+ <tr>
1137
+ <td valign="top"><p class="outline"><em>restore</em></p></td>
1138
+ <td><p>Restore from specified file (to overwrite existing object, use the -b argument): <strong>restore -f </strong><em>filepath </em>[<strong>-b</strong> <em>clear-existing</em>]</p>
1139
+ <p class="code_black_background">mu cmd_netconfig:restore -f my_muhosts/web-server.json true</p></td>
1140
+ </tr>
1141
+ <tr>
1142
+ <td height="75" valign="top"><p class="outline"><em>save</em></p></td>
1143
+ <td><p>Save changes to the Mu system: <strong>save</strong></p>
1144
+ <p class="code_black_background">mu cmd_netconfig:save</p></td>
1145
+ </tr>
1146
+ <tr>
1147
+ <th colspan="2">cmd_netconfig Options</th>
1148
+ </tr>
1149
+ <tr>
1150
+ <td colspan="2"><p><strong>-b/--boolean</strong> <em>value</em></p>
1151
+ <blockquote>
1152
+ <p>Specify a boolean value (true or false). </p>
1153
+ </blockquote></td>
1154
+ </tr>
1155
+ <tr>
1156
+ <td colspan="2"><p><strong>-e/--element</strong><em> value</em></p>
1157
+ <blockquote>
1158
+ <p>Specify a value for the associated command. Example: <span class="code">interfaces</span> or <span class="code">interfaces/a1</span></p>
1159
+ </blockquote></td>
1160
+ </tr>
1161
+ <tr>
1162
+ <td colspan="2"><p><strong>-f/--filepath</strong><em> filepath</em></p>
1163
+ <blockquote>
1164
+ <p>Specify the path to a file. </p>
1165
+ </blockquote></td>
1166
+ </tr>
1167
+ <tr>
1168
+ <td colspan="2"><p><strong>-h/--help</strong></p>
1169
+ <blockquote>
1170
+ <p>Get help on command line options.</p>
1171
+ </blockquote></td>
1172
+ </tr>
1173
+ <tr>
1174
+ <td colspan="2"><p><strong>-i/--interfaces</strong> <em>interface-or-host</em></p>
1175
+ <blockquote>
1176
+ <p>Specify Mu interfaces or network hosts as a comma-separated list. Example: <span class="code">b1, web-server</span>. </p>
1177
+ </blockquote></td>
1178
+ </tr>
1179
+ <tr>
1180
+ <td colspan="2"><p><strong>-j/--json</strong> <em>object</em></p>
1181
+ <blockquote>
1182
+ <p>Specify a json object as a text string.</p>
1183
+ </blockquote></td>
1184
+ </tr>
1185
+ <tr>
1186
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
1187
+ <blockquote>
1188
+ <p>Specify a user, password, and management IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
1189
+ </blockquote></td>
1190
+ </tr>
1191
+ <tr>
1192
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
1193
+ <blockquote>
1194
+ <p>Specify the filename to which you want to output logs.</p>
1195
+ </blockquote></td>
1196
+ </tr>
1197
+ <tr>
1198
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
1199
+ <blockquote>
1200
+ <p>Set
1201
+ the Logger::DEBUG level.</p>
1202
+ </blockquote></td>
1203
+ </tr>
1204
+ </table>
1205
+ <p><a href="#top">back to top &uarr;</a></p>
1206
+ <h2><a name="cmd_ddt" id="cmd_runscale7"></a>cmd_ddt</h2>
1207
+ <p>Use to access the legacy REST API for Test Sets (Studio Verify).</p>
1208
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
1209
+ <tr>
1210
+ <th colspan="2">cmd_ddt Commands</th>
1211
+ </tr>
1212
+ <tr>
1213
+ <td valign="top"><p><em>display_results</em></p></td>
1214
+ <td><p>Displays results for the current Test Set: <strong>display_results</strong> </p>
1215
+ <p class="code_black_background">mu cmd_ddt:display_results</p></td>
1216
+ </tr>
1217
+ <tr>
1218
+ <td valign="top"><p><em>new_session</em></p></td>
1219
+ <td><p>Create a new session: <strong>new_session</strong> </p>
1220
+ <p class="code_black_background">mu cmd_ddt:new_session</p></td>
1221
+ </tr>
1222
+ <tr>
1223
+ <td valign="top"><p><em>load_scenario</em></p></td>
1224
+ <td><p>Load the specified Scenario template: <strong>load_scenario -u </strong><em>uuid</em> </p>
1225
+ <p class="code_black_background">mu cmd_ddt:load_scenario -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
1226
+ </tr>
1227
+ <tr>
1228
+ <td valign="top"><p><em>get_hosts</em></p></td>
1229
+ <td><p>Get a list of hosts in the Test Bed: <strong>get_hosts</strong> </p>
1230
+ <p class="code_black_background">mu cmd_ddt:get_hosts</p></td>
1231
+ </tr>
1232
+ <tr>
1233
+ <td valign="top"><p><em>set_hosts</em></p></td>
1234
+ <td><p>Configure the hosts in the Test Bed: <strong>set_hosts</strong> <strong>-r</strong> <em>role</em> <strong>-n</strong> <em>name</em> <strong>-y</strong> <em>type</em> </p>
1235
+ <p class="code_black_background">mu cmd_ddt:set_hosts -r HTTP_Client,HTTP_Server -n a1,Web-Server -y v4</p></td>
1236
+ </tr>
1237
+ <tr>
1238
+ <td valign="top"><p><em>get_channels</em></p></td>
1239
+ <td><p>Get a list of channels in the Test Bed: <strong>get_channels</strong> </p>
1240
+ <p class="code_black_background">mu cmd_ddt:get_channels</p></td>
1241
+ </tr>
1242
+ <tr>
1243
+ <td valign="top"><p><em>set_channels</em></p></td>
1244
+ <td><p>Configure the channels in the Test Bed: <strong>set_channels</strong> <strong>-r</strong> <em>role</em> <strong>-n</strong> <em>name</em> </p>
1245
+ <p class="code_black_background">mu cmd_ddt:set_channels -r SSH_Channel -n Web-Server</p></td>
1246
+ </tr>
1247
+ <tr>
1248
+ <td valign="top"><p><em>get_options</em></p></td>
1249
+ <td><p>Get a list of options in the Test Set: <strong>get_options</strong> </p>
1250
+ <p class="code_black_background">mu cmd_ddt:get_options</p></td>
1251
+ </tr>
1252
+ <tr>
1253
+ <td valign="top"><p><em>set_options</em></p></td>
1254
+ <td><p>Configure the option values for the Test Set: <strong>set_options</strong> <strong>-n</strong> <em>name</em> <strong>-p</strong> <em>value</em> </p>
1255
+ <p class="code_black_background">mu cmd_ddt:set_options -n username -p jsmith</p></td>
1256
+ </tr>
1257
+ <tr>
1258
+ <td valign="top"><p><em>get_sessions</em></p></td>
1259
+ <td><p>Get a list of all sessions: <strong>get_sessions</strong> </p>
1260
+ <p class="code_black_background">mu cmd_ddt:get_sessions</p></td>
1261
+ </tr>
1262
+ <tr>
1263
+ <td valign="top"><p><em>setup_test</em></p></td>
1264
+ <td><p>Setup the Test Bed, reserving the Mu interfaces: <strong>setup_test</strong> </p>
1265
+ <p class="code_black_background">mu cmd_ddt:setup_test</p></td>
1266
+ </tr>
1267
+ <tr>
1268
+ <td valign="top"><p><em>run</em></p></td>
1269
+ <td><p>Run a Test Set: <strong>run</strong> </p>
1270
+ <p class="code_black_background">mu cmd_ddt:run</p></td>
1271
+ </tr>
1272
+ <tr>
1273
+ <td valign="top"><p><em>run_testset</em></p></td>
1274
+ <td><p>Run the specified Test Set: <strong>run_testset -u</strong> <em>uuid</em> </p>
1275
+ <p class="code_black_background">mu cmd_ddt:run_testset -u 04aa248a-0b9b-4bf6-97e1-aab691d0acf1</p></td>
1276
+ </tr>
1277
+ <tr>
1278
+ <td valign="top"><p><em>get_testset_results</em></p></td>
1279
+ <td><p>Get results for the current Test Set: <strong>get_testset_results</strong> </p>
1280
+ <p class="code_black_background">mu cmd_ddt:get_testset_results</p></td>
1281
+ </tr>
1282
+ <tr>
1283
+ <td valign="top"><p><em>get_testset_status</em></p></td>
1284
+ <td><p>Get status for the current Test Set: <strong>get_testset_status</strong> </p>
1285
+ <p class="code_black_background">mu cmd_ddt:get_testset_status</p></td>
1286
+ </tr>
1287
+ <tr>
1288
+ <td valign="top"><p><em>teardown_test</em></p></td>
1289
+ <td><p>Unsets the Test Bed selections, releasing the Mu interfaces: <strong>teardown_test</strong> </p>
1290
+ <p class="code_black_background">mu cmd_ddt:teardown_test</p></td>
1291
+ </tr>
1292
+ <tr>
1293
+ <td valign="top"><p><em>close_session</em></p></td>
1294
+ <td><p>Closes the current session: <strong>close_session</strong> </p>
1295
+ <p class="code_black_background">mu cmd_ddt:close_session</p></td>
1296
+ </tr>
1297
+ <tr>
1298
+ <td valign="top"><p><em>close_all_sessions</em></p></td>
1299
+ <td><p>Closes all existing sessions: <strong>close_all_sessions</strong> </p>
1300
+ <p class="code_black_background">mu cmd_ddt:close_all_sessions</p></td>
1301
+ </tr>
1302
+ <td valign="top"><p><em>csv_export</em></p></td>
1303
+ <td><p>Exports a Test Set from the Mu system to a. csv file: <strong>csv_export</strong> <strong>-u</strong> <em>uuid</em> </p>
1304
+ <p class="code_black_background">mu cmd_ddt:csv_export -u 52add3cf-9040-42ce-b263-8233039931d5</p></td>
1305
+ </tr>
1306
+ <td height="82" valign="top"><p><em>csv_import</em></p></td>
1307
+ <td><p>Imports a .csv file to create a Test Set on the Mu system: <strong>csv_import</strong> <strong>-t</strong><em> filename.csv</em> </p>
1308
+ <p class="code_black_background">mu cmd_ddt:csv_import -t my-testset.csv</p></td>
1309
+ </tr><tr class="wide">
1310
+ <th colspan="2">cmd_ddt Options</th>
1311
+ </tr>
1312
+ <tr class="wide">
1313
+ <td colspan="2"><p><strong>-f/--filename</strong><em> filename</em></p>
1314
+ <blockquote>
1315
+ <p>Specify the template name for saving an imported Test Set.</p>
1316
+ </blockquote></td>
1317
+ </tr>
1318
+ <tr class="wide">
1319
+ <td colspan="2"><p><strong>-h/--help</strong></p>
1320
+ <blockquote>
1321
+ <p>Get help on command line options.</p>
1322
+ </blockquote></td>
1323
+ </tr>
1324
+ <tr class="wide">
1325
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
1326
+ <blockquote>
1327
+ <p>Specify a user, password, and management IP address of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
1328
+ </blockquote></td>
1329
+ </tr>
1330
+ <tr class="wide">
1331
+ <td colspan="2"><p><strong>-n/--names</strong> <em>name-array</em></p>
1332
+ <blockquote>
1333
+ <p>Specify host names or channel names in a comma-separated array. Example: <span class="code">a1,Web-Serve</span>r</p>
1334
+ </blockquote></td>
1335
+ </tr>
1336
+ <tr class="wide">
1337
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
1338
+ <blockquote>
1339
+ <p>Specify the filename to which you want to output logs.</p>
1340
+ </blockquote></td>
1341
+ </tr>
1342
+ <tr class="wide">
1343
+ <td colspan="2"><p><strong>-p/--option_values</strong> <em>value-array</em></p>
1344
+ <blockquote>
1345
+ <p>Specify values for Test Set options in a comma-separated array. Example: <span class="code">bob,jane,mary,tom</span></p>
1346
+ </blockquote></td>
1347
+ </tr>
1348
+ <tr class="wide">
1349
+ <td colspan="2"><p><strong>-r/--roles</strong> <em>role-array</em></p>
1350
+ <blockquote>
1351
+ <p>Specify host roles in a comma-separated array. Example: <span class="code">HTTP_Client,HTTP_Server</span></p>
1352
+ </blockquote></td>
1353
+ </tr>
1354
+ <tr class="wide">
1355
+ <td colspan="2"><p><strong>-t/--testset</strong> <em>filename.csv</em></p>
1356
+ <blockquote>
1357
+ <p>Specify the name of the .csv file to import. </p>
1358
+ </blockquote></td>
1359
+ </tr>
1360
+ <tr class="wide">
1361
+ <td colspan="2"><p><strong>-u/--uuid</strong> <em>uuid</em></p>
1362
+ <blockquote>
1363
+ <p>Specify the UUID of the Scenario or Test Set.</p>
1364
+ </blockquote></td>
1365
+ </tr>
1366
+ <tr class="wide">
1367
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
1368
+ <blockquote>
1369
+ <p>Set
1370
+ the Logger::DEBUG level.</p>
1371
+ </blockquote></td>
1372
+ </tr>
1373
+ <tr class="wide">
1374
+ <td colspan="2"><p><strong>-y/--type</strong> <em>type</em></p>
1375
+ <blockquote>
1376
+ <p>Specify network layer (v4, v6, l2) for all hosts in the Test Bed. Example: <span class="code">v4</span></p>
1377
+ </blockquote></td>
1378
+ </tr>
1379
+ </table>
1380
+ <p><a href="#top">back to top &uarr;</a></p>
1381
+ <h2><a name="cmd_scale" id="cmd_runscale8"></a>cmd_scale</h2>
1382
+ <p>Use to access the legacy REST API for Scale tests (Studio Scale). </p>
1383
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
1384
+ <tr>
1385
+ <th colspan="2">cmd_scale Commands</th>
1386
+ </tr>
1387
+ <tr>
1388
+ <td valign="top"><p><em>about</em></p></td>
1389
+ <td><p>Lists information for the Scale Player and all active and inactive Scale Engines: <strong>about</strong> </p>
1390
+ <p class="code_black_background">mu cmd_scale:about</p></td>
1391
+ </tr>
1392
+ <tr>
1393
+ <td valign="top"><p><em>configure</em></p></td>
1394
+ <td><p>Configure any element of the scale json object : <strong>configure -p </strong><em>parameter</em><strong> -pv </strong><em>value </em> </p>
1395
+ <p class="code_black_background">mu cmd_scale:configure -p json_element -pv json_element_value</p></td>
1396
+ </tr>
1397
+ <tr>
1398
+ <td valign="top"><p><em>data</em></p></td>
1399
+ <td><p>Gets chart data for the Scale test: <strong>data -w</strong> <em>view</em> <strong> -z</strong> <em>zoom</em> <strong>-ps</strong> <em>position</em> <strong>-b</strong> <em>bot_id</em> </p>
1400
+ <p class="code_black_background">mu cmd_scale:data -w TIMELINE -z 1 -ps 0 -b bots_10.10.6.200:1</p></td>
1401
+ </tr>
1402
+ <tr>
1403
+ <td valign="top"><p><em>delete_scale_engine </em></p></td>
1404
+ <td><p>Delete the specified Scale Engine:<strong>delete_scale_engine -b</strong> <em>bot_id</em> </p>
1405
+ <p class="code_black_background">mu cmd_scale:delete_scale_engine -b bots_10.10.6.200:1</p></td>
1406
+ </tr>
1407
+ <tr>
1408
+ <td valign="top"><p><em>help</em></p></td>
1409
+ <td><p>Gets help for all cmd_scale commands: <strong>help</strong> </p>
1410
+ <p class="code_black_background">mu cmd_scale:help</p></td>
1411
+ </tr>
1412
+ <tr>
1413
+ <td valign="top"><p><em>list</em></p></td>
1414
+ <td><p>Returns the current Scale Player's UUID: <strong>list</strong> </p>
1415
+ <p class="code_black_background">mu cmd_scale:list</p></td>
1416
+ </tr>
1417
+ <tr>
1418
+ <td valign="top"><p><em>pcap</em></p></td>
1419
+ <td><p>Gets a pcap from a specific Scale Engine: <strong>pcap </strong> <strong>-b</strong> <em>bot_id</em> <strong>-f</strong> <em>filename</em> </p>
1420
+ <p class="code_black_background">mu cmd_scale:pcap -b bots_10.10.6.200:1 -f bot_1_pcap</p></td>
1421
+ </tr>
1422
+ <tr>
1423
+ <td valign="top"><p><em>release</em></p></td>
1424
+ <td><p>Release the Scale Player: <strong>release</strong> </p>
1425
+ <p class="code_black_background">mu cmd_scale:release</p></td>
1426
+ </tr>
1427
+ <tr>
1428
+ <td valign="top"><p><em>release_scale_engine </em></p></td>
1429
+ <td><p>Releases the specified Scale Engine:<strong>release_scale_engine -b</strong> <em>bot_id</em> </p>
1430
+ <p class="code_black_background">mu cmd_scale:release_scale_engine -b bots_10.10.6.200:1</p></td>
1431
+ </tr>
1432
+ <tr>
1433
+ <td valign="top"><p><em>reserve_scale_engine </em></p></td>
1434
+ <td><p>Reserves the specified Scale Engine:<strong>reserve_scale_engine -b</strong> <em>bot_id</em> </p>
1435
+ <p class="code_black_background">mu cmd_scale:reserve_scale_engine -b bots_10.10.6.200:1</p></td>
1436
+ </tr>
1437
+ <tr>
1438
+ <td valign="top"><p><em>session</em></p></td>
1439
+ <td><p>Create a new Scale Player session: <strong>session</strong> </p>
1440
+ <p class="code_black_background">mu cmd_scale:session</p></td>
1441
+ </tr>
1442
+ <tr>
1443
+ <td valign="top"><p><em>start</em></p></td>
1444
+ <td><p>Start the Scale test: <strong>start</strong> <strong>-c</strong> <em>scale-test</em> <strong>-m</strong> <em>user:pass@mu-ip</em> </p>
1445
+ <p class="code_black_background">mu cmd_scale:start -c scale.json -m admin:admin@10.10.2.2</p></td>
1446
+ </tr>
1447
+ <tr>
1448
+ <td valign="top"><p><em>status</em></p></td>
1449
+ <td><p>Gets information about the currently running Scale test: <strong>status</strong> </p>
1450
+ <p class="code_black_background">mu cmd_scale:status</p></td>
1451
+ </tr>
1452
+ <tr>
1453
+ <td valign="top"><p><em>statuses</em></p></td>
1454
+ <td><p>Gets the status of all active and inactive Scale engines: <strong>statuses</strong> </p>
1455
+ <p class="code_black_background">mu cmd_scale:statuses</p></td>
1456
+ </tr>
1457
+ <tr>
1458
+ <td valign="top"><p><em>stop</em></p></td>
1459
+ <td><p>Stops the Scale test: <strong>stop</strong> </p>
1460
+ <p class="code_black_background">mu cmd_scale:stop</p></td>
1461
+ </tr>
1462
+ <tr>
1463
+ <td valign="top"><p><em>update</em></p></td>
1464
+ <td><p>Update the pattern dynamically (while the Scale test is running): <strong>update -p </strong><em>parameter</em> <strong>-pv</strong> <em>parameter-value</em> </p>
1465
+ <p class="code_black_background">mu cmd_scale:update -p delay -pv 250 -p volume -pv 100000</p></td>
1466
+ </tr>
1467
+ <tr>
1468
+ <td valign="top"><p><em>verify</em></p></td>
1469
+ <td><p>Verifies a Scale test: <strong>verify</strong> </p>
1470
+ <p class="code_black_background">mu cmd_scale:verify</p></td>
1471
+ </tr>
1472
+ <tr class="wide">
1473
+ <th colspan="2">cmd_scale Options</th>
1474
+ </tr>
1475
+ <tr class="wide">
1476
+ <td colspan="2"><p><strong>-b/--bot-id</strong> <em>scale-engine-id</em></p>
1477
+ <blockquote>
1478
+ <p>Specify a Scale Engine using its bot-id value.</p>
1479
+ </blockquote></td>
1480
+ </tr>
1481
+ <tr class="wide">
1482
+ <td colspan="2"><p><strong>-c/--config-file</strong> <em>json-filename</em></p>
1483
+ <blockquote>
1484
+ <p>Specify a .json file that contains the configuration data.</p>
1485
+ </blockquote></td>
1486
+ </tr>
1487
+ <tr class="wide">
1488
+ <td colspan="2"><p><strong>-f/--filename</strong><em> pcap-filename</em></p>
1489
+ <blockquote>
1490
+ <p>Specify a name for the .pcap file.</p>
1491
+ </blockquote></td>
1492
+ </tr>
1493
+ <tr class="wide">
1494
+ <td colspan="2"><p><strong>-h/--help</strong></p>
1495
+ <blockquote>
1496
+ <p>Get help on command line options.</p>
1497
+ </blockquote></td>
1498
+ </tr>
1499
+ <tr class="wide">
1500
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
1501
+ <blockquote>
1502
+ <p>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
1503
+ </blockquote></td>
1504
+ </tr>
1505
+ <tr class="wide">
1506
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
1507
+ <blockquote>
1508
+ <p>Specify the filename to which you want to output logs.</p>
1509
+ </blockquote></td>
1510
+ </tr>
1511
+ <tr class="wide">
1512
+ <td colspan="2"><p><strong>-p/--params</strong><em> parameters</em></p>
1513
+ <blockquote>
1514
+ <p>Specify parameters for initial configuration or for update. Supports <span class="code">delay</span> and <span class="code">volume</span> parameters.</p>
1515
+ </blockquote></td>
1516
+ </tr>
1517
+ <tr class="wide">
1518
+ <td colspan="2"><p><strong>-ps/--view_position</strong><em> value</em></p>
1519
+ <blockquote>
1520
+ <p>Specify the position in the timeline view for which to return data. At this time, only position <span class="code">0</span> is supported.</p>
1521
+ </blockquote></td>
1522
+ </tr>
1523
+ <tr class="wide">
1524
+ <td colspan="2"><p><strong>-pv/--param_value</strong> <em>value</em></p>
1525
+ <blockquote>
1526
+ <p>Specify a value for a parameter.</p>
1527
+ </blockquote></td>
1528
+ </tr>
1529
+ <tr class="wide">
1530
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
1531
+ <blockquote>
1532
+ <p>Set
1533
+ the Logger::DEBUG level.</p>
1534
+ </blockquote></td>
1535
+ </tr>
1536
+ <tr class="wide">
1537
+ <td colspan="2"><p><strong>-w/--view</strong> <em>view</em></p>
1538
+ <blockquote>
1539
+ <p>Specify the view (<span class="code">RUNTIME</span> or <span class="code">CALLGRAPH</span>) for which to return data.</p>
1540
+ </blockquote></td>
1541
+ </tr>
1542
+ <tr class="wide">
1543
+ <td colspan="2"><p><strong>-z/--zoom</strong> <em>zoom-level</em></p>
1544
+ <blockquote>
1545
+ <p>Specify the zoom level (<span class="code">0</span>, <span class="code">.5</span>, or <span class="code">1</span>) in the timeline view for which to return data. 1 returns data for 100% of the time range, 0.5 returns data for 50% of the time range, and 0 returns only the last minute of data. </p>
1546
+ </blockquote></td>
1547
+ </tr>
1548
+ </table>
1549
+ <p><a href="#top">back to top &uarr;</a></p>
1550
+ <h2><a name="cmd_homepage" id="cmd_runscale9"></a>cmd_homepage</h2>
1551
+ <p>Use to access information displayed on the Mu UI homepage, such as recent updates, backup status, or a list of latest test results.</p>
1552
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
1553
+ <tr>
1554
+ <th colspan="2">cmd_homepage Commands</th>
1555
+ </tr>
1556
+ <tr>
1557
+ <td width="173" valign="top"><p><em>all</em></p></td>
1558
+ <td width="398"><p>Gets the complete set of information displayed on the Mu home page: <strong>all</strong> </p>
1559
+ <p class="code_black_background">mu cmd_homepage:all</p></td>
1560
+ </tr>
1561
+ <tr>
1562
+ <td valign="top"><p><em>help</em></p></td>
1563
+ <td><p>Gets help for all cmd_homepage commands: <strong>help</strong> </p>
1564
+ <p class="code_black_background">mu cmd_homepage:help</p></td>
1565
+ </tr>
1566
+ <tr>
1567
+ <td valign="top"><p><em>latest_test</em></p></td>
1568
+ <td><p>Gets an array of the latest test results: <strong>latest_test</strong> </p>
1569
+ <p class="code_black_background">mu cmd_homepage:latest_test</p></td>
1570
+ </tr>
1571
+ <tr>
1572
+ <td valign="top"><p><em>queue_test</em></p></td>
1573
+ <td><p>Gets an array of tests in the Test Queue: <strong>queue_test</strong> </p>
1574
+ <p class="code_black_background">mu cmd_homepage:queue_test</p></td>
1575
+ </tr>
1576
+ <tr>
1577
+ <td valign="top"><p><em>recent</em></p></td>
1578
+ <td><p>Gets the "What's New" section from the Mu homepage: <strong>recent</strong> </p>
1579
+ <p class="code_black_background">mu cmd_homepage:recent</p></td>
1580
+ </tr>
1581
+ <tr>
1582
+ <td valign="top"><p><em>status</em></p></td>
1583
+ <td><p>Gets system status for licenses, backup, and updates: <strong>status</strong> </p>
1584
+ <p class="code_black_background">mu cmd_homepage:status</p></td>
1585
+ </tr>
1586
+ <tr>
1587
+ <th colspan="2" valign="top">cmd_homepage Options</th>
1588
+ </tr>
1589
+ <tr class="wide">
1590
+ <td colspan="2"><p><strong>-h/--help</strong></p>
1591
+ <blockquote>
1592
+ <p>Get help on command line options.</p>
1593
+ </blockquote></td>
1594
+ </tr>
1595
+ <tr class="wide">
1596
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
1597
+ <blockquote>
1598
+ <p>Specify a user, password, and management IP address of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
1599
+ </blockquote></td>
1600
+ </tr>
1601
+ <tr class="wide">
1602
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
1603
+ <blockquote>
1604
+ <p>Specify the filename to which you want to output logs.</p>
1605
+ </blockquote></td>
1606
+ </tr>
1607
+ <tr class="wide">
1608
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
1609
+ <blockquote>
1610
+ <p>Set
1611
+ the Logger::DEBUG level.</p>
1612
+ </blockquote></td>
1613
+ </tr>
1614
+ </table>
1615
+ <p><a href="#top">back to top &uarr;</a></p>
1616
+ <h2><a name="cmd_system" id="cmd_runscale10"></a>cmd_system</h2>
1617
+ <p>Use to restart system services or to get status details for the Mu system. </p>
1618
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
1619
+ <tr>
1620
+ <th colspan="2">cmd_system Commands</th>
1621
+ </tr>
1622
+ <tr>
1623
+ <td valign="top"><p><em>restart</em></p></td>
1624
+ <td><p>Restart Mu system services (this does not reboot the appliance): <strong>restart</strong> </p>
1625
+ <p class="code_black_background">mu cmd_system:restart</p></td>
1626
+ </tr>
1627
+ <tr>
1628
+ <td valign="top"><p><em>status</em></p></td>
1629
+ <td><p>Gets all information from the system status page: <strong>status</strong> </p>
1630
+ <p class="code_black_background">mu cmd_system:status</p></td>
1631
+ </tr>
1632
+ <tr>
1633
+ <td height="92" valign="top"><p><em>status2</em></p></td>
1634
+ <td><p>Gets additional system information such as hard drive status, platform model, serial number: <strong>status2</strong> </p>
1635
+ <p class="code_black_background">mu cmd_system:status2</p></td>
1636
+ </tr>
1637
+ <tr>
1638
+ <th colspan="2" valign="top">cmd_system Options</th>
1639
+ </tr>
1640
+ <tr class="wide">
1641
+ <td colspan="2"><p><strong>-h/--help</strong></p>
1642
+ <blockquote>
1643
+ <p>Get help on command line options.</p>
1644
+ </blockquote></td>
1645
+ </tr>
1646
+ <tr class="wide">
1647
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
1648
+ <blockquote>
1649
+ <p>Specify a user, password, and management IP address of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
1650
+ </blockquote></td>
1651
+ </tr>
1652
+ <tr class="wide">
1653
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
1654
+ <blockquote>
1655
+ <p>Specify the filename to which you want to output logs.</p>
1656
+ </blockquote></td>
1657
+ </tr>
1658
+ <tr class="wide">
1659
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
1660
+ <blockquote>
1661
+ <p>Set
1662
+ the Logger::DEBUG level.</p>
1663
+ </blockquote></td>
1664
+ </tr>
1665
+ </table>
1666
+ <p><a href="#top">back to top &uarr;</a></p>
1464
1667
  <h2><a name="cmd_cli" id="cmd_runscale11"></a>cmd_cli</h2>
1465
- <p>Use to access the Mu CLI. </p>
1466
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1467
- <tr>
1468
- <th>Command</th>
1469
- <th>Description &amp; Examples</th>
1470
- </tr>
1471
- <tr>
1472
- <td><em>cli_help</em></td>
1473
- <td>Get help for all cmd_cli commands: <strong>cli_help</strong>
1474
- <h6 class="code">mu cmd_cli:cli_help</h6></td>
1475
- </tr>
1476
- <tr>
1477
- <td><em>cli_history</em></td>
1478
- <td>Display the command line history for the current session: <strong>cli_help</strong>
1479
- <h6 class="code">mu cmd_cli:history</h6></td>
1480
- </tr>
1481
- <tr>
1482
- <td><em>ping</em></td>
1483
- <td>Ping the specified IP address from the Mu system: <strong>ping -a </strong><em>ip-address
1484
- </em>
1485
- <h6 class="code">mu cmd_cli:ping -a 10.10.10.1</h6></td>
1486
- </tr>
1487
- <tr>
1488
- <td><em>question</em></td>
1489
- <td>Show the available CLI commands:
1490
- <strong>question</strong> <h6 class="code">mu cmd_cli:question</h6></td>
1491
- </tr>
1492
- <tr>
1493
- <td><em>traceroute</em></td>
1494
- <td>Get the network route to a specified IP address from the Mu system: <strong>traceroute -a </strong><em>ip-address </em>
1495
- <h6 class="code">mu cmd_cli:traceroute -a 10.10.10.1</h6></td>
1496
- </tr>
1497
- </table>
1498
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1499
- <tr>
1500
- <th colspan="2">Options (short &amp; long form)</th>
1501
- <th width="57%">Description</th>
1502
- </tr>
1503
- <tr>
1504
- <td width="5%">-h</td>
1505
- <td width="38%"><strong>--help</strong></td>
1506
- <td>Get help on command line options.</td>
1668
+ <p>Use to access the Mu CLI. </p>
1669
+ <table border="0" cellpadding="1" cellspacing="1" class=outline>
1670
+ <tr>
1671
+ <th colspan="2">cmd_cli Commands</th>
1672
+ </tr>
1673
+ <tr>
1674
+ <td valign="top"><p><em>cli_help</em></p></td>
1675
+ <td><p>Get help for all cmd_cli commands: <strong>cli_help</strong> </p>
1676
+ <p class="code_black_background">mu cmd_cli:cli_help</p></td>
1677
+ </tr>
1678
+ <tr>
1679
+ <td valign="top"><p><em>cli_history</em></p></td>
1680
+ <td><p>Display the command line history for the current session: <strong>cli_help</strong> </p>
1681
+ <p class="code_black_background">mu cmd_cli:history</p></td>
1682
+ </tr>
1683
+ <tr>
1684
+ <td valign="top"><p><em>ping</em></p></td>
1685
+ <td><p>Ping the specified IP address from the Mu system: <strong>ping -a </strong><em>ip-address </em> </p>
1686
+ <p class="code_black_background">mu cmd_cli:ping -a 10.10.10.1</p></td>
1687
+ </tr>
1688
+ <tr>
1689
+ <td valign="top"><p><em>question</em></p></td>
1690
+ <td><p>Show the available CLI commands: <strong>question</strong> </p>
1691
+ <p class="code_black_background">mu cmd_cli:question</p></td>
1692
+ </tr>
1693
+ <tr>
1694
+ <td height="89" valign="top"><p><em>traceroute</em></p></td>
1695
+ <td><p>Get the network route to a specified IP address from the Mu system: <strong>traceroute -a </strong><em>ip-address </em> </p>
1696
+ <p class="code_black_background">mu cmd_cli:traceroute -a 10.10.10.1</p></td>
1697
+ </tr>
1698
+ <tr>
1699
+ <th colspan="2" valign="top">cmd_cli Options</th>
1700
+ </tr>
1701
+ <tr class="wide">
1702
+ <td colspan="2"><p><strong>-h/--help</strong></p>
1703
+ <blockquote>
1704
+ <p>Get help on command line options.</p>
1705
+ </blockquote></td>
1706
+ </tr>
1707
+ <tr class="wide">
1708
+ <td colspan="2"><p><strong>-m/--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></p>
1709
+ <blockquote>
1710
+ <p>Specify a user, password, and management IP address of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></p>
1711
+ </blockquote></td>
1712
+ </tr>
1713
+ <tr class="wide">
1714
+ <td colspan="2"><p><strong>-o/--output</strong> <em>filename</em></p>
1715
+ <blockquote>
1716
+ <p>Specify the filename to which you want to output logs.</p>
1717
+ </blockquote></td>
1718
+ </tr>
1719
+ <tr class="wide">
1720
+ <td colspan="2"><p><strong>-v/--verbose</strong></p>
1721
+ <blockquote>
1722
+ <p>Set
1723
+ the Logger::DEBUG level.</p>
1724
+ </blockquote></td>
1725
+ </tr>
1726
+ </table>
1727
+ <p><a href="#top">back to top &uarr;</a></p>
1728
+ <h3><a name="library-classes" id="ddt2"></a>Mu Gem Library Classes</h3>
1729
+ <p>These API library classes can be required and used within Ruby scripts (like most ruby gems). </p>
1730
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1731
+ <tr>
1732
+ <th width="85">Command</th>
1733
+ <th width="482">Examples</th>
1507
1734
  </tr>
1508
- <tr>
1509
- <td>-m</td>
1510
- <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1511
- <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1735
+ <tr>
1736
+ <td valign=top><h5>&nbsp;</h5>
1737
+ <h5><a name="muapi"></a>muapi</h5></td>
1738
+ <td valign=top><p class="code_black_background">require 'rubygems'<br>
1739
+ require 'mu'<br>
1740
+ <br>
1741
+ api = Mu::Muapi.new(&#8220;<em>mu-ip</em>&#8221;,&#8221;<em>user</em>&#8221;,&#8221;<em>pass</em>&#8221;)<br>
1742
+ $log.level = Logger::INFO<br>
1743
+ <span class="code">api.list_by_status(&quot;running&quot;)</span></p></td>
1512
1744
  </tr>
1513
- <tr>
1514
- <td>-o</td>
1515
- <td><strong>--output</strong> <em>filename</em></td>
1516
- <td>Specify the filename to which you want to output logs.</td>
1745
+ <tr>
1746
+ <td valign=top><h5><a name="ddt" id="ddt"></a>ddt</h5></td>
1747
+ <td valign=top><p class="code_black_background">require 'rubygems'<br>
1748
+ require 'mu'<br>
1749
+ <br>
1750
+ api = Mu::Ddt.new(&#8220;<em>mu-ip</em>&#8221;,&#8221;<em>user</em>&#8221;,&#8221;<em>pass</em>&#8221;)<br>
1751
+ $log.level = Logger::INFO<br>
1752
+ <br>
1753
+ api.new_session</p></td>
1517
1754
  </tr>
1518
- <tr>
1519
- <td>-v</td>
1520
- <td><strong>--verbose</strong></td>
1521
- <td>Set
1522
- the Logger::DEBUG level.</td>
1755
+ <tr>
1756
+ <td valign=top><h5>&nbsp;</h5>
1757
+ <h5><a name="scale" id="scale"></a>scale</h5></td>
1758
+ <td valign=top><p class="code_black_background">require &#8216;rubygems&#8217;<BR>
1759
+ require &#8216;mu&#8217;<BR>
1760
+ &nbsp;<BR>
1761
+ api = Mu::Scale.new(&#8220;<em>mu-ip</em>&#8221;,&#8221;<em>user</em>&#8221;,&#8221;<em>pass</em>&#8221;)<BR>
1762
+ $log.level=Logger::INFO<BR>
1763
+ &nbsp;<BR>
1764
+ api.configure(musl, <em>scenario.msl</em>)<BR>
1765
+ api.configure(csv, <em>testset.csv</em>)<BR>
1766
+ api.configure(pattern, <em>pattern.json</em>)</p>
1767
+ <p> For each file type (<em>scenario.msl</em>, <em>testset.csv</em>, <em>pattern.json</em>) you must pass the file contents encoded as a Ruby string. For example:</p>
1768
+ <p class="code_black_background">muslString = File.open(&#8216;<em>scenario.msl</em>&#8217;, &#8216;r&#8217;, {|f| f.read}<BR>
1769
+ api.configure(musl, muslString)<BR>
1770
+ &nbsp;<BR>
1771
+ api.start<BR>
1772
+ api.status<BR>
1773
+ api.stop<BR>
1774
+ api.release </p></td>
1523
1775
  </tr>
1524
- </table>
1525
- <p><a href="#top">back to top &uarr;</a></p>
1526
- <p>&nbsp;</p>
1527
- <h3><a name="library-classes" id="features2"></a>Library Classes</h3>
1528
- <p>The following API library classes can be &lsquo;required&rsquo; and used within Ruby scripts(
1529
- like most ruby gems).</p>
1530
-
1531
- <table border="1" cellpadding="1" cellspacing="1" class=wide>
1532
- <tr>
1533
- <th>Command</th>
1534
- <th>Description &amp; Examples</th>
1535
- </tr>
1536
- <tr>
1537
- <td valign=top><p><a name=muapi>muapi</a></p></td>
1538
- <td valign=top><p>require 'rubygems'</p>
1539
- <p>require 'mu'</p>
1540
- <p>api = Mu::Muapi.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1541
- <p>$log.level = Logger::INFO</p>
1542
- <p>Example: <span class="code">api.list_by_status(&quot;running&quot;)</span></p></td>
1543
- </tr>
1544
- <tr>
1545
- <td valign=top><p><a name=ddt>ddt</a></p></td>
1546
- <td valign=top><p>require 'rubygems'</p>
1547
- <p>require 'mu'</p>
1548
- <p>api = Mu::Ddt.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1549
- <p>$log.level = Logger::INFO</p>
1550
- <p>Example: <span class="code">api.new_session</span></p></td>
1551
- </tr>
1552
- <tr>
1553
- <td valign=top><p><a name=scale>scale</a></p></td>
1554
- <td valign=top><p>require 'rubygems'</p>
1555
- <p>require 'mu'</p>
1556
- <p>api = Mu::Scale.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1557
- <p>$log.level = Logger::INFO</p>
1558
- <p>Examples: </p>
1559
- <h6 class="code">api.configure -p musl -pv &lt;scenario.msl&gt;</h6>
1560
- <h6 class="code">api.configure -p csv -pv &lt;testset.csv&gt;</h6>
1561
- <h6 class="code">api.configure -p pattern -pv &lt;pattern.json&gt;</h6>
1562
- <h6 class="code">api.start</h6>
1563
- <h6 class="code">api.status</h6>
1564
- <h6 class="code">api.stop</h6>
1565
- <h6 class="code">api.release</h6></td>
1566
- </tr>
1567
- <tr>
1568
- <td valign=top><a name=netconfig>netconfig</a></td>
1569
- <td valign=top><p>require 'rubygems'</p>
1570
- <p>require 'mu'</p>
1571
- <p>api = Mu::Netconfig.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1572
- <p>$log.level = Logger::INFO</p>
1573
- <p>Example: <span class="code">api.get(&quot;hosts&quot;)</span></p></td>
1776
+ <tr>
1777
+ <td valign=top><h5><a name="netconfig" id="netconfig"></a>netconfig</h5></td>
1778
+ <td valign=top><p class="code_black_background">require 'rubygems'<br>
1779
+ require 'mu'<br>
1780
+ <br>
1781
+ api = Mu::Netconfig.new(&#8220;<em>mu-ip</em>&#8221;,&#8221;<em>user</em>&#8221;,&#8221;<em>pass</em>&#8221;)<br>
1782
+ $log.level = Logger::INFO<br>
1783
+ <br>
1784
+ api.get(&quot;hosts&quot;)</p></td>
1574
1785
  </tr>
1575
- </table>
1576
- <p>&nbsp;</p>
1577
- <p><a href="#top">back to top &uarr;</a></p>
1786
+ </table>
1787
+ <p><a href="#top">back to top &uarr;</a></p>
1578
1788
  <hr />
1579
1789
  <h2>Mu
1580
1790
  Dynamics Information</h2>