mu 5.7.2.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (117) hide show
  1. data/Mu_Gem.html +1591 -0
  2. data/bin/mu +11 -0
  3. data/lib/mu.rb +65 -0
  4. data/lib/mu/api/ddt.rb +233 -0
  5. data/lib/mu/api/homepage.rb +54 -0
  6. data/lib/mu/api/muapi.rb +231 -0
  7. data/lib/mu/api/netconfig.rb +233 -0
  8. data/lib/mu/api/scale.rb +199 -0
  9. data/lib/mu/api/system.rb +40 -0
  10. data/lib/mu/client.rb +31 -0
  11. data/lib/mu/command.rb +28 -0
  12. data/lib/mu/command/api.rb +95 -0
  13. data/lib/mu/command/cmd_appid.rb +486 -0
  14. data/lib/mu/command/cmd_cli.rb +151 -0
  15. data/lib/mu/command/cmd_ddt.rb +449 -0
  16. data/lib/mu/command/cmd_homepage.rb +146 -0
  17. data/lib/mu/command/cmd_muapi.rb +361 -0
  18. data/lib/mu/command/cmd_netconfig.rb +262 -0
  19. data/lib/mu/command/cmd_runscale.rb +533 -0
  20. data/lib/mu/command/cmd_runscenario.rb +258 -0
  21. data/lib/mu/command/cmd_runverify.rb +336 -0
  22. data/lib/mu/command/cmd_scale.rb +333 -0
  23. data/lib/mu/command/cmd_system.rb +127 -0
  24. data/lib/mu/command/curl.rb +246 -0
  25. data/lib/mu/command/help.rb +29 -0
  26. data/lib/mu/curl/error.rb +54 -0
  27. data/lib/mu/curl/verify.rb +137 -0
  28. data/lib/mu/helper.rb +55 -0
  29. data/lib/mu/http_helper.rb +232 -0
  30. data/rdoc/classes/Mu.html +305 -0
  31. data/rdoc/classes/Mu/Client.html +265 -0
  32. data/rdoc/classes/Mu/Command.html +208 -0
  33. data/rdoc/classes/Mu/Command/API.html +524 -0
  34. data/rdoc/classes/Mu/Command/Cmd_appid.html +934 -0
  35. data/rdoc/classes/Mu/Command/Cmd_cli.html +515 -0
  36. data/rdoc/classes/Mu/Command/Cmd_ddt.html +1169 -0
  37. data/rdoc/classes/Mu/Command/Cmd_homepage.html +489 -0
  38. data/rdoc/classes/Mu/Command/Cmd_muapi.html +968 -0
  39. data/rdoc/classes/Mu/Command/Cmd_netconfig.html +743 -0
  40. data/rdoc/classes/Mu/Command/Cmd_runscale.html +970 -0
  41. data/rdoc/classes/Mu/Command/Cmd_runscenario.html +530 -0
  42. data/rdoc/classes/Mu/Command/Cmd_runverify.html +621 -0
  43. data/rdoc/classes/Mu/Command/Cmd_scale.html +939 -0
  44. data/rdoc/classes/Mu/Command/Cmd_system.html +426 -0
  45. data/rdoc/classes/Mu/Command/Curl.html +524 -0
  46. data/rdoc/classes/Mu/Command/Help.html +166 -0
  47. data/rdoc/classes/Mu/Curl.html +116 -0
  48. data/rdoc/classes/Mu/Curl/Error.html +157 -0
  49. data/rdoc/classes/Mu/Curl/Error/Authorize.html +178 -0
  50. data/rdoc/classes/Mu/Curl/Error/Connect.html +149 -0
  51. data/rdoc/classes/Mu/Curl/Error/DNS.html +113 -0
  52. data/rdoc/classes/Mu/Curl/Error/Region.html +160 -0
  53. data/rdoc/classes/Mu/Curl/Error/Status.html +149 -0
  54. data/rdoc/classes/Mu/Curl/Error/Timeout.html +149 -0
  55. data/rdoc/classes/Mu/Curl/Verify.html +282 -0
  56. data/rdoc/classes/Mu/Curl/Verify/Request.html +227 -0
  57. data/rdoc/classes/Mu/Curl/Verify/Response.html +187 -0
  58. data/rdoc/classes/Mu/Curl/Verify/Result.html +188 -0
  59. data/rdoc/classes/Mu/Ddt.html +914 -0
  60. data/rdoc/classes/Mu/Helper.html +308 -0
  61. data/rdoc/classes/Mu/Homepage.html +377 -0
  62. data/rdoc/classes/Mu/HttpHelper.html +639 -0
  63. data/rdoc/classes/Mu/Muapi.html +816 -0
  64. data/rdoc/classes/Mu/Netconfig.html +781 -0
  65. data/rdoc/classes/Mu/Scale.html +832 -0
  66. data/rdoc/classes/Mu/System.html +281 -0
  67. data/rdoc/classes/Object.html +148 -0
  68. data/rdoc/classes/TCTestMu.html +1793 -0
  69. data/rdoc/classes/Test.html +107 -0
  70. data/rdoc/classes/Test/Unit.html +107 -0
  71. data/rdoc/classes/Test/Unit/TestCase.html +113 -0
  72. data/rdoc/created.rid +1 -0
  73. data/rdoc/files/lib/mu/api/ddt_rb.html +101 -0
  74. data/rdoc/files/lib/mu/api/homepage_rb.html +101 -0
  75. data/rdoc/files/lib/mu/api/muapi_rb.html +101 -0
  76. data/rdoc/files/lib/mu/api/netconfig_rb.html +101 -0
  77. data/rdoc/files/lib/mu/api/scale_rb.html +101 -0
  78. data/rdoc/files/lib/mu/api/system_rb.html +101 -0
  79. data/rdoc/files/lib/mu/client_rb.html +101 -0
  80. data/rdoc/files/lib/mu/command/api_rb.html +101 -0
  81. data/rdoc/files/lib/mu/command/cmd_appid_rb.html +119 -0
  82. data/rdoc/files/lib/mu/command/cmd_cli_rb.html +108 -0
  83. data/rdoc/files/lib/mu/command/cmd_ddt_rb.html +117 -0
  84. data/rdoc/files/lib/mu/command/cmd_homepage_rb.html +115 -0
  85. data/rdoc/files/lib/mu/command/cmd_muapi_rb.html +116 -0
  86. data/rdoc/files/lib/mu/command/cmd_netconfig_rb.html +116 -0
  87. data/rdoc/files/lib/mu/command/cmd_runscale_rb.html +119 -0
  88. data/rdoc/files/lib/mu/command/cmd_runscenario_rb.html +115 -0
  89. data/rdoc/files/lib/mu/command/cmd_runverify_rb.html +117 -0
  90. data/rdoc/files/lib/mu/command/cmd_scale_rb.html +115 -0
  91. data/rdoc/files/lib/mu/command/cmd_system_rb.html +116 -0
  92. data/rdoc/files/lib/mu/command/curl_rb.html +101 -0
  93. data/rdoc/files/lib/mu/command/help_rb.html +101 -0
  94. data/rdoc/files/lib/mu/command_rb.html +107 -0
  95. data/rdoc/files/lib/mu/curl/error_rb.html +101 -0
  96. data/rdoc/files/lib/mu/curl/verify_rb.html +101 -0
  97. data/rdoc/files/lib/mu/helper_rb.html +101 -0
  98. data/rdoc/files/lib/mu/http_helper_rb.html +101 -0
  99. data/rdoc/files/lib/mu_rb.html +121 -0
  100. data/rdoc/files/test/helper_rb.html +112 -0
  101. data/rdoc/files/test/tc_test_mu_rb.html +111 -0
  102. data/rdoc/fr_class_index.html +68 -0
  103. data/rdoc/fr_file_index.html +55 -0
  104. data/rdoc/fr_method_index.html +374 -0
  105. data/rdoc/index.html +24 -0
  106. data/rdoc/rdoc-style.css +208 -0
  107. data/test/data/app_id_stats.csv +1 -0
  108. data/test/data/data_cgi.msl +94 -0
  109. data/test/data/data_cgi.xml +322 -0
  110. data/test/data/default_test.csv +3 -0
  111. data/test/data/ftp_with_channel.xml +1643 -0
  112. data/test/data/irc.xml +3837 -0
  113. data/test/data/scale_configuration.json +25 -0
  114. data/test/data/test_data_cgi_error.xml +35 -0
  115. data/test/helper.rb +18 -0
  116. data/test/tc_test_mu.rb +716 -0
  117. metadata +322 -0
