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/version.rb CHANGED
@@ -1 +1 @@
1
- VERSION='5.7.35'
1
+ VERSION='5.7.36'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mu
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.7.35
4
+ version: 5.7.36
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,11 +9,11 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2012-01-11 00:00:00.000000000Z
12
+ date: 2012-03-08 00:00:00.000000000Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: nokogiri
16
- requirement: &2170473640 !ruby/object:Gem::Requirement
16
+ requirement: &2162286860 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: 1.4.4
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *2170473640
24
+ version_requirements: *2162286860
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: rest-client
27
- requirement: &2170472880 !ruby/object:Gem::Requirement
27
+ requirement: &2162285640 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
32
32
  version: 1.6.1
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *2170472880
35
+ version_requirements: *2162285640
36
36
  - !ruby/object:Gem::Dependency
37
37
  name: mime-types
38
- requirement: &2170472120 !ruby/object:Gem::Requirement
38
+ requirement: &2162284220 !ruby/object:Gem::Requirement
39
39
  none: false
40
40
  requirements:
41
41
  - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
43
43
  version: '1.16'
44
44
  type: :runtime
45
45
  prerelease: false
46
- version_requirements: *2170472120
46
+ version_requirements: *2162284220
47
47
  - !ruby/object:Gem::Dependency
48
48
  name: json
49
- requirement: &2170471740 !ruby/object:Gem::Requirement
49
+ requirement: &2162283140 !ruby/object:Gem::Requirement
50
50
  none: false
51
51
  requirements:
52
52
  - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
54
54
  version: '0'
55
55
  type: :runtime
56
56
  prerelease: false
57
- version_requirements: *2170471740
57
+ version_requirements: *2162283140
58
58
  - !ruby/object:Gem::Dependency
59
59
  name: hexy
60
- requirement: &2170471060 !ruby/object:Gem::Requirement
60
+ requirement: &2162280600 !ruby/object:Gem::Requirement
61
61
  none: false
62
62
  requirements:
63
63
  - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
65
65
  version: 0.1.1
66
66
  type: :runtime
67
67
  prerelease: false
68
- version_requirements: *2170471060
68
+ version_requirements: *2162280600
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: uuid
71
- requirement: &2170470540 !ruby/object:Gem::Requirement
71
+ requirement: &2162262640 !ruby/object:Gem::Requirement
72
72
  none: false
73
73
  requirements:
74
74
  - - ! '>='
@@ -76,9 +76,9 @@ dependencies:
76
76
  version: 2.0.2
77
77
  type: :runtime
78
78
  prerelease: false
79
- version_requirements: *2170470540
80
- description: ! "The Mu gem allows users to include mu libraries within scripts\n that
81
- interact with mu appliance software. The gem also supplies command line interfaces\n
79
+ version_requirements: *2162262640
80
+ description: ! "The Mu gem allows users to include Mu libraries within scripts\n that
81
+ interact with Mu appliance software. The gem also supplies command line interfaces\n
82
82
  \ to many of these same libraries"
83
83
  email:
84
84
  - info@mudynamics.com
@@ -120,7 +120,7 @@ files:
120
120
  - Mu_Gem.html
121
121
  - version.rb
122
122
  - LICENSE.txt
123
- - README.rdoc
123
+ - README.md
124
124
  homepage: http://www.mudynamics.com
125
125
  licenses: []
126
126
  post_install_message:
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
141
141
  version: '0'
142
142
  requirements: []
143
143
  rubyforge_project:
144
- rubygems_version: 1.8.11
144
+ rubygems_version: 1.8.16
145
145
  signing_key:
146
146
  specification_version: 3
147
147
  summary: Mu Dynamics General Purpose Library and Command Line Tool