data/Mu_Gem.html ADDED
@@ -0,0 +1,1591 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
+ <html>
3
+ <head>
4
+ <meta content="text/html; charset=ISO-8859-1"
5
+ http-equiv="content-type" />
6
+ <title>Using the Mu Gem</title>
7
+ <style type="text/css">
8
+
9
+
10
+ #masthead{
11
+ margin: 0;
12
+ border-bottom: 1px solid #cccccc;
13
+ width: 600px;
14
+ padding-top: 10px;
15
+ padding-right: 0px;
16
+ padding-bottom: 5px;
17
+ padding-left: 0px;
18
+ }
19
+
20
+ #content{
21
+ float: left;
22
+ width: 600px;
23
+ margin: 0;
24
+ padding: 0 3% 0 0;
25
+ line-height: 16px;
26
+ }
27
+
28
+ #siteInfo{
29
+ clear: both;
30
+ border: 1px solid #cccccc;
31
+ font-size: 75%;
32
+ color: #cccccc;
33
+ background-color:inherit;
34
+ padding: 10px 10px 10px 10px;
35
+ margin-top: 0px;
36
+ width: 100%;
37
+ }
38
+
39
+ body {
40
+ background-color: #FFFFFF;
41
+ font-family: Arial, sans-serif;
42
+ font-size: 9pt;
43
+ color: #333333;
44
+ left:auto;
45
+ top: auto;
46
+ bottom: auto;
47
+ margin: 10 0 0 10px;
48
+ right: auto;
49
+ width: 95%;
50
+ }
51
+
52
+ p {
53
+ font-family: Arial, sans-serif;
54
+ font-size: 9pt;
55
+ text-align: left;
56
+ line-height: 16px;
57
+ width: auto;
58
+ margin-top: 10px;
59
+ margin-left: 10px;
60
+ padding: 0px;
61
+ }
62
+
63
+ a:link, a:visited {
64
+ color: #3B6EBF;
65
+ background-color: transparent;
66
+ text-decoration: none;
67
+ }
68
+
69
+ a:hover {
70
+ color: #3B6EBF;
71
+ text-decoration: underline;
72
+ }
73
+
74
+ .note {
75
+ font-style: italic;
76
+ font-size: 9pt;
77
+ font-family: Helvetica, Arial, sans-serif;
78
+ margin-top: 10px;
79
+ margin-right: 0;
80
+ margin-bottom: 5px;
81
+ margin-left: 10px;
82
+ width: 85%;
83
+ }
84
+
85
+ li {
86
+ font-family: Arial, sans-serif;
87
+ font-size: 9pt;
88
+ font-weight: normal;
89
+ line-height: 16px;
90
+ width: auto;
91
+ margin-top: 0px;
92
+ margin-right: 0px;
93
+ margin-bottom: 10px;
94
+ margin-left: 6px;
95
+ padding-top: 0px;
96
+ padding-right: 2%;
97
+ padding-bottom: 0px;
98
+ padding-left: 0px;
99
+ }
100
+
101
+ ul {
102
+ list-style-type: disc;
103
+ list-style-position: outside;
104
+ margin-top: 8px;
105
+ }
106
+
107
+
108
+ h1{
109
+ font-family: Arial, Helvetica, sans-serif;
110
+ font-size: 12pt;
111
+ color: #E95D20;
112
+ background-color: inherit;
113
+ padding-top: 10px;
114
+ background-image: none;
115
+ font-weight: bold;
116
+ margin: 0px;
117
+ width: 100%;
118
+ text-align: center;
119
+ }
120
+ .subhead {
121
+ font-family: Arial, Helvetica, sans-serif;
122
+ font-size: 9pt;
123
+ font-style: italic;
124
+ line-height: 16px;
125
+ text-align: center;
126
+ margin-right: 120px;
127
+ margin-left: 120px;
128
+ }
129
+
130
+ h2{
131
+ -moz-border-radius-bottomleft:0;
132
+ -moz-border-radius-bottomright:0;
133
+ -moz-border-radius-topleft:8px;
134
+ -moz-border-radius-topright:8px;
135
+ color:#E95D20;
136
+ font-family:Arial, sans-serif;
137
+ font-size:10pt;
138
+ font-style:oblique;
139
+ margin:25 0 0 8px;
140
+ padding: 4 2 1 0px;
141
+ }
142
+
143
+ h3{
144
+ -moz-border-radius-bottomleft:0;
145
+ -moz-border-radius-bottomright:0;
146
+ -moz-border-radius-topleft:8px;
147
+ -moz-border-radius-topright:8px;
148
+ border:1px solid silver;
149
+ font-size: 9pt;
150
+ color: #333333;
151
+ background-color: #E7E7E7;
152
+ font-weight: bold;
153
+ width: 600px;
154
+ padding-top: 4px;
155
+ padding-bottom: 1px;
156
+ padding-left: 6px;
157
+ margin-top: 20px;
158
+ margin-left: 6px;
159
+ }
160
+
161
+ h4{
162
+ font-size: 9pt;
163
+ font-weight: bold;
164
+ vertical-align: top;
165
+ text-align: left;
166
+ margin-top: 0px;
167
+ margin-right: 15px;
168
+ margin-bottom: 5px;
169
+ margin-left: 10px;
170
+ color: #333333;
171
+ font-style: normal;
172
+ font-variant: normal;
173
+ text-transform: none;
174
+ border: #DFDFDF; }
175
+
176
+
177
+ h5{
178
+ font-size: 9pt;
179
+ color: #333333;
180
+ font-style: italic;
181
+ font-weight: normal;
182
+ margin: 6px 2px 4px 2px;
183
+ padding: 0px;
184
+ }
185
+
186
+ h6 {
187
+ border:1px solid silver;
188
+ font-size: 9pt;
189
+ color: #333333;
190
+ font-weight: normal;
191
+ background-color: #E7E7E7;
192
+ width: 96%;
193
+ padding-top: 4px;
194
+ padding-bottom: 1px;
195
+ padding-left: 4px;
196
+ margin-top: 15px;
197
+ margin-left: 4px;
198
+ margin-right:2px;
199
+ margin-bottom:1px;
200
+ }
201
+
202
+ .copyright {
203
+ font-size: 9pt;
204
+ font-style: italic;
205
+ }
206
+
207
+ /*********** begin wide tables ***********/
208
+ table.wide {
209
+ background: #FFFFFF;
210
+ border-collapse: collapse;
211
+ align: left;
212
+ width: 98%;
213
+ margin-top: 3%;
214
+ margin-right: 1%;
215
+ margin-bottom: 3%;
216
+ margin-left: 15px;
217
+ }
218
+ table.wide th, table.wide td {
219
+ border: 1px silver solid;
220
+ padding: 0.2em;
221
+ }
222
+
223
+ table.wide td {
224
+ width:auto;
225
+ font-family: Arial, Helvetica, sans-serif;
226
+ font-size: 9pt;
227
+ height: auto;
228
+ line-height:16px;
229
+ padding:6px 2px 2px 4px;
230
+ }
231
+
232
+ table.wide th {
233
+ background: #E7E7E7;
234
+ text-align: left;
235
+ vertical-align: middle;
236
+ font: Arial, Helvetica, sans-serif;
237
+ font-size: 9pt;
238
+ font-weight: bold;
239
+ color: #333333;
240
+ padding-top: 4px;
241
+ padding-right: 4px;
242
+ padding-bottom: 2px;
243
+ padding-left: 6px;
244
+ }
245
+
246
+ #important{
247
+ float: clear;
248
+ color: #333333;
249
+ background-color: #e7eedc;
250
+ -moz-border-radius-bottomleft:0;
251
+ -moz-border-radius-bottomright:0;
252
+ -moz-border-radius-topleft:8px;
253
+ -moz-border-radius-topright:8px;
254
+ border:1px solid silver;
255
+ font-size: 9pt;
256
+ padding-top: 2px;
257
+ padding-bottom: 0px;
258
+ padding-left: 2px;
259
+ margin-top: 15px;
260
+ margin-left: 15px;
261
+ margin-right: 35px;
262
+ margin-bottom: 15px;
263
+ }
264
+
265
+ .code{
266
+ font-family: Courier, monospace;
267
+ font-size: 9pt
268
+ }
269
+
270
+
271
+ /*********** end wide tables ***********/
272
+
273
+ -->
274
+ </style>
275
+ </head>
276
+ <body>
277
+ <div id="masthead">
278
+ <h1>Mu Ruby Gem</h1>
279
+ <p align="center" class="subhead"></p>
280
+ </div>
281
+
282
+ <div id="content">
283
+ <p><font class="body"><a name="top" id="cmd_runscale4"></a></font> </p>
284
+ <div id="important">
285
+ <p><strong>Before Using This Gem</strong>:</p>
286
+ <ul>
287
+ <li><strong><em>Note: The Mu Gem install will also install the following ruygems</em></strong>. You must have installed ruby 1.8.6 or higher and also rubygems:
288
+ <ul>
289
+ <li><em>hexy</em>. This ensures that hex dumps print pretty :)</li>
290
+ <li><em>json_pure</em>. Don't confuse this with the json gem (that won't work).</li>
291
+ <li><em>nokogiri</em>. See http://nokogiri.org/tutorials/installing_nokogiri.html for help.</li>
292
+ <li><em>rest-client</em>. Used for HTTP calls. </li>
293
+ <li><em>mime-types</em>. Required by REST-client.</li>
294
+ </ul>
295
+ </li>
296
+ <li><strong><em>Set the Mu environment variables</em></strong>.
297
+ <ul>
298
+ <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
+ <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>.</li>
301
+ </ul></li></ul></div>
302
+ <h2 class=MsoNormal>Executables</h2>
303
+ &nbsp;&nbsp;&nbsp;<a href="#executables">&nbsp;&nbsp;&nbsp;go to section &raquo;</a>
304
+ <p>Command-line applications for running Scale tests, Test Sets, and working in the Scenario Editor. </p>
305
+ <ul>
306
+ <li><a href="#cmd_appid">cmd_appid</a><span
307
+ style="mso-spacerun: yes">&nbsp;&nbsp;&nbsp; </span></li>
308
+ <li><a href="#cmd_runscale">cmd_runscale</a></li>
309
+ <li><a href="#cmd_runverify">cmd_runverify</a></li>
310
+ <li><a href="#cmd_runscenario">cmd_runscenario</a></li>
311
+ </ul>
312
+ <h2>Legacy REST API Commands</h2>
313
+ &nbsp;&nbsp;&nbsp;&nbsp;<a href="#executables"></a>&nbsp;<a href="#executables"></a>&nbsp;<a href="#executables"></a><a href="#api-methods">go to section &raquo;</a>
314
+ <p>&nbsp;&nbsp;&nbsp; These commands provide access to legacy REST API commands supported by the Mu system. </p>
315
+ <ul>
316
+ <li><a href="#cmd_ddt">cmd_ddt</a></li>
317
+ <li><a href="#cmd_scale">cmd_scale</a></li>
318
+ <li><a href="#cmd_netconfig">cmd_netconfig</a></li>
319
+ <li><a href="#cmd_muapi">cmd_muapi</a></li>
320
+ <li><a href="#cmd_homepage">cmd_homepage</a></li>
321
+ <li><a href="#cmd_system">cmd_system</a></li>
322
+ <li><a href="#cmd_cli">cmd_cli</a></li>
323
+ </ul>
324
+ <h2>API Library Classes</h2>
325
+ &nbsp;&nbsp;&nbsp;<a href="#library-classes">&nbsp;&nbsp;&nbsp;go to section &raquo;</a>
326
+ <p>API library classes that can be &lsquo;required&rsquo; and used within Ruby scripts
327
+ like most rubygems.</p>
328
+ <ul>
329
+ <li><a href="#ddt">ddt</a></li>
330
+ <li><a href="#scale">scale</a></li>
331
+ <li><a href="#netconfig">netconfig</a></li>
332
+ <li><a href="#muapi">muapi</a></li>
333
+ </ul>
334
+
335
+ <h3><a name="executables" id="features3"></a>Executables </h3>
336
+ <p>Command-line applications for running Studio Scale, Studio Verify, and
337
+ the Scenario Editor.</p>
338
+ <ul>
339
+ <li><a href="#cmd_appid">cmd_appid</a><span
340
+ style="mso-spacerun: yes">&nbsp;&nbsp;&nbsp; </span></li>
341
+ <li><a href="#cmd_runscale">cmd_runscale</a></li>
342
+ <li><a href="#cmd_runverify">cmd_runverify</a></li>
343
+ <li><a href="#cmd_runscenario">cmd_runscenario</a> </li>
344
+ </ul>
345
+ <h2><a name="cmd_appid" id="features4"></a>cmd_appid</h2>
346
+ <p>Runs Mu Studio multi-host app_id msl files in Studio
347
+ Scale, in client/server passthrough mode, collapsing all hosts in the
348
+ Scenario to two. Runs a single msl file or a directory of msl files. Supports command-line options to specify the Mu parameters, interfaces to
349
+ use, and the concurrency pattern.</p>
350
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
351
+ <tr>
352
+ <th>Command</th>
353
+ <th>Description &amp; Examples</th>
354
+ </tr>
355
+ <tr>
356
+ <td><em>help</em></td>
357
+ <td><p>Gets help for all cmd_appid commands: <strong>help</strong></p>
358
+ <h6 class="code">mu cmd_appid:help</h6></td>
359
+ </tr>
360
+ <tr>
361
+ <td><h5>run_file</h5></td>
362
+ <td><p> Runs the specified .msl file: <strong>run_file -s</strong> <em>msl-filename</em></p>
363
+ <h6><span class="code">mu cmd_appid:run_file -s msl_file -i a1,a2 -m
364
+ admin:admin@10.10.2.2 -p 1-10000:60</span></h6></td>
365
+ </tr>
366
+ <tr>
367
+ <td><em>run_dir</em></td>
368
+ <td><p>Runs all .msl files in the specified directory: <strong>run_dir -d</strong> <em>msl-directory</em><strong>(optional, to recurse) -r</strong> </p>
369
+ <h6><span class="code">mu cmd_appid:run_dir -d msl_file_directory -i a1-10000,a2
370
+ -m admin:admin@10.10.2.2 -p 1-100000:360</span></h6>
371
+ <p></p></td>
372
+ </tr>
373
+ <tr>
374
+ <td><em>running?</em></td>
375
+ <td><p>Gets status of the scale player: <strong>running?</strong></p>
376
+ <h6><span class="code">mu cmd_appid:running?</span></h6></td>
377
+ </tr>
378
+ </table>
379
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
380
+ <tr>
381
+ <th colspan="2">Options (short &amp; long form)</th>
382
+ <th width="60%">Description</th>
383
+ </tr>
384
+ <tr>
385
+ <td width="4%">-c</td>
386
+ <td width="36%"><strong>--csv</strong> <em>csv-filename</em></td>
387
+ <td>Specify the filename of the .csv file that contains the test cases to run.</td>
388
+ </tr>
389
+ <tr>
390
+ <td>-d</td>
391
+ <td><strong>--dir</strong> <em>directory</em></td>
392
+ <td>Specify the directory that contains .msl files to run(required for run_dir).</td>
393
+ </tr>
394
+ <tr>
395
+ <td>-h</td>
396
+ <td><strong>--help</strong></td>
397
+ <td>Get help on command line options.</td>
398
+ </tr>
399
+ <tr>
400
+ <td>-i</td>
401
+ <td><strong>--interfaces</strong> <em>interfaces</em></td>
402
+ <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>
403
+ </tr>
404
+ <tr>
405
+ <td>-m</td>
406
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
407
+ <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
408
+ </tr>
409
+ <tr>
410
+ <td>-o</td>
411
+ <td><strong>--output</strong> <em>filename</em></td>
412
+ <td>Specify the filename to which you want to output logs.</td>
413
+ </tr>
414
+ <tr>
415
+ <td>-p</td>
416
+ <td><strong>--pattern</strong> <em>con-start</em>:<em>dur</em>,<em>con-end</em>:<em>dur</em></td>
417
+ <td>Specify pattern as concurrency_start:duration,concurrency-end:duration. Duration is in seconds. Example:
418
+ <span class="code">1-10000:60,10000-1:30</span>. </td>
419
+ </tr>
420
+ <tr>
421
+ <td>-r</td>
422
+ <td><strong>--recursive</strong></td>
423
+ <td>optional, for run_dir, to recurse</td>
424
+ </tr>
425
+ <tr>
426
+ <td>-s</td>
427
+ <td><strong>--scenario</strong> <em>msl-filename</em></td>
428
+ <td>Specify the .msl filename (required for
429
+ run_msl)</td>
430
+ </tr>
431
+ <tr>
432
+ <td>-t</td>
433
+ <td><strong>--test</strong></td>
434
+ <td>Run a verification check only.</td>
435
+ </tr>
436
+ <tr>
437
+ <td>-v</td>
438
+ <td><strong>--verbose</strong></td>
439
+ <td>Set
440
+ the Logger::DEBUG level.</td>
441
+ </tr>
442
+ </table>
443
+ <p><a href="#top">back to top &uarr;</a></p>
444
+ <h2><a name="cmd_runscale" id="cmd_runscale"></a>cmd_runscale</h2>
445
+ <p>Runs Mu Studio scenario msl files in Studio Scale,
446
+ requiring that all interfaces and hosts used in the scenario are specified on
447
+ the command-line through the &#8211;i option. Runs either a single msl file
448
+ or a directory of msl files, and has command-line options to specify the Mu
449
+ parameters, the interfaces to use, and the pattern in which to run. </p>
450
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
451
+ <tr>
452
+ <th>Command</th>
453
+ <th>Commands &amp; Examples</th>
454
+ </tr>
455
+ <tr>
456
+ <td><em>help</em></td>
457
+ <td><p>Gets help for all cmd_runscale commands: <strong>help</strong></p>
458
+ <h6 class="code">mu cmd_runscale:help</h6></td>
459
+ </tr>
460
+ <tr>
461
+ <td><h5>run_file</h5></td>
462
+ <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>
463
+ <h6 class="code">mu cmd_runscale:run_file -s msl_file -i a1,dell-9 -p 1-10000:30</h6></td>
464
+ </tr>
465
+ <tr>
466
+ <td><em>run_dir</em></td>
467
+ <td><p>Runs all .msl files in the specified directory: <strong>run_dir -d </strong><em>msl_directory</em><strong>(optional, to recurse) -r </strong></p>
468
+ <h6 class="code">mu cmd_runscale:run_dir -d msl_file_directory</h6>
469
+ <p></p></td>
470
+ </tr>
471
+ <tr>
472
+ <td><em>running?</em></td>
473
+ <td><p>Gets status of the scale player: <strong>running?</strong></p>
474
+ <h6><span class="code">mu cmd_runscale:running?</span></h6></td>
475
+ </tr>
476
+ </table>
477
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
478
+ <tr>
479
+ <th colspan="2">Options (short &amp; long form)</th>
480
+ <th width="60%">Description</th>
481
+ </tr>
482
+ <tr>
483
+ <td width="4%">-c</td>
484
+ <td width="36%"><strong>--csv</strong> <em>csv-filename</em></td>
485
+ <td>Specify the filename of the .csv file that contains the test cases to run.</td>
486
+ </tr>
487
+ <tr>
488
+ <td>-d</td>
489
+ <td><strong>--dir</strong> <em>directory</em></td>
490
+ <td>Specify the directory that contains .msl files to run(required for run_dir).</td>
491
+ </tr>
492
+ <tr>
493
+ <td>-f</td>
494
+ <td><strong>--default_host</strong> <em>default-host</em></td>
495
+ <td>Specify the default host. This host is used for all hosts in the scenario which have not been explicitly assigned</td>
496
+ </tr>
497
+ <tr>
498
+ <td>-h</td>
499
+ <td><strong>--help</strong></td>
500
+ <td>Get help on command line options.</td>
501
+ </tr>
502
+ <tr>
503
+ <td>-i</td>
504
+ <td><strong>--interfaces</strong> <em>interfaces</em></td>
505
+ <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>
506
+ </tr>
507
+ <tr>
508
+ <td>-m</td>
509
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
510
+ <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
511
+ </tr>
512
+ <tr>
513
+ <td>-o</td>
514
+ <td><strong>--output</strong> <em>filename</em></td>
515
+ <td>Specify the filename to which you want to output logs.</td>
516
+ </tr>
517
+ <tr>
518
+ <td>-p</td>
519
+ <td><strong>--pattern</strong> <em>con-start</em>:<em>dur</em>,<em>con-end</em>:<em>dur</em></td>
520
+ <td>Specify pattern as concurrency_start:duration,concurrency-end:duration. Duration is in seconds. Example:
521
+ <span class="code">1-10000:60,10000-1:30</span>. </td>
522
+ </tr>
523
+ <tr>
524
+ <td>-r</td>
525
+ <td><strong>--recursive</strong></td>
526
+ <td>optional, for run_dir, to recurse</td>
527
+ </tr>
528
+ <tr>
529
+ <td>-s</td>
530
+ <td><strong>--scenario</strong> <em>msl-filename</em></td>
531
+ <td>Specify the .msl filename (required for
532
+ run_msl)</td>
533
+ </tr>
534
+ <tr>
535
+ <td>-t</td>
536
+ <td><strong>--test</strong></td>
537
+ <td>Run a verification check only.</td>
538
+ </tr>
539
+ <tr>
540
+ <td>-v</td>
541
+ <td><strong>--verbose</strong></td>
542
+ <td>Set
543
+ the Logger::DEBUG level.</td>
544
+ </tr>
545
+ </table>
546
+ <p><a href="#top">back to top &uarr;</a></p>
547
+ <h2><a name="cmd_runverify" id="cmd_runscale2"></a>cmd_runverify</h2>
548
+ <p>Runs a Studio Verify test, given a Mu Studio Scenario and
549
+ Test Set (The scenario template must be in Mu Studio XML format. The
550
+ Test Set template can be in either the Mu Studio XML format or CSV).</p>
551
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
552
+ <tr>
553
+ <th>Command</th>
554
+ <th>Commands &amp; Examples</th>
555
+ </tr>
556
+ <tr>
557
+ <td><em>help</em></td>
558
+ <td><p>Gets help for all cmd_runverify commands: <strong>help</strong></p>
559
+ <h6 class="code">mu cmd_runverify:help</h6></td>
560
+ </tr>
561
+ <tr>
562
+ <td><h5>run</h5></td>
563
+ <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>
564
+ <h6 class="code">mu cmd_runverify:run -s my_scenario -t my_testset -i a1,my-server</h6></td>
565
+ </tr>
566
+ </table>
567
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
568
+ <tr>
569
+ <th colspan="2">Options (short &amp; long form)</th>
570
+ <th width="60%">Description</th>
571
+ </tr>
572
+ <tr>
573
+ <td width="4%">-c</td>
574
+ <td width="36%"><strong>--channels</strong> <em>hosts</em></td>
575
+ <td>Specify channel hosts as a comma-separated list. </td>
576
+ </tr>
577
+ <tr>
578
+ <td>-d</td>
579
+ <td><strong>--dir</strong> <em>directory</em></td>
580
+ <td>Specify the directory with Scenario templates to run.</td>
581
+ </tr>
582
+ <tr>
583
+ <td>-h</td>
584
+ <td><strong>--help</strong></td>
585
+ <td>Get help on command line options.</td>
586
+ </tr>
587
+ <tr>
588
+ <td>-i</td>
589
+ <td><strong>--interfaces</strong> <em>interfaces</em></td>
590
+ <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>
591
+ </tr>
592
+ <tr>
593
+ <td>-m</td>
594
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
595
+ <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
+ </tr>
597
+ <tr>
598
+ <td>-o</td>
599
+ <td><strong>--output</strong> <em>filename</em></td>
600
+ <td>Specify the filename to which you want to output logs.</td>
601
+ </tr>
602
+ <tr>
603
+ <td>-p</td>
604
+ <td><strong>--options</strong><em> option:value</em></td>
605
+ <td>Specify option/value pairs as a comma-separated list. Example: <span class="code">user:jane,email:jsmith@itemp.com</span></td>
606
+ </tr>
607
+ <tr>
608
+ <td>-s</td>
609
+ <td><strong>--scenario</strong> <em>scenario-template</em></td>
610
+ <td>Specify the Scenario template to run (must be xml).</td>
611
+ </tr>
612
+ <tr>
613
+ <td>-t</td>
614
+ <td><strong>--testset </strong><em>testset-template</em></td>
615
+ <td>Specify the Test Set template to run (must be xml).</td>
616
+ </tr>
617
+ <tr>
618
+ <td>-v</td>
619
+ <td><strong>--verbose</strong></td>
620
+ <td>Set
621
+ the Logger::DEBUG level.</td>
622
+ </tr>
623
+ </table>
624
+ <p><a href="#top">back to top &uarr;</a></p>
625
+ <h2><a name="cmd_runscenario" id="cmd_runscale3"></a>cmd_runscenario</h2>
626
+ <p>Verifies a Mu
627
+ Studio scenario xml template.</p>
628
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
629
+ <tr>
630
+ <th>Command</th>
631
+ <th>Commands &amp; Examples</th>
632
+ </tr>
633
+ <tr>
634
+ <td><em>help</em></td>
635
+ <td><p>Gets help for all cmd_runscenario commands: <strong>help</strong></p>
636
+ <h6 class="code">mu cmd_runscenario:help</h6></td>
637
+ </tr>
638
+ <tr>
639
+ <td><h5>run</h5></td>
640
+ <td><p>Runs the specified Scenario template: <strong>run -s</strong> <em>scenario.xml</em><strong> -i</strong><em> interfaces/hosts</em></p>
641
+ <h6 class="code">mu cmd_runscenario:run -s my_scenario -i a1,my-server</h6></td>
642
+ </tr>
643
+ </table>
644
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
645
+ <tr>
646
+ <th colspan="2">Options (short &amp; long form)</th>
647
+ <th width="60%">Description</th>
648
+ </tr>
649
+ <tr>
650
+ <td width="4%">-c</td>
651
+ <td width="36%"><strong>--channels</strong> <em>hosts</em></td>
652
+ <td>Specify channel hosts as a comma-separated list. </td>
653
+ </tr>
654
+ <tr>
655
+ <td>-d</td>
656
+ <td><strong>--dir</strong> <em>directory</em></td>
657
+ <td>Specify the directory with Scenario templates to run.</td>
658
+ </tr>
659
+ <tr>
660
+ <td>-h</td>
661
+ <td><strong>--help</strong></td>
662
+ <td>Get help on command line options.</td>
663
+ </tr>
664
+ <tr>
665
+ <td>-i</td>
666
+ <td><strong>--interfaces</strong> <em>interfaces</em></td>
667
+ <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>
668
+ </tr>
669
+ <tr>
670
+ <td>-m</td>
671
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
672
+ <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
673
+ </tr>
674
+ <tr>
675
+ <td>-o</td>
676
+ <td><strong>--output</strong> <em>filename</em></td>
677
+ <td>Specify the filename to which you want to output logs.</td>
678
+ </tr>
679
+ <tr>
680
+ <td>-s</td>
681
+ <td><strong>--scenario</strong> <em>scenario-template</em></td>
682
+ <td>Specify the Scenario template to run (must be xml).</td>
683
+ </tr>
684
+ <tr>
685
+ <td>-v</td>
686
+ <td><strong>--verbose</strong></td>
687
+ <td>Set
688
+ the Logger::DEBUG level.</td>
689
+ </tr>
690
+ </table>
691
+ <p><a href="#top">back to top &uarr;</a></p>
692
+ <p>&nbsp;</p>
693
+ <h3><a name="api-methods" id="features"></a>API Methods</h3>
694
+ <p>These commands provide access to legacy REST API commands supported by the Mu system. </p>
695
+ <ul>
696
+ <li><a href="#cmd_muapi">cmd_muapi</a></li>
697
+ <li><a href="#cmd_netconfig">cmd_netconfig</a></li>
698
+ <li><a href="#cmd_ddt">cmd_ddt</a></li>
699
+ <li><a href="#cmd_scale">cmd_scale</a></li>
700
+ <li><a href="#cmd_homepage">cmd_homepage</a></li>
701
+ <li><a href="#cmd_system">cmd_system</a></li>
702
+ <li><a href="#cmd_cli">cmd_cli</a> </li>
703
+ </ul>
704
+ <h2><a name="cmd_muapi" id="cmd_runscale5"></a>cmd_muapi</h2>
705
+ <p>Use these commands to access the legacy REST API for Test Runs (Protocol Mutation, Scenario Mutation, DoS, and PV tests). </p>
706
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
707
+ <tr>
708
+ <th>Command</th>
709
+ <th>Description &amp; Examples</th>
710
+ </tr>
711
+ <tr>
712
+ <td><em>help</em></td>
713
+ <td>Gets help for all cmd_muapi commands: <strong>help</strong>
714
+ <h6 class="code">mu cmd_muapi:help</h6></td>
715
+ </tr>
716
+ <tr>
717
+ <td><em>archive</em></td>
718
+ <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>
719
+ <br>
720
+ <h6 class="code">mu cmd_muapi:archive -c run -u 52add3cf-9040-42ce-b263-8233039931d5</h6>
721
+ <p>Get the status of the archive report:</p>
722
+ <h6><span class="code">mu cmd_muapi:archive -c status -u 1296064526931</span></h6>
723
+ <p>Download the archive report:
724
+ </p>
725
+ <h6><span class="code">mu cmd_muapi:archive -c get -u 1296064526931</span></h6></td>
726
+ </tr>
727
+ <tr>
728
+ <td><em>backup</em></td>
729
+ <td>Manage system backup files. <strong>backup</strong> <strong>-c</strong><em> command</em>
730
+ <p>Generate system backup:</p>
731
+ <h6 class="code">mu cmd_muapi:backup -c run</h6>
732
+ <p>Get the status of the backup job:</p>
733
+ <h6><span class="code">mu cmd_muapi:backup -c status</span></h6>
734
+ <p>Download the backup file (requires a name): <strong>backup</strong> <strong>-c</strong> <strong>get -n</strong><em> filename</em></p>
735
+ <h6><span class="code">mu cmd_muapi:backup -c get -n my-backup</span></h6>
736
+ <p>The Mu system automatically appends the .dat extension to all backup files.</p></td>
737
+ </tr>
738
+ <tr>
739
+ <td><em>capture</em></td>
740
+ <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>
741
+ <p>Start recording packets (this command returns the job-id):</p>
742
+ <h6 class="code">mu cmd_muapi:capture -c run -p a1</h6>
743
+ <p>Get the status of the packet recording job:</p>
744
+ <h6><span class="code">mu cmd_muapi:capture -c status -p a1 -u 1296064526931</span></h6>
745
+ <p>Download the recorded packet capture: </p>
746
+ <h6><span class="code">mu cmd_muapi:capture -c get -p a1 -u 1296064526931</span></h6></td>
747
+ </tr>
748
+ <tr>
749
+ <td><em>delete</em></td>
750
+ <td>Delete the specified Test Run or template: <strong>delete -u</strong> <em>uuid</em>
751
+ <h6 class="code">mu cmd_muapi:delete -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
752
+ </tr>
753
+ <tr>
754
+ <td><em>export_by_name</em></td>
755
+ <td>Export the specified template: <strong>export_by_name -n</strong> <em>name</em>
756
+ <strong>-t</strong> <em>type</em>
757
+ <h6 class="code">mu cmd_muapi:export_by_name -n my_monitor -t monitor</h6></td>
758
+ </tr>
759
+ <tr>
760
+ <td><em>get_faults</em></td>
761
+ <td>Get a list of faults (xml format) from a Test Run: <strong>get_faults -u</strong> <em>uuid</em> <strong>-v</strong>
762
+ <h6 class="code">mu cmd_muapi:get_faults -u 52add3cf-9040-42ce-b263-8233039931d5 -v</h6></td>
763
+ </tr>
764
+ <tr>
765
+ <td><em>get_name</em></td>
766
+ <td>Get details for the specified Test Run or template: <strong>get_name -u</strong> <em>uuid</em>
767
+ <h6><span class="code">mu cmd_muapi:get_name -u 52add3cf-9040-42ce-b263-8233039931d5</span></h6></td>
768
+ </tr>
769
+ <tr>
770
+ <td><em>list</em></td>
771
+ <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>
772
+ </tr>
773
+ <tr>
774
+ <td><em>list_by_status</em></td>
775
+ <td>Get a list of Test Runs by status: <strong>list_by_status -s</strong><em> status</em>
776
+ <h6 class="code">mu cmd_muapi:list_by_status -s finished</h6></td>
777
+ </tr>
778
+ <tr>
779
+ <td><em>list_type</em></td>
780
+ <td>Get a list of all template types: <strong>list_types</strong><em></em>
781
+ <h6 class="code">mu cmd_muapi:list_types</h6></td>
782
+ </tr>
783
+ <tr>
784
+ <td><em>pause</em></td>
785
+ <td>Pause a Test Run: <strong>pause -u</strong> <em>uuid</em>
786
+ <h6 class="code">mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
787
+ </tr>
788
+ <tr>
789
+ <td><em>resume</em></td>
790
+ <td>Resume a Test Run: <strong>resume -u</strong> <em>uuid</em>
791
+ <h6 class="code">mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
792
+ </tr>
793
+ <tr>
794
+ <td><em>run</em></td>
795
+ <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>]
796
+ <h6 class="code">mu cmd_muapi:run -u 52add3cf-9040-42ce-b263-8233039931d5 -b true</h6></td>
797
+ </tr>
798
+ <tr>
799
+ <td><em>status</em></td>
800
+ <td>Get the status of a Test Run: <strong>status -u</strong> <em>uuid</em>
801
+ <h6 class="code">mu cmd_muapi:status -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
802
+ </tr>
803
+ <tr>
804
+ <td><em>stop</em></td>
805
+ <td>Stop a Test Run: <strong>stop -u</strong> <em>uuid</em>
806
+ <h6 class="code">mu cmd_muapi:stop -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
807
+ </tr>
808
+ </table>
809
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
810
+ <tr>
811
+ <th colspan="2">Options (short &amp; long form)</th>
812
+ <th width="60%">Description</th>
813
+ </tr>
814
+ <tr>
815
+ <td width="4%">-b</td>
816
+ <td width="36%"><strong>--boolean</strong> <em>value</em></td>
817
+ <td>Specify a boolean value (<span class="code">true</span> or <span class="code">false</span>). </td>
818
+ </tr>
819
+ <tr>
820
+ <td>-c</td>
821
+ <td><strong>--command</strong><em> command</em></td>
822
+ <td>Specify the command to run (run, get, status, etc.)</td>
823
+ </tr>
824
+ <tr>
825
+ <td>-m</td>
826
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
827
+ <td>Specify the user, password, and mgmt IP of the Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
828
+ </tr>
829
+ <tr>
830
+ <td>-n</td>
831
+ <td><strong>--name</strong> <em>name</em></td>
832
+ <td>Specify a Test Run or template name.</td>
833
+ </tr>
834
+ <tr>
835
+ <td>-o</td>
836
+ <td><strong>--output</strong> <em>filename</em></td>
837
+ <td>Specify the filename to which you want to output logs.</td>
838
+ </tr>
839
+ <tr>
840
+ <td>-p</td>
841
+ <td><strong>--port</strong> <em>port-number</em></td>
842
+ <td>Specify the port number.</td>
843
+ </tr>
844
+ <tr>
845
+ <td>-s</td>
846
+ <td><strong>--status</strong> <em>status</em></td>
847
+ <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>
848
+ </tr>
849
+ <tr>
850
+ <td>-t</td>
851
+ <td><strong>--type</strong><em> template-type</em></td>
852
+ <td>Specify the type of template.</td>
853
+ </tr>
854
+ <tr>
855
+ <td>-u</td>
856
+ <td><strong>--uuid</strong><em> uuid/job-id</em></td>
857
+ <td>Specify the UUID of the template to run. For archive, backup, and capture commands, this option takes a job-id value.</td>
858
+ </tr>
859
+ <tr>
860
+ <td>-v</td>
861
+ <td><strong>--verbose</strong></td>
862
+ <td>Set
863
+ the Logger::DEBUG level.</td>
864
+ </tr>
865
+ </table>
866
+ <p><a href="#top">back to top &uarr;</a></p>
867
+ <h2><a name="cmd_netconfig" id="cmd_runscale6"></a>cmd_netconfig</h2>
868
+ <p>Use these commands to access the legacy REST API for configuring Mu interfaces, network hosts, and routes.</p>
869
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
870
+ <tr>
871
+ <th>Command</th>
872
+ <th>Description &amp; Examples</th>
873
+ </tr>
874
+ <tr>
875
+ <td><em>help</em></td>
876
+ <td>Gets help for all cmd_netconfig commands: <strong>help</strong>
877
+ <h6 class="code">mu cmd_netconfig:help</h6></td>
878
+ </tr>
879
+ <tr>
880
+ <td><em>clear_hosts</em></td>
881
+ <td><p>Remove all network hosts configured in the Mu system: <strong>clear_hosts</strong></p>
882
+ <h6><span class="code">mu cmd_netconfig:clear_hosts</span></h6></td>
883
+ </tr>
884
+ <tr>
885
+ <td><em>clear_interfaces</em></td>
886
+ <td><p>Clear settings for specified Mu interfaces: <strong>clear_interfaces -i</strong> <em>interfaces</em></p>
887
+ <h6><span class="code">mu cmd_netconfig:clear_interfaces -i b1,b2</span></h6></td>
888
+ </tr>
889
+ <tr>
890
+ <td><em>clear_routes</em></td>
891
+ <td><p>Remove all user-configured routes in the Mu system: <strong>clear_routes</strong></p>
892
+ <h6><span class="code">mu cmd_netconfig:clear_routes</span></h6></td>
893
+ </tr>
894
+ <tr>
895
+ <td><em>clear_vlans</em></td>
896
+ <td><p>Remove all vlans for all Mu interfaces: <strong>clear_vlans</strong></p>
897
+ <h6><span class="code">mu cmd_netconfig:clear_vlans</span></h6></td>
898
+ </tr>
899
+ <tr>
900
+ <td><em>create</em></td>
901
+ <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>
902
+ <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>
903
+ </tr>
904
+ <tr>
905
+ <td><em>delete</em></td>
906
+ <td><p>Delete a network object such as host or route: <strong>delete </strong><strong>-e </strong><em>value</em> </p>
907
+ <h6><span class="code">mu cmd_netconfig:delete -e Web-Server</span></h6></td>
908
+ </tr>
909
+ <tr>
910
+ <td><em>get</em></td>
911
+ <td><p>Get details for a network object: <strong>get </strong><strong>-e </strong><em>value</em></p>
912
+ <h6><span class="code">mu cmd_netconfig:get -e a1</span></h6></td>
913
+ </tr>
914
+ <tr>
915
+ <td><em>modify</em></td>
916
+ <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>
917
+ <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>
918
+ </tr>
919
+ <tr>
920
+ <td><em>resolve_hosts</em></td>
921
+ <td><p>Get IP address for specified network host: <strong>resolve_hosts </strong><em>host</em></p>
922
+ <h6><span class="code">mu cmd_netconfig:resolve_hosts -n Web-Server</span></h6></td>
923
+ </tr>
924
+ <tr>
925
+ <td><em>restore</em></td>
926
+ <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>
927
+ <h6><span class="code">mu cmd_netconfig:restore -f my_muhosts/web-server.json true</span></h6></td>
928
+ </tr>
929
+ <tr>
930
+ <td><em>save</em></td>
931
+ <td><p>Save changes to the Mu system: <strong>save</strong></p>
932
+ <h6><span class="code">mu cmd_netconfig:save</span></h6></td>
933
+ </tr>
934
+ </table>
935
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
936
+ <tr>
937
+ <th colspan="2">Options (short &amp; long form)</th>
938
+ <th width="60%">Description</th>
939
+ </tr>
940
+ <tr>
941
+ <td width="4%">-b</td>
942
+ <td width="36%"><strong>--boolean</strong> <em>value</em></td>
943
+ <td>Specify a boolean value (true or false). </td>
944
+ </tr>
945
+ <tr>
946
+ <td>-e</td>
947
+ <td><strong>--element</strong><em> value</em></td>
948
+ <td>Specify a value for the associated command. Example: <span class="code">interfaces</span> or <span class="code">interfaces/a1</span></td>
949
+ </tr>
950
+ <tr>
951
+ <td>-f</td>
952
+ <td><strong>--filepath</strong><em> filepath</em></td>
953
+ <td>Specify the path to a file. </td>
954
+ </tr>
955
+ <tr>
956
+ <td>-h</td>
957
+ <td><strong>--help</strong></td>
958
+ <td>Get help on command line options.</td>
959
+ </tr>
960
+ <tr>
961
+ <td>-i</td>
962
+ <td><strong>--interfaces</strong> <em>interface-or-host</em></td>
963
+ <td>Specify Mu interfaces or network hosts as a comma-separated list. Example: <span class="code">b1, web-server</span>. </td>
964
+ </tr>
965
+ <tr>
966
+ <td>-j</td>
967
+ <td><strong>--json</strong> <em>object</em></td>
968
+ <td>Specify a json object as a text string.</td>
969
+ </tr>
970
+ <tr>
971
+ <td>-m</td>
972
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
973
+ <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
974
+ </tr>
975
+ <tr>
976
+ <td>-o</td>
977
+ <td><strong>--output</strong> <em>filename</em></td>
978
+ <td>Specify the filename to which you want to output logs.</td>
979
+ </tr>
980
+ <tr>
981
+ <td>-v</td>
982
+ <td><strong>--verbose</strong></td>
983
+ <td>Set
984
+ the Logger::DEBUG level.</td>
985
+ </tr>
986
+ </table>
987
+ <p><a href="#top">back to top &uarr;</a></p>
988
+ <h2><a name="cmd_ddt" id="cmd_runscale7"></a>cmd_ddt</h2>
989
+ <p>Use these commands to access the legacy REST API for Test Sets (Studio Verify).</p>
990
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
991
+ <tr>
992
+ <th>Command</th>
993
+ <th>Description &amp; Examples</th>
994
+ </tr>
995
+ <tr>
996
+ <td><em>display_results</em></td>
997
+ <td>Displays results for the current Test Set:
998
+ <strong>display_results</strong> <h6 class="code">mu cmd_ddt:display_results</h6></td>
999
+ </tr>
1000
+ <tr>
1001
+ <td><em>new_session</em></td>
1002
+ <td>Create a new session: <strong>new_session</strong>
1003
+ <h6 class="code">mu cmd_ddt:new_session</h6></td>
1004
+ </tr>
1005
+ <tr>
1006
+ <td><em>load_scenario</em></td>
1007
+ <td>Load the specified Scenario template:
1008
+ <strong>load_scenario -u </strong><em>uuid</em> <h6 class="code">mu cmd_ddt:load_scenario -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
1009
+ </tr>
1010
+ <tr>
1011
+ <td><em>get_hosts</em></td>
1012
+ <td>Get a list of hosts in the Test Bed:
1013
+ <strong>get_hosts</strong> <h6 class="code">mu cmd_ddt:get_hosts</h6></td>
1014
+ </tr>
1015
+ <tr>
1016
+ <td><em>set_hosts</em></td>
1017
+ <td>Configure the hosts in the Test Bed: <strong>set_hosts</strong>
1018
+ <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>
1019
+ </tr>
1020
+ <tr>
1021
+ <td><em>get_channels</em></td>
1022
+ <td>Get a list of channels in the Test Bed: <strong>get_channels</strong>
1023
+ <h6 class="code">mu cmd_ddt:get_channels</h6></td>
1024
+ </tr>
1025
+ <tr>
1026
+ <td><em>set_channels</em></td>
1027
+ <td>Configure the channels in the Test Bed: <strong>set_channels</strong> <strong>-r</strong> <em>role</em> <strong>-n</strong> <em>name</em>
1028
+ <h6 class="code">mu cmd_ddt:set_channels -r SSH_Channel -n Web-Server</h6></td>
1029
+ </tr>
1030
+ <tr>
1031
+ <td><em>get_options</em></td>
1032
+ <td>Get a list of options in the Test Set: <strong>get_options</strong>
1033
+ <h6 class="code">mu cmd_ddt:get_options</h6></td>
1034
+ </tr>
1035
+ <tr>
1036
+ <td><em>set_options</em></td>
1037
+ <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>
1038
+ <h6 class="code">mu cmd_ddt:set_options -n username -p jsmith</h6></td>
1039
+ </tr>
1040
+ <tr>
1041
+ <td><em>get_sessions</em></td>
1042
+ <td>Get a list of all sessions: <strong>get_sessions</strong>
1043
+ <h6 class="code">mu cmd_ddt:get_sessions</h6></td>
1044
+ </tr>
1045
+ <tr>
1046
+ <td><em>setup_test</em></td>
1047
+ <td>Setup the Test Bed, reserving the Mu interfaces:
1048
+ <strong>setup_test</strong> <h6 class="code">mu cmd_ddt:setup_test</h6></td>
1049
+ </tr>
1050
+ <tr>
1051
+ <td><em>run</em></td>
1052
+ <td>Run a Test Set: <strong>run</strong>
1053
+ <h6 class="code">mu cmd_ddt:run</h6></td>
1054
+ </tr>
1055
+ <tr>
1056
+ <td><em>run_testset</em></td>
1057
+ <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>
1058
+ </tr>
1059
+ <tr>
1060
+ <td><em>get_testset_results</em></td>
1061
+ <td>Get results for the current Test Set: <strong>get_testset_results</strong>
1062
+ <h6 class="code">mu cmd_ddt:get_testset_results</h6></td>
1063
+ </tr>
1064
+ <tr>
1065
+ <td><em>get_testset_status</em></td>
1066
+ <td>Get status for the current Test Set: <strong>get_testset_status</strong>
1067
+ <h6 class="code">mu cmd_ddt:get_testset_status</h6></td>
1068
+ </tr>
1069
+ <tr>
1070
+ <td><em>teardown_test</em></td>
1071
+ <td>Unsets the Test Bed selections, releasing the Mu interfaces: <strong>teardown_test</strong>
1072
+ <h6 class="code">mu cmd_ddt:teardown_test</h6></td>
1073
+ </tr>
1074
+ <tr>
1075
+ <td><em>close_session</em></td>
1076
+ <td>Closes the current session: <strong>close_session</strong>
1077
+ <h6 class="code">mu cmd_ddt:close_session</h6></td>
1078
+ </tr>
1079
+ <tr>
1080
+ <td><em>close_all_sessions</em></td>
1081
+ <td>Closes all existing sessions: <strong>close_all_sessions</strong>
1082
+ <h6 class="code">mu cmd_ddt:close_all_sessions</h6></td>
1083
+ </tr>
1084
+ tr>
1085
+ <td><em>csv_export</em></td>
1086
+ <td>Exports a Test Set from the Mu system to a. csv file: <strong>csv_export</strong>
1087
+ <strong>-u</strong> <em>uuid</em> <h6 class="code">mu cmd_ddt:csv_export -u 52add3cf-9040-42ce-b263-8233039931d5</h6></td>
1088
+ </tr>
1089
+ tr>
1090
+ <td><em>csv_import</em></td>
1091
+ <td>Imports a .csv file to create a Test Set on the Mu system: <strong>csv_import</strong>
1092
+ <strong>-t</strong><em> filename.csv </em><h6 class="code">mu cmd_ddt:csv_import -t my-testset.csv</h6></td>
1093
+ </tr>
1094
+ </table>
1095
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1096
+ <tr>
1097
+ <th colspan="2">Options (short &amp; long form)</th>
1098
+ <th width="60%">Description</th>
1099
+ </tr>
1100
+ <tr>
1101
+ <td width="4%">-f</td>
1102
+ <td width="36%"><strong>--filename</strong><em> filename</em></td>
1103
+ <td>Specify the template name for saving an imported Test Set.</td>
1104
+ </tr>
1105
+ <tr>
1106
+ <td>-h</td>
1107
+ <td><strong>--help</strong></td>
1108
+ <td>Get help on command line options.</td>
1109
+ </tr>
1110
+ <tr>
1111
+ <td>-m</td>
1112
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1113
+ <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1114
+ </tr>
1115
+ <tr>
1116
+ <td>-n</td>
1117
+ <td><strong>--names</strong> <em>name-array</em></td>
1118
+ <td>Specify host names or channel names in a comma-separated array. Example: <span class="code">a1,Web-Serve</span>r</td>
1119
+ </tr>
1120
+ <tr>
1121
+ <td>-o</td>
1122
+ <td><strong>--output</strong> <em>filename</em></td>
1123
+ <td>Specify the filename to which you want to output logs.</td>
1124
+ </tr>
1125
+ <tr>
1126
+ <td>-p</td>
1127
+ <td><strong>--option_values</strong> <em>value-array</em></td>
1128
+ <td>Specify values for Test Set options in a comma-separated array. Example: <span class="code">bob,jane,mary,tom</span></td>
1129
+ </tr>
1130
+ <tr>
1131
+ <td>-r</td>
1132
+ <td><strong>--roles</strong> <em>role-array</em></td>
1133
+ <td>Specify host roles in a comma-separated array. Example: <span class="code">HTTP_Client,HTTP_Server</span></td>
1134
+ </tr>
1135
+ <tr>
1136
+ <td>-t</td>
1137
+ <td><strong>--testset</strong> <em>filename.csv</em></td>
1138
+ <td>Specify the name of the .csv file to import. </td>
1139
+ </tr>
1140
+ <tr>
1141
+ <td>-u</td>
1142
+ <td><strong>--uuid</strong> <em>uuid</em></td>
1143
+ <td>Specify the UUID of the Scenario or Test Set.</td>
1144
+ </tr>
1145
+ <tr>
1146
+ <td>-v</td>
1147
+ <td><strong>--verbose</strong></td>
1148
+ <td>Set
1149
+ the Logger::DEBUG level.</td>
1150
+ </tr>
1151
+ <tr>
1152
+ <td>-y</td>
1153
+ <td><strong>--type</strong> <em>type</em></td>
1154
+ <td>Specify network layer (v4, v6, l2) for all hosts in the Test Bed. Example: <span class="code">v4</span></td>
1155
+ </tr>
1156
+ </table>
1157
+ <p><a href="#top">back to top &uarr;</a></p>
1158
+ <h2><a name="cmd_scale" id="cmd_runscale8"></a>cmd_scale</h2>
1159
+ <p>Use these commands to access the legacy REST API for Scale test (Studio Scale). </p>
1160
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1161
+ <tr>
1162
+ <th>Command</th>
1163
+ <th>Description &amp; Examples</th>
1164
+ </tr>
1165
+ <tr>
1166
+ <td><em>about</em></td>
1167
+ <td>Lists information for the Scale Player and all active and inactive Scale Engines: <strong>about</strong>
1168
+ <h6 class="code">mu cmd_scale:about</h6></td>
1169
+ </tr>
1170
+ <tr>
1171
+ <td><em>configure</em></td>
1172
+ <td>Configure any element of the scale json object : <strong>configure -p </strong><em>parameter</em><strong> -pv </strong><em>value
1173
+ </em>
1174
+ <h6 class="code">mu cmd_scale:configure -p json_element -pv json_element_value</h6></td>
1175
+ </tr>
1176
+ <tr>
1177
+ <td><em>data</em></td>
1178
+ <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>
1179
+ </tr>
1180
+ <tr>
1181
+ <td><em>delete_scale_engine </em></td>
1182
+ <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>
1183
+ </tr>
1184
+ <tr>
1185
+ <td><em>help</em></td>
1186
+ <td>Gets help for all cmd_scale commands: <strong>help</strong>
1187
+ <h6 class="code">mu cmd_scale:help</h6></td>
1188
+ </tr>
1189
+ <tr>
1190
+ <td><em>list</em></td>
1191
+ <td>Returns the current Scale Player's UUID: <strong>list</strong>
1192
+ <h6 class="code">mu cmd_scale:list</h6></td>
1193
+ </tr>
1194
+ <tr>
1195
+ <td><em>pattern</em></td>
1196
+ <td>Gets the pattern for the Scale test: <strong>pattern </strong><strong>-z</strong> <em>zoom</em> <strong>-ps</strong> <em>position</em>
1197
+ <h6 class="code">mu cmd_scale:pattern -z 1 -ps 0</h6></td>
1198
+ </tr>
1199
+ <tr>
1200
+ <td><em>pcap</em></td>
1201
+ <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>
1202
+ </tr>
1203
+ <tr>
1204
+ <td><em>release</em></td>
1205
+ <td>Release the Scale Player:
1206
+ <strong>release</strong> <h6 class="code">mu cmd_scale:release</h6></td>
1207
+ </tr>
1208
+ <tr>
1209
+ <td><em>release_scale_engine </em></td>
1210
+ <td>Releases the specified Scale Engine:<strong>release_scale_engine -b</strong> <em>bot_id</em>
1211
+ <h6 class="code">mu cmd_scale:release_scale_engine -b bots_10.10.6.200:1</h6></td>
1212
+ </tr>
1213
+ <tr>
1214
+ <td><em>reserve_scale_engine </em></td>
1215
+ <td>Reserves the specified Scale Engine:<strong>reserve_scale_engine -b</strong> <em>bot_id</em>
1216
+ <h6 class="code">mu cmd_scale:reserve_scale_engine -b bots_10.10.6.200:1</h6></td>
1217
+ </tr>
1218
+ <tr>
1219
+ <td><em>session</em></td>
1220
+ <td>Create a new Scale Player session:
1221
+ <strong>session</strong> <h6 class="code">mu cmd_scale:session</h6></td>
1222
+ </tr>
1223
+ <tr>
1224
+ <td><em>start</em></td>
1225
+ <td>Start the Scale test: <strong>start</strong>
1226
+ <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>
1227
+ </tr>
1228
+ <tr>
1229
+ <td><em>status</em></td>
1230
+ <td>Gets information about the currently running Scale test: <strong>status</strong>
1231
+ <h6 class="code">mu cmd_scale:status</h6></td>
1232
+ </tr>
1233
+ <tr>
1234
+ <td><em>statuses</em></td>
1235
+ <td>Gets the status of all active and inactive Scale engines: <strong>statuses</strong>
1236
+ <h6 class="code">mu cmd_scale:statuses</h6></td>
1237
+ </tr>
1238
+ <tr>
1239
+ <td><em>stop</em></td>
1240
+ <td>Stops the Scale test: <strong>stop</strong>
1241
+ <h6 class="code">mu cmd_scale:stop</h6></td>
1242
+ </tr>
1243
+ <tr>
1244
+ <td><em>update</em></td>
1245
+ <td>Update the pattern dynamically (while the Scale test is running):
1246
+ <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>
1247
+ </tr>
1248
+ <tr>
1249
+ <td><em>verify</em></td>
1250
+ <td>Verifies a Scale test: <strong>verify</strong>
1251
+ <h6 class="code">mu cmd_scale:verify</h6></td>
1252
+ </tr>
1253
+ </table>
1254
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1255
+ <tr>
1256
+ <th colspan="2">Options (short &amp; long form)</th>
1257
+ <th width="57%">Description</th>
1258
+ </tr>
1259
+ <tr>
1260
+ <td>-b</td>
1261
+ <td><strong>--bot-id</strong> <em>scale-engine-id</em></td>
1262
+ <td>Specify a Scale Engine using its bot-id value.</td>
1263
+ </tr>
1264
+ <tr>
1265
+ <td>-c</td>
1266
+ <td><strong>--config-file</strong> <em>json-filename</em></td>
1267
+ <td>Specify a .json file that contains the configuration data.</td>
1268
+ </tr>
1269
+ <tr>
1270
+ <td width="5%">-f</td>
1271
+ <td width="38%"><strong>--filename</strong><em> pcap-filename</em></td>
1272
+ <td>Specify a name for the .pcap file.</td>
1273
+ </tr>
1274
+ <tr>
1275
+ <td>-h</td>
1276
+ <td><strong>--help</strong></td>
1277
+ <td>Get help on command line options.</td>
1278
+ </tr>
1279
+ <tr>
1280
+ <td>-m</td>
1281
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1282
+ <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1283
+ </tr>
1284
+ <tr>
1285
+ <td>-o</td>
1286
+ <td><strong>--output</strong> <em>filename</em></td>
1287
+ <td>Specify the filename to which you want to output logs.</td>
1288
+ </tr>
1289
+ <tr>
1290
+ <td>-p</td>
1291
+ <td><strong>--params</strong><em> parameters</em></td>
1292
+ <td>Specify parameters for initial configuration or for update. Supports <span class="code">delay</span> and <span class="code">volume</span> parameters.</td>
1293
+ </tr>
1294
+ <tr>
1295
+ <td>-ps</td>
1296
+ <td><strong>--view_position</strong><em> value</em></td>
1297
+ <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>
1298
+ </tr>
1299
+ <tr>
1300
+ <td>-pv</td>
1301
+ <td><strong>--param_value</strong> <em>value</em></td>
1302
+ <td>Specify a value for a parameter.</td>
1303
+ </tr>
1304
+ <tr>
1305
+ <td>-v</td>
1306
+ <td><strong>--verbose</strong></td>
1307
+ <td>Set
1308
+ the Logger::DEBUG level.</td>
1309
+ </tr>
1310
+ <tr>
1311
+ <td>-w</td>
1312
+ <td><strong>--view</strong> <em>view</em></td>
1313
+ <td>Specify the view (<span class="code">RUNTIME</span> or <span class="code">CALLGRAPH</span>) for which to return data.</td>
1314
+ </tr>
1315
+ <tr>
1316
+ <td>-z</td>
1317
+ <td><strong>--zoom</strong> <em>zoom-level</em></td>
1318
+ <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>
1319
+ </tr>
1320
+ </table>
1321
+ <p><a href="#top">back to top &uarr;</a></p>
1322
+ <h2><a name="cmd_homepage" id="cmd_runscale9"></a>cmd_homepage</h2>
1323
+ <p>Use these commands to access the Mu UI homepage. </p>
1324
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1325
+ <tr>
1326
+ <th>Command</th>
1327
+ <th>Description &amp; Examples</th>
1328
+ </tr>
1329
+ <tr>
1330
+ <td><em>all</em></td>
1331
+ <td>Gets the complete set of information displayed on the Mu home page: <strong>all</strong>
1332
+ <h6 class="code">mu cmd_homepage:all</h6></td>
1333
+ </tr>
1334
+ <tr>
1335
+ <td><em>help</em></td>
1336
+ <td>Gets help for all cmd_homepage commands:
1337
+ <strong>help</strong> <h6 class="code">mu cmd_homepage:help</h6></td>
1338
+ </tr>
1339
+ <tr>
1340
+ <td><em>latest_test</em></td>
1341
+ <td>Gets an array of the latest test results:
1342
+ <strong>latest_test</strong> <h6 class="code">mu cmd_homepage:latest_test</h6></td>
1343
+ </tr>
1344
+ <tr>
1345
+ <td><em>queue_test</em></td>
1346
+ <td>Gets an array of tests in the Test Queue: <strong>queue_test</strong>
1347
+ <h6 class="code">mu cmd_homepage:queue_test</h6></td>
1348
+ </tr>
1349
+ <tr>
1350
+ <td><em>recent</em></td>
1351
+ <td>Gets the "What's New" section from the Mu homepage:
1352
+ <strong>recent</strong> <h6 class="code">mu cmd_homepage:recent</h6></td>
1353
+ </tr>
1354
+ <tr>
1355
+ <td><em>status</em></td>
1356
+ <td>Gets system status for licenses, backup, and updates: <strong>status</strong>
1357
+ <h6 class="code">mu cmd_homepage:status</h6></td>
1358
+ </tr>
1359
+ </table>
1360
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1361
+ <tr>
1362
+ <th colspan="2">Options (short &amp; long form)</th>
1363
+ <th width="57%">Description</th>
1364
+ </tr>
1365
+ <tr>
1366
+ <td>-h</td>
1367
+ <td><strong>--help</strong></td>
1368
+ <td>Get help on command line options.</td>
1369
+ </tr>
1370
+ <tr>
1371
+ <td>-m</td>
1372
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1373
+ <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1374
+ </tr>
1375
+ <tr>
1376
+ <td>-o</td>
1377
+ <td><strong>--output</strong> <em>filename</em></td>
1378
+ <td>Specify the filename to which you want to output logs.</td>
1379
+ </tr>
1380
+ <tr>
1381
+ <td>-v</td>
1382
+ <td><strong>--verbose</strong></td>
1383
+ <td>Set
1384
+ the Logger::DEBUG level.</td>
1385
+ </tr>
1386
+ </table>
1387
+ <p><a href="#top">back to top &uarr;</a></p>
1388
+ <h2><a name="cmd_system" id="cmd_runscale10"></a>cmd_system</h2>
1389
+ <p>Use these commands to restart system services or to get status details for the Mu system. </p>
1390
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1391
+ <tr>
1392
+ <th>Command</th>
1393
+ <th>Description &amp; Examples</th>
1394
+ </tr>
1395
+ <tr>
1396
+ <td><em>restart</em></td>
1397
+ <td>Restart the Mu system services (this does not reboot the appliance):
1398
+ <strong>restart</strong> <h6 class="code">mu cmd_system:restart</h6></td>
1399
+ </tr>
1400
+ <tr>
1401
+ <td><em>status</em></td>
1402
+ <td>Gets the complete System status page: <strong>status</strong><em></em>
1403
+ <h6 class="code">mu cmd_system:status</h6></td>
1404
+ </tr>
1405
+ <tr>
1406
+ <td><em>status2</em></td>
1407
+ <td>Gets additional system status information, imncluding hard drive, model and serial data: <strong>status</strong><em></em>2 <h6 class="code">mu cmd_system:status2</h6></td>
1408
+ </tr>
1409
+ </table>
1410
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1411
+ <tr>
1412
+ <th colspan="2">Options (short &amp; long form)</th>
1413
+ <th width="57%">Description</th>
1414
+ </tr>
1415
+ <tr>
1416
+ <td width="5%">-h</td>
1417
+ <td width="38%"><strong>--help</strong></td>
1418
+ <td>Get help on command line options.</td>
1419
+ </tr>
1420
+ <tr>
1421
+ <td>-m</td>
1422
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1423
+ <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1424
+ </tr>
1425
+ <tr>
1426
+ <td>-o</td>
1427
+ <td><strong>--output</strong> <em>filename</em></td>
1428
+ <td>Specify the filename to which you want to output logs.</td>
1429
+ </tr>
1430
+ <tr>
1431
+ <td>-v</td>
1432
+ <td><strong>--verbose</strong></td>
1433
+ <td>Set
1434
+ the Logger::DEBUG level.</td>
1435
+ </tr>
1436
+ </table>
1437
+ <p><a href="#top">back to top &uarr;</a></p>
1438
+ <h2><a name="cmd_cli" id="cmd_runscale11"></a>cmd_cli</h2>
1439
+ <p>Use these commands to access the Mu CLI. </p>
1440
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1441
+ <tr>
1442
+ <th>Command</th>
1443
+ <th>Description &amp; Examples</th>
1444
+ </tr>
1445
+ <tr>
1446
+ <td><em>cli_help</em></td>
1447
+ <td>Get help for all cmd_cli commands: <strong>cli_help</strong>
1448
+ <h6 class="code">mu cmd_cli:cli_help</h6></td>
1449
+ </tr>
1450
+ <tr>
1451
+ <td><em>cli_history</em></td>
1452
+ <td>Display the command line history for the current session: <strong>cli_help</strong>
1453
+ <h6 class="code">mu cmd_cli:history</h6></td>
1454
+ </tr>
1455
+ <tr>
1456
+ <td><em>ping</em></td>
1457
+ <td>Ping the specified IP address from the Mu system: <strong>ping -a </strong><em>ip-address
1458
+ </em>
1459
+ <h6 class="code">mu cmd_cli:ping -a 10.10.10.1</h6></td>
1460
+ </tr>
1461
+ <tr>
1462
+ <td><em>question</em></td>
1463
+ <td>Show the available CLI commands:
1464
+ <strong>question</strong> <h6 class="code">mu cmd_cli:question</h6></td>
1465
+ </tr>
1466
+ <tr>
1467
+ <td><em>traceroute</em></td>
1468
+ <td>Get the network route to a specified IP address from the Mu system: <strong>traceroute -a </strong><em>ip-address </em>
1469
+ <h6 class="code">mu cmd_cli:traceroute -a 10.10.10.1</h6></td>
1470
+ </tr>
1471
+ </table>
1472
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1473
+ <tr>
1474
+ <th colspan="2">Options (short &amp; long form)</th>
1475
+ <th width="57%">Description</th>
1476
+ </tr>
1477
+ <tr>
1478
+ <td width="5%">-h</td>
1479
+ <td width="38%"><strong>--help</strong></td>
1480
+ <td>Get help on command line options.</td>
1481
+ </tr>
1482
+ <tr>
1483
+ <td>-m</td>
1484
+ <td><strong>--mu_string</strong> <em>user</em>:<em>password</em>@<em>mu-ip</em></td>
1485
+ <td>Specify a user, password, and mgmt IP of a Mu system. Example: <span class="code">admin:admin@10.9.8.7</span></td>
1486
+ </tr>
1487
+ <tr>
1488
+ <td>-o</td>
1489
+ <td><strong>--output</strong> <em>filename</em></td>
1490
+ <td>Specify the filename to which you want to output logs.</td>
1491
+ </tr>
1492
+ <tr>
1493
+ <td>-v</td>
1494
+ <td><strong>--verbose</strong></td>
1495
+ <td>Set
1496
+ the Logger::DEBUG level.</td>
1497
+ </tr>
1498
+ </table>
1499
+ <p><a href="#top">back to top &uarr;</a></p>
1500
+ <p>&nbsp;</p>
1501
+ <h3><a name="library-classes" id="features2"></a>Library Classes</h3>
1502
+ <p>API library classes that can be &lsquo;required&rsquo; and used within Ruby scripts
1503
+ like most rubygems.</p>
1504
+
1505
+ <table border="1" cellpadding="1" cellspacing="1" class=wide>
1506
+ <tr>
1507
+ <th>Command</th>
1508
+ <th>Description &amp; Examples</th>
1509
+ </tr>
1510
+ <tr>
1511
+ <td valign=top><p><a name=muapi>muapi</a></p></td>
1512
+ <td valign=top><p>require 'rubygems'</p>
1513
+ <p>require 'mu'</p>
1514
+ <p>api = Mu::Muapi.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1515
+ <p>$log.level = Logger::INFO</p>
1516
+ <p>Example: <span class="code">api.list_by_status(&quot;running&quot;)</span></p></td>
1517
+ </tr>
1518
+ <tr>
1519
+ <td valign=top><p><a name=ddt>ddt</a></p></td>
1520
+ <td valign=top><p>require 'rubygems'</p>
1521
+ <p>require 'mu'</p>
1522
+ <p>api = Mu::Ddt.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1523
+ <p>$log.level = Logger::INFO</p>
1524
+ <p>Example: <span class="code">api.new_session</span></p></td>
1525
+ </tr>
1526
+ <tr>
1527
+ <td valign=top><p><a name=scale>scale</a></p></td>
1528
+ <td valign=top><p>require 'rubygems'</p>
1529
+ <p>require 'mu'</p>
1530
+ <p>api = Mu::Scale.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1531
+ <p>$log.level = Logger::INFO</p>
1532
+ <p>Examples: </p>
1533
+ <h6 class="code">api.configure -p musl -pv &lt;scenario.msl&gt;</h6>
1534
+ <h6 class="code">api.configure -p csv -pv &lt;testset.csv&gt;</h6>
1535
+ <h6 class="code">api.configure -p pattern -pv &lt;pattern.json&gt;</h6>
1536
+ <h6 class="code">api.start</h6>
1537
+ <h6 class="code">api.status</h6>
1538
+ <h6 class="code">api.stop</h6>
1539
+ <h6 class="code">api.release</h6></td>
1540
+ </tr>
1541
+ <tr>
1542
+ <td valign=top><a name=netconfig>netconfig</a></td>
1543
+ <td valign=top><p>require 'rubygems'</p>
1544
+ <p>require 'mu'</p>
1545
+ <p>api = Mu::Netconfig.new(&ldquo;10.10.2.2&rdquo;, &ldquo;admin&rdquo;, &ldquo;admin&rdquo;)</p>
1546
+ <p>$log.level = Logger::INFO</p>
1547
+ <p>Example: <span class="code">api.get(&quot;hosts&quot;)</span></p></td>
1548
+ </tr>
1549
+ </table>
1550
+ <p>&nbsp;</p>
1551
+ <p><a href="#top">back to top &uarr;</a></p>
1552
+ <hr />
1553
+ <h2>Mu
1554
+ Dynamics Information</h2>
1555
+ <p>Mu
1556
+ Dynamics Customer Care is available 9am to 5pm PST, Monday to Friday at the
1557
+ toll-free support line at 1-866-276-4640; international customers can
1558
+ also use 1-408-329-6330. For online communication, visit the Mu
1559
+ Dynamics Customer Care Center at <a
1560
+ title="https://forms.netsuite.com/app/crm/marketing/campaignlistener.nl?__lstr=__cl&amp;c=590487&amp;__r=-2147483648&amp;__h=895f7f7a297d1138ee45&amp;url=https://owa.musecurity.com/exchweb/bin/redir.asp?URL=https://forms.netsuite.com/app/crm/marketing/campaignlistener.nl?__lstr=__cl%26c=590487%26__r=-2147483648%26__h=895f7f7a297d1138ee45%26url=http://www.mudynamics.com/support/overview.html"
1561
+ href="https://forms.netsuite.com/app/crm/marketing/campaignlistener.nl?__lstr=__cl&amp;c=590487&amp;__r=-2147483648&amp;__h=895f7f7a297d1138ee45&amp;url=https://owa.musecurity.com/exchweb/bin/redir.asp?URL=https://forms.netsuite.com/app/crm/marketing/campaignlistener.nl?__lstr=__cl%26c=590487%26__r=-2147483648%26__h=895f7f7a297d1138ee45%26url=http://www.mudynamics.com/support/overview.html"
1562
+ target="_blank">http://www.mudynamics.com/support/overview.html</a>. </p>
1563
+ <p>In addition to Mu UI Help and the Mu
1564
+ product documentation, you can also get continuous updates on Mu system
1565
+ capabilities using the following resources: </p>
1566
+ <table width="640" border="1" cellpadding="1" cellspacing="1" class="wide">
1567
+ <tr>
1568
+ <th width="16%" scope="row">Corporate</th>
1569
+ <td width="84%"><a href="http://www.mudynamics.com" target="_blank">Home </a>&#8226;<a href="http://www.mudynamics.com/news/inthenews.html" target="_blank"> Press </a><a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://www.mudynamics.com/news/inthenews.html"> </a><a href="http://www.mudynamics.com/news/inthenews.html"> </a><a href="http://www.mudynamics.com/news/events.html" target="_blank">Webinars,
1570
+ Seminars, &amp; Podcasts </a><a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://www.mudynamics.com/news/inthenews.html"> </a><a href="http://www.mudynamics.com/products/demo.html" target="_blank"> Product </a><a href="http://www.mudynamics.com/products/demo.html">Demos</a><a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://www.mudynamics.com/news/inthenews.html"> </a><a href="http://www.mudynamics.com/news/inthenews.html"> </a><a href="http://www.mudynamics.com/news/rss.html" target="_blank"> RSS
1571
+ Feed</a></td>
1572
+ </tr>
1573
+ <tr>
1574
+ <th scope="row">Social</th>
1575
+ <td><a href="http://bit.ly/mu-twitter" target="_blank"> Twitter</a><a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://www.mudynamics.com/news/inthenews.html"> </a><a href="http://bit.ly/mu-on-facebook" target="_blank"> Facebook</a><a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://bit.ly/mu-youtube" target="_blank"> YouTube</a><a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://www.mudynamics.com/news/inthenews.html"> </a><a href="http://community.mudynamics.com/main/authorization/signIn?" target="_blank"> Mu
1576
+ Community</a> <a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://bit.ly/pcapr" target="_blank"> Pcapr</a></td>
1577
+ </tr>
1578
+ <tr>
1579
+ <th scope="row">Blogs</th>
1580
+ <td><a href="http://bit.ly/mu-line-blog" target="_blank"> Mu
1581
+ Line</a><a href="http://www.mudynamics.com"> </a>&#8226;<a href="http://bit.ly/mu-labs-blog" target="_blank"> </a><a href="http://bit.ly/mu-labs-blog" target="_blank">Mu
1582
+ Labs </a>(with<a href="http://labs.mudynamics.com/category/research/rss2" target="_blank"> RSS
1583
+ Feed</a>) </td>
1584
+ </tr>
1585
+ </table>
1586
+ </div>
1587
+ <div id="siteInfo">
1588
+ Copyright
1589
+ 2011 Mu Dynamics Inc., All Rights Reserved.</div>
1590
+ </body>
1591
+ </html>