@@ -1,586 +0,0 @@
1
-
2
- Mu Ruby Gem
3
-
4
- API Commands for the Mu System
5
-
6
- 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.
7
-
8
- Before Using This Gem:
9
-
10
- * Ensure that you have installed the necessary software You must have installed ruby 1.8.6 and the following gems. (type sudo gem install<gem>):
11
- o json_pure. Don't confuse this with the json gem (that won't work).
12
- o nokogiri. See http://nokogiri.org/tutorials/installing_nokogiri.html for help.
13
- o rest-client. Used for HTTP calls.
14
- o mime-types. Required by REST-client.
15
- * Set the Mu environment variables.
16
- o MU_IP. Set the default IP address of the Mu management interface.
17
- o MU_ADMIN_USER. Set the default name of the admin user.
18
- o MU_ADMIN_PASS. Set the default admin user password(do not use the ':' or '@' characters in the password).
19
-
20
- The following table lists each API section and the associated commands:
21
-
22
-
23
- Executables go to section »
24
-
25
- These command-line applications are used for loading and verifying Scenarios, creating and running Test Sets, and configuring and running Scale tests.
26
-
27
-
28
- * cmd_appid
29
- * cmd_runscale
30
- * cmd_runverify
31
- * cmd_runscenario
32
-
33
- Legacy REST API Commands go to section »
34
-
35
- These commands provide access to legacy REST API commands supported by the Mu system.
36
-
37
-
38
- * cmd_ddt
39
- * cmd_scale
40
- * cmd_netconfig
41
- * cmd_muapi
42
- * cmd_homepage
43
- * cmd_system
44
- * cmd_cli
45
-
46
- API Library Classes go to section »
47
-
48
- These API library classes can be ‘required’ and used within Ruby scripts ( like most ruby gems).
49
-
50
-
51
- * ddt
52
- * scale
53
- * netconfig
54
- * muapi
55
-
56
- Executables
57
-
58
- The following command-line applications are used for loading and verifying Scenarios, creating and running Test Sets, and configuring and running Scale tests.
59
-
60
- * cmd_appid
61
- * cmd_runscale
62
- * cmd_runverify
63
- * cmd_runscenario
64
-
65
- cmd_appid
66
-
67
- 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.
68
- Command Description & Examples
69
- help
70
-
71
- Gets help for all cmd_appid commands: help
72
- mu cmd_appid:help
73
- run_file
74
-
75
-
76
- Runs the specified .msl file: run_file -s msl-filename
77
- mu cmd_appid:run_file -s msl_file -i a1,a2 -m admin:admin@10.10.2.2 -p 1-10000:60
78
- run_dir
79
-
80
- Runs all .msl files in the specified directory: run_dir -d msl-directory
81
- mu cmd_appid:run_dir -d msl_file_directory -i a1-10000,a2 -m admin:admin@10.10.2.2 -p 1-100000:360
82
-
83
- running?
84
-
85
- Gets status of the scale player: running?
86
- mu cmd_appid:running?
87
- Options (short & long form) Description
88
- -c --csv csv-filename Specify the filename of the .csv file that contains the test cases to run.
89
- -d --dir directory Specify the directory that contains .msl files to run(required for run_dir).
90
- -h --help Get help on command line options.
91
- -i --interfaces interfaces 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
92
- -m --mu_string user:password@mu-ip Specify the user, password, and mgmt IP of the Mu system. Example: admin:admin@10.9.8.7
93
- -o --output filename Specify the filename to which you want to output logs.
94
- -p --pattern con-start:dur,con-end:dur Specify pattern as concurrency_start:duration,concurrency-end:duration. Duration is in seconds. Example: 1-10000:60,10000-1:30.
95
- -s --scenario msl-filename Specify the .msl filename (required for run_msl)
96
- -t --test Run a verification check only.
97
- -v --verbose Set the Logger::DEBUG level.
98
-
99
- back to top ↑
100
- cmd_runscale
101
-
102
- 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.
103
- Command Commands & Examples
104
- help
105
-
106
- Gets help for all cmd_runscale commands: help
107
- mu cmd_runscale:help
108
- run_file
109
-
110
-
111
- Runs the specified .msl file: run_file -s msl-filename -i interfaces/hosts -p pattern
112
- mu cmd_runscale:run_file -s msl_file -i a1,dell-9 -p 1-10000:30
113
- run_dir
114
-
115
- Runs all .msl files in the specified directory: run_dir -d msl_directory
116
- mu cmd_runscale:run_dir -d msl_file_directory
117
-
118
- running?
119
-
120
- Gets status of the scale player: running?
121
- mu cmd_runscale:running?
122
- Options (short & long form) Description
123
- -c --csv csv-filename Specify the filename of the .csv file that contains the test cases to run.
124
- -d --dir directory Specify the directory that contains .msl files to run(required for run_dir).
125
- -f --default_host default-host Specify the default host. This host is used for all hosts in the scenario which have not been explicitly assigned
126
- -h --help Get help on command line options.
127
- -i --interfaces interfaces 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
128
- -m --mu_string user:password@mu-ip Specify the user, password, and mgmt IP of the Mu system. Example: admin:admin@10.9.8.7
129
- -o --output filename Specify the filename to which you want to output logs.
130
- -p --pattern con-start:dur,con-end:dur Specify pattern as concurrency_start:duration,concurrency-end:duration. Duration is in seconds. Example: 1-10000:60,10000-1:30.
131
- -s --scenario msl-filename Specify the .msl filename (required for run_msl)
132
- -t --test Run a verification check only.
133
- -v --verbose Set the Logger::DEBUG level.
134
-
135
- back to top ↑
136
- cmd_runverify
137
-
138
- 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.
139
- Command Commands & Examples
140
- help
141
-
142
- Gets help for all cmd_runverify commands: help
143
- mu cmd_runverify:help
144
- run
145
-
146
-
147
- Runs the specified Test Set template for the specified Scenario: run -s scenario.xml -t test-set.xml -i interfaces/hosts
148
- mu cmd_runverify:run -s my_scenario -t my_testset -i a1,my-server
149
- Options (short & long form) Description
150
- -c --channels hosts Specify channel hosts as a comma-separated list.
151
- -d --dir directory Specify the directory with Scenario templates to run.
152
- -h --help Get help on command line options.
153
- -i --interfaces interfaces Specify Mu interfaces and network hosts as a comma-separated list. Example: b1, b2. When using an IP range, specify range/offset. Example: b1-1000:0,web-server
154
- -m --mu_string user:password@mu-ip Specify the user, password, and mgmt IP of the Mu system. Example: admin:admin@10.9.8.7
155
- -o --output filename Specify the filename to which you want to output logs.
156
- -p --options option:value Specify option/value pairs as a comma-separated list. Example: user:jane,email:jsmith@itemp.com
157
- -s --scenario scenario-template Specify the Scenario template to run (must be xml).
158
- -t --testset testset-template Specify the Test Set template to run (must be xml).
159
- -v --verbose Set the Logger::DEBUG level.
160
-
161
- back to top ↑
162
- cmd_runscenario
163
-
164
- 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.
165
- Command Commands & Examples
166
- help
167
-
168
- Gets help for all cmd_runscenario commands: help
169
- mu cmd_runscenario:help
170
- run
171
-
172
-
173
- Runs the specified Scenario template: run -s scenario.xml -i interfaces/hosts
174
- mu cmd_runscenario:run -s my_scenario -i a1,my-server
175
- Options (short & long form) Description
176
- -c --channels hosts Specify channel hosts as a comma-separated list.
177
- -d --dir directory Specify the directory with Scenario templates to run.
178
- -h --help Get help on command line options.
179
- -i --interfaces interfaces Specify Mu interfaces and network hosts as a comma-separated list. Example: b1, b2. When using an IP range, specify range/offset. Example: b1-1000:0,web-server
180
- -m --mu_string user:password@mu-ip Specify the user, password, and mgmt IP of the Mu system. Example: admin:admin@10.9.8.7
181
- -o --output filename Specify the filename to which you want to output logs.
182
- -s --scenario scenario-template Specify the Scenario template to run (must be xml).
183
- -v --verbose Set the Logger::DEBUG level.
184
-
185
- back to top ↑
186
-
187
-
188
- API Methods
189
-
190
- These commands provide access to legacy REST API commands supported by the Mu system.
191
-
192
- * cmd_muapi
193
- * cmd_netconfig
194
- * cmd_ddt
195
- * cmd_scale
196
- * cmd_homepage
197
- * cmd_system
198
- * cmd_cli
199
-
200
- cmd_muapi
201
-
202
- Use to access the legacy REST API for Test Runs (Protocol Mutation, Scenario Mutation, DoS, and PV tests).
203
- Command Description & Examples
204
- help Gets help for all cmd_muapi commands: help
205
- mu cmd_muapi:help
206
- archive Manage archives (reports) for Test Runs. The status and get commands require the job_id returned by the run command. archive -c command -u uuid/job-id
207
-
208
- mu cmd_muapi:archive -c run -u 52add3cf-9040-42ce-b263-8233039931d5
209
-
210
- Get the status of the archive report:
211
- mu cmd_muapi:archive -c status -u 1296064526931
212
-
213
- Download the archive report:
214
- mu cmd_muapi:archive -c get -u 1296064526931
215
- backup Manage system backup files. backup -c command
216
-
217
- Generate system backup:
218
- mu cmd_muapi:backup -c run
219
-
220
- Get the status of the backup job:
221
- mu cmd_muapi:backup -c status
222
-
223
- Download the backup file (requires a name): backup -c get -n filename
224
- mu cmd_muapi:backup -c get -n my-backup
225
-
226
- The Mu system automatically appends the .dat extension to all backup files.
227
- capture Manage pcaps recorded by the Mu system. The status and get commands require the job-id returned by the run command: capture -c command -p port-number -u job-id
228
-
229
- Start recording packets (this command returns the job-id):
230
- mu cmd_muapi:capture -c run -p a1
231
-
232
- Get the status of the packet recording job:
233
- mu cmd_muapi:capture -c status -p a1 -u 1296064526931
234
-
235
- Download the recorded packet capture:
236
- mu cmd_muapi:capture -c get -p a1 -u 1296064526931
237
- delete Delete the specified Test Run or template: delete -u uuid
238
- mu cmd_muapi:delete -u 52add3cf-9040-42ce-b263-8233039931d5
239
- export_by_name Export the specified template: export_by_name -n name -t type
240
- mu cmd_muapi:export_by_name -n my_monitor -t monitor
241
- get_faults Get a list of faults (xml format) from a Test Run: get_faults -u uuid -v
242
- mu cmd_muapi:get_faults -u 52add3cf-9040-42ce-b263-8233039931d5 -v
243
- get_name Get details for the specified Test Run or template: get_name -u uuid
244
- mu cmd_muapi:get_name -u 52add3cf-9040-42ce-b263-8233039931d5
245
- list Get a list of templates by type: list -t template-type
246
- mu cmd_muapi:list -t monitor
247
- list_by_status Get a list of Test Runs by status: list_by_status -s status
248
- mu cmd_muapi:list_by_status -s finished
249
- list_type Get a list of all template types: list_types
250
- mu cmd_muapi:list_types
251
- pause Pause a Test Run: pause -u uuid
252
- mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5
253
- resume Resume a Test Run: resume -u uuid
254
- mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5
255
- run Start a Test Run (to rename, use the -b argument): run -u uuid [-b new-name]
256
- mu cmd_muapi:run -u 52add3cf-9040-42ce-b263-8233039931d5 -b true
257
- status Get the status of a Test Run: status -u uuid
258
- mu cmd_muapi:status -u 52add3cf-9040-42ce-b263-8233039931d5
259
- stop Stop a Test Run: stop -u uuid
260
- mu cmd_muapi:stop -u 52add3cf-9040-42ce-b263-8233039931d5
261
- Options (short & long form) Description
262
- -b --boolean value Specify a boolean value (true or false).
263
- -c --command command Specify the command to run (run, get, status, etc.)
264
- -m --mu_string user:password@mu-ip Specify the user, password, and mgmt IP of the Mu system. Example: admin:admin@10.9.8.7
265
- -n --name name Specify a Test Run or template name.
266
- -o --output filename Specify the filename to which you want to output logs.
267
- -p --port port-number Specify the port number.
268
- -s --status status Specify the status filter (running, finished, aborted queued, or failed)
269
- -t --type template-type Specify the type of template.
270
- -u --uuid uuid/job-id Specify the UUID of the template to run. For archive, backup, and capture commands, this option takes a job-id value.
271
- -v --verbose Set the Logger::DEBUG level.
272
-
273
- back to top ↑
274
- cmd_netconfig
275
-
276
- Use to access the legacy REST API for configuring Mu interfaces, network hosts, and routes.
277
- Command Description & Examples
278
- help Gets help for all cmd_netconfig commands: help
279
- mu cmd_netconfig:help
280
- clear_hosts
281
-
282
- Remove all network hosts configured in the Mu system: clear_hosts
283
- mu cmd_netconfig:clear_hosts
284
- clear_interfaces
285
-
286
- Clear settings for specified Mu interfaces: clear_interfaces -i interfaces
287
- mu cmd_netconfig:clear_interfaces -i b1,b2
288
- clear_routes
289
-
290
- Remove all user-configured routes in the Mu system: clear_routes
291
- mu cmd_netconfig:clear_routes
292
- clear_vlans
293
-
294
- Remove all vlans for all Mu interfaces: clear_vlans
295
- mu cmd_netconfig:clear_vlans
296
- create
297
-
298
- Create a network object such as a host or route: create -j object -e value
299
- mu cmd_netconfig:create -j {"default": false,"direct": false,"dst": "10.0.0.0","dst_pfx_len": 8,"gateway": "192.168.100.1","interface": "a1","interface_display_name": "A1","metric": 1,"readonly": false} -e route
300
- delete
301
-
302
- Delete a network object such as host or route: delete -e value
303
- mu cmd_netconfig:delete -e Web-Server
304
- get
305
-
306
- Get details for a network object: get -e value
307
- mu cmd_netconfig:get -e a1
308
- modify
309
-
310
- Modify a network object such as a host or route:modify -j object -e value
311
- mu cmd_netconfig:modify -j {"mac": "","name": "Web-Server","notes": "","v4_addr": "192.168.112.205","v6_global_addr": "","v6_local_addr": ""} -e host
312
- resolve_hosts
313
-
314
- Get IP address for specified network host: resolve_hosts host
315
- mu cmd_netconfig:resolve_hosts Web-Server
316
- restore
317
-
318
- Restore from specified file (to overwrite existing object, use the -b argument): restore -f filepath [-b clear-existing]
319
- mu cmd_netconfig:restore -f my_muhosts/web-server.json true
320
- save
321
-
322
- Save changes to the Mu system: save
323
- mu cmd_netconfig:save
324
- Options (short & long form) Description
325
- -b --boolean value Specify a boolean value (true or false).
326
- -e --element value Specify a value for the associated command. Example: interfaces or interfaces/a1
327
- -f --filepath filepath Specify the path to a file.
328
- -h --help Get help on command line options.
329
- -i --interfaces interface-or-host Specify Mu interfaces or network hosts as a comma-separated list. Example: b1, web-server.
330
- -j --json object Specify a json object as a text string.
331
- -m --mu_string user:password@mu-ip Specify a user, password, and mgmt IP of a Mu system. Example: admin:admin@10.9.8.7
332
- -o --output filename Specify the filename to which you want to output logs.
333
- -v --verbose Set the Logger::DEBUG level.
334
-
335
- back to top ↑
336
- cmd_ddt
337
-
338
- Use to access the legacy REST API for Test Sets (Studio Verify).
339
- tr> tr>
340
- Command Description & Examples
341
- display_results Displays results for the current Test Set: display_results
342
- mu cmd_ddt:display_results
343
- new_session Create a new session: new_session
344
- mu cmd_ddt:new_session
345
- load_scenario Load the specified Scenario template: load_scenario -u uuid
346
- mu cmd_ddt:load_scenario -u 52add3cf-9040-42ce-b263-8233039931d5
347
- get_hosts Get a list of hosts in the Test Bed: get_hosts
348
- mu cmd_ddt:get_hosts
349
- set_hosts Configure the hosts in the Test Bed: set_hosts -r role -n name -y type
350
- mu cmd_ddt:set_hosts -r HTTP_Client,HTTP_Server -n a1,Web-Server -y v4
351
- get_channels Get a list of channels in the Test Bed: get_channels
352
- mu cmd_ddt:get_channels
353
- set_channels Configure the channels in the Test Bed: set_channels -r role -n name
354
- mu cmd_ddt:set_channels -r SSH_Channel -n Web-Server
355
- get_options Get a list of options in the Test Set: get_options
356
- mu cmd_ddt:get_options
357
- set_options Configure the option values for the Test Set: set_options -n name -p value
358
- mu cmd_ddt:set_options -n username -p jsmith
359
- get_sessions Get a list of all sessions: get_sessions
360
- mu cmd_ddt:get_sessions
361
- setup_test Setup the Test Bed, reserving the Mu interfaces: setup_test
362
- mu cmd_ddt:setup_test
363
- run Run a Test Set: run
364
- mu cmd_ddt:run
365
- run_testset Run the specified Test Set: run_testset -u uuid
366
- mu cmd_ddt:run_testset -u 04aa248a-0b9b-4bf6-97e1-aab691d0acf1
367
- get_testset_results Get results for the current Test Set: get_testset_results
368
- mu cmd_ddt:get_testset_results
369
- get_testset_status Get status for the current Test Set: get_testset_status
370
- mu cmd_ddt:get_testset_status
371
- teardown_test Unsets the Test Bed selections, releasing the Mu interfaces: teardown_test
372
- mu cmd_ddt:teardown_test
373
- close_session Closes the current session: close_session
374
- mu cmd_ddt:close_session
375
- close_all_sessions Closes all existing sessions: close_all_sessions
376
- mu cmd_ddt:close_all_sessions
377
- csv_export Exports a Test Set from the Mu system to a. csv file: csv_export -u uuid
378
- mu cmd_ddt:csv_export -u 52add3cf-9040-42ce-b263-8233039931d5
379
- csv_import Imports a .csv file to create a Test Set on the Mu system: csv_import -t filename.csv
380
- mu cmd_ddt:csv_import -t my-testset.csv
381
- Options (short & long form) Description
382
- -f --filename filename Specify the template name for saving an imported Test Set.
383
- -h --help Get help on command line options.
384
- -m --mu_string user:password@mu-ip Specify a user, password, and mgmt IP of a Mu system. Example: admin:admin@10.9.8.7
385
- -n --names name-array Specify host names or channel names in a comma-separated array. Example: a1,Web-Server
386
- -o --output filename Specify the filename to which you want to output logs.
387
- -p --option_values value-array Specify values for Test Set options in a comma-separated array. Example: bob,jane,mary,tom
388
- -r --roles role-array Specify host roles in a comma-separated array. Example: HTTP_Client,HTTP_Server
389
- -t --testset filename.csv Specify the name of the .csv file to import.
390
- -u --uuid uuid Specify the UUID of the Scenario or Test Set.
391
- -v --verbose Set the Logger::DEBUG level.
392
- -y --type type Specify network layer (v4, v6, l2) for all hosts in the Test Bed. Example: v4
393
-
394
- back to top ↑
395
- cmd_scale
396
-
397
- Use to access the legacy REST API for Scale tests (Studio Scale).
398
- Command Description & Examples
399
- about Lists information for the Scale Player and all active and inactive Scale Engines: about
400
- mu cmd_scale:about
401
- configure Configure any element of the scale json object : configure -p parameter -pv value
402
- mu cmd_scale:configure -p json_element -pv json_element_value
403
- data Gets chart data for the Scale test: data -w view -z zoom -ps position -b bot_id
404
- mu cmd_scale:data -w TIMELINE -z 1 -ps 0 -b bots_10.10.6.200:1
405
- delete_scale_engine Delete the specified Scale Engine:delete_scale_engine -b bot_id
406
- mu cmd_scale:delete_scale_engine -b bots_10.10.6.200:1
407
- help Gets help for all cmd_scale commands: help
408
- mu cmd_scale:help
409
- list Returns the current Scale Player's UUID: list
410
- mu cmd_scale:list
411
- pattern Gets the pattern for the Scale test: pattern -z zoom -ps position
412
- mu cmd_scale:pattern -z 1 -ps 0
413
- pcap Gets a pcap from a specific Scale Engine: pcap -b bot_id -f filename
414
- mu cmd_scale:pcap -b bots_10.10.6.200:1 -f bot_1_pcap
415
- release Release the Scale Player: release
416
- mu cmd_scale:release
417
- release_scale_engine Releases the specified Scale Engine:release_scale_engine -b bot_id
418
- mu cmd_scale:release_scale_engine -b bots_10.10.6.200:1
419
- reserve_scale_engine Reserves the specified Scale Engine:reserve_scale_engine -b bot_id
420
- mu cmd_scale:reserve_scale_engine -b bots_10.10.6.200:1
421
- session Create a new Scale Player session: session
422
- mu cmd_scale:session
423
- start Start the Scale test: start -c scale-test -m user:pass@mu-ip
424
- mu cmd_scale:start -c scale.json -m admin:admin@10.10.2.2
425
- status Gets information about the currently running Scale test: status
426
- mu cmd_scale:status
427
- statuses Gets the status of all active and inactive Scale engines: statuses
428
- mu cmd_scale:statuses
429
- stop Stops the Scale test: stop
430
- mu cmd_scale:stop
431
- update Update the pattern dynamically (while the Scale test is running): update -p parameter -pv parameter-value
432
- mu cmd_scale:update -p delay -pv 250 -p volume -pv 100000
433
- verify Verifies a Scale test: verify
434
- mu cmd_scale:verify
435
- Options (short & long form) Description
436
- -b --bot-id scale-engine-id Specify a Scale Engine using its bot-id value.
437
- -c --config-file json-filename Specify a .json file that contains the configuration data.
438
- -f --filename pcap-filename Specify a name for the .pcap file.
439
- -h --help Get help on command line options.
440
- -m --mu_string user:password@mu-ip Specify a user, password, and mgmt IP of a Mu system. Example: admin:admin@10.9.8.7
441
- -o --output filename Specify the filename to which you want to output logs.
442
- -p --params parameters Specify parameters for initial configuration or for update. Supports delay and volume parameters.
443
- -ps --view_position value Specify the position in the timeline view for which to return data. At this time, only position 0 is supported.
444
- -pv --param_value value Specify a value for a parameter.
445
- -v --verbose Set the Logger::DEBUG level.
446
- -w --view view Specify the view (RUNTIME or CALLGRAPH) for which to return data.
447
- -z --zoom zoom-level Specify the zoom level (0, .5, or 1) 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.
448
-
449
- back to top ↑
450
- cmd_homepage
451
-
452
- Use to access information displayed on the Mu UI homepage, such as recent updates, backup status, or a list of latest test results.
453
- Command Description & Examples
454
- all Gets the complete set of information displayed on the Mu home page: all
455
- mu cmd_homepage:all
456
- help Gets help for all cmd_homepage commands: help
457
- mu cmd_homepage:help
458
- latest_test Gets an array of the latest test results: latest_test
459
- mu cmd_homepage:latest_test
460
- queue_test Gets an array of tests in the Test Queue: queue_test
461
- mu cmd_homepage:queue_test
462
- recent Gets the "What's New" section from the Mu homepage: recent
463
- mu cmd_homepage:recent
464
- status Gets system status for licenses, backup, and updates: status
465
- mu cmd_homepage:status
466
- Options (short & long form) Description
467
- -h --help Get help on command line options.
468
- -m --mu_string user:password@mu-ip Specify a user, password, and mgmt IP of a Mu system. Example: admin:admin@10.9.8.7
469
- -o --output filename Specify the filename to which you want to output logs.
470
- -v --verbose Set the Logger::DEBUG level.
471
-
472
- back to top ↑
473
- cmd_system
474
-
475
- Use to restart system services or to get status details for the Mu system.
476
- Command Description & Examples
477
- restart Restart Mu system services (this does not reboot the appliance): restart
478
- mu cmd_system:restart
479
- status Gets all information from the system status page: status
480
- mu cmd_system:status
481
- status2 Gets additional system information such as hard drive status, platform model, serial number: status2
482
- mu cmd_system:status2
483
- Options (short & long form) Description
484
- -h --help Get help on command line options.
485
- -m --mu_string user:password@mu-ip Specify a user, password, and mgmt IP of a Mu system. Example: admin:admin@10.9.8.7
486
- -o --output filename Specify the filename to which you want to output logs.
487
- -v --verbose Set the Logger::DEBUG level.
488
-
489
- back to top ↑
490
- cmd_cli
491
-
492
- Use to access the Mu CLI.
493
- Command Description & Examples
494
- cli_help Get help for all cmd_cli commands: cli_help
495
- mu cmd_cli:cli_help
496
- cli_history Display the command line history for the current session: cli_help
497
- mu cmd_cli:history
498
- ping Ping the specified IP address from the Mu system: ping -a ip-address
499
- mu cmd_cli:ping -a 10.10.10.1
500
- question Show the available CLI commands: question
501
- mu cmd_cli:question
502
- traceroute Get the network route to a specified IP address from the Mu system: traceroute -a ip-address
503
- mu cmd_cli:traceroute -a 10.10.10.1
504
- Options (short & long form) Description
505
- -h --help Get help on command line options.
506
- -m --mu_string user:password@mu-ip Specify a user, password, and mgmt IP of a Mu system. Example: admin:admin@10.9.8.7
507
- -o --output filename Specify the filename to which you want to output logs.
508
- -v --verbose Set the Logger::DEBUG level.
509
-
510
- back to top ↑
511
-
512
-
513
- Library Classes
514
-
515
- The following API library classes can be ‘required’ and used within Ruby scripts( like most ruby gems).
516
- Command Description & Examples
517
-
518
- muapi
519
-
520
-
521
- require 'rubygems'
522
-
523
- require 'mu'
524
-
525
- api = Mu::Muapi.new(“10.10.2.2”, “admin”, “admin”)
526
-
527
- $log.level = Logger::INFO
528
-
529
- Example: api.list_by_status("running")
530
-
531
- ddt
532
-
533
-
534
- require 'rubygems'
535
-
536
- require 'mu'
537
-
538
- api = Mu::Ddt.new(“10.10.2.2”, “admin”, “admin”)
539
-
540
- $log.level = Logger::INFO
541
-
542
- Example: api.new_session
543
-
544
- scale
545
-
546
-
547
- require 'rubygems'
548
-
549
- require 'mu'
550
-
551
- api = Mu::Scale.new(“10.10.2.2”, “admin”, “admin”)
552
-
553
- $log.level = Logger::INFO
554
-
555
- Examples:
556
- api.configure -p musl -pv <scenario.msl>
557
- api.configure -p csv -pv <testset.csv>
558
- api.configure -p pattern -pv <pattern.json>
559
- api.start
560
- api.status
561
- api.stop
562
- api.release
563
- netconfig
564
-
565
- require 'rubygems'
566
-
567
- require 'mu'
568
-
569
- api = Mu::Netconfig.new(“10.10.2.2”, “admin”, “admin”)
570
-
571
- $log.level = Logger::INFO
572
-
573
- Example: api.get("hosts")
574
-
575
-
576
-
577
- back to top ↑
578
- Mu Dynamics Information
579
-
580
- Mu Dynamics Customer Care is available 9am to 5pm PST, Monday to Friday at the toll-free support line at 1-866-276-4640; international customers can also use 1-408-329-6330. For online communication, visit the Mu Dynamics Customer Care Center at http://www.mudynamics.com/support/overview.html.
581
-
582
- In addition to Mu UI Help and the Mu product documentation, you can also get continuous updates on Mu system capabilities using the following resources:
583
- Corporate Home • Press • Webinars, Seminars, & Podcasts • Product Demos • RSS Feed
584
- Social Twitter • Facebook • YouTube • Mu Community • Pcapr
585
- Blogs Mu Line • Mu Labs (with RSS Feed)
586
- Copyright 2011 Mu Dynamics Inc., All Rights Reserved.