mu 5.7.36 → 5.7.37

data/README.md

@@ -1,17 +1,15 @@
 #Mu Ruby Gem <a id="top"/>#
 
-#####API Commands for the Mu System#####
-
 The Mu Ruby gem contains command line application (executables) designed to help you work with Scenarios, Test Sets, Scale tests and all results generated from those tests. The 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. API library classes are exposed for use in your own custom gems.
 
 ###Before Using the Gem###
 
 Before using this gem, you must install the necessary software, which 
-includes ruby 1.8.6 and the following gems (**`sudo gem install`** *`gem`*):
+includes ruby 1.8.6 and the following gems (<b>`sudo gem install`</b> <em>`gem`</em>):
 
 - *hexy*. This ensures that hex dumps print pretty :)
 - *json\_pure*. Don't confuse this with the json gem (that won't work).
-- *nokogiri*. See [http://nokogiri.org/tutorials/installing\_nokogiri.html](http://nokogiri.org/tutorials/installing\_nokogiri.html) for help.
+- *nokogiri*. See [http://nokogiri.org/tutorials/installing_nokogiri.html](http://nokogiri.org/tutorials/installing_nokogiri.html) for help.
 - *rest-client*. Used for HTTP calls.
 - *mime-types*. Required by REST-client.
 
@@ -79,7 +77,6 @@ running Scale tests.
 -   [cmd\_musl](#cmd_musl)
 
 ###cmd\_appid <a id="cmd_appid"/>###
-#####» see [cmd_appid options](#cmd_appid_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
  
 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
@@ -87,30 +84,32 @@ of .msl files. Supports command-line options for setting test parameters
 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. 
 
+» see [cmd_appid options](#cmd_appid_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***help*** 
 
 - Gets help for all cmd\_appid commands. 
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_appid:help`
 
 ***run\_file*** 
 
 - Runs the specified .msl file. 
-- **`run_file -s`** *`msl-filename`*
+- <b>`run_file -s`</b> <em>`msl-filename`</em>
 - `mu cmd_appid:run_file -s msl_file -i a1,a2 -m admin:admin@10.10.2.2
 -p 1-10000:60`
 
 ***run\_dir***
 
 - Runs all .msl files in the specified directory. 
-- **`run_dir -d`** *`msl-directory`*
+- <b>`run_dir -d`</b> <em>`msl-directory`</em>
 - `mu cmd_appid:run_dir -d msl_file_directory -i a1-10000,a2 -m
 admin:admin@10.10.2.2 -p 1-100000:360`
 
 ***running?*** 
 
 - Gets status of the scale player. 
-- **`running?`**
+- <b>`running?`</b>
 - `mu cmd_appid:running?`
 
 ####Options <a id="cmd_appid_options"/>####
@@ -155,26 +154,27 @@ admin:admin@10.10.2.2 -p 1-100000:360`
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 ###cmd\_runscale <a id="cmd_runscale"/>###
-#####» see [cmd_runscale options](#cmd_runscale_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 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.
 
+» see [cmd_runscale options](#cmd_runscale_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***help***
 
 - Gets help for all cmd\_runscale commands
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_runscale:help`
 
 ***run\_file***
 
 - Runs a Scale test for the specified .msl file
-- **`run_file -s`** *`msl-filename`* **`-i`** *`interface,host`* **`-p`** *`pattern`*
+- <b>`run_file -s`</b> <em>`msl-filename`</em> <b>`-i`</b> <em>`interface,host`</em> <b>`-p`</b> <em>`pattern`</em>
 - `mu cmd_runscale:run_file -s msl_file -i a1,dell-9 -p 1-100:30`
 
 ***run\_dir***
@@ -182,13 +182,13 @@ Mu interfaces and/or network hosts.
 - Runs a Scale test for all .msl files in the specified directory. To
 include all .msl files in nested directories, use **-r** to perform a
 recursive directory search. 
-- **`run_dir -d`** *`msl_directory`* **`-r`**
+- <b>`run_dir -d`</b> <em>`msl_directory`</em> <b>`-r`</b>
 - `mu cmd_runscale:run_dir -d msl_file_directory`
 
 ***running?***
 
 - Gets status of the Scale player. 
-- **`running?`**
+- <b>`running?`</b>
 - `mu cmd_runscale:running?`
 
 ***run\_files***
@@ -197,7 +197,7 @@ recursive directory search.
 (optionally, you can specify single .msl file). To include all .msl
 files in nested directories, use **-r** to perform a recursive directory
 search. 
-- **`run_file -d`** *`msl-directory`* **`-r -i`** *`interfaces,hosts`* **`-p`** *`pattern`*
+- <b>`run_file -d`</b> <em>`msl-directory`</em> <b>`-r -i`</b> <em>`interfaces,hosts`</em> <b>`-p`</b> <em>`pattern`</em>
 - `mu cmd_runscale:run_file -d msl_file_directory -r -i a1,dell-9 -p
 1-100:30`
 
@@ -252,24 +252,25 @@ search.
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 ###cmd\_runverify <a id="cmd_runverify"/>###
-#####» see [cmd_runverify options](#cmd_runverify_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 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.
 
+» see [cmd_runverify options](#cmd_runverify_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***help***
 
 - Gets help for all cmd\_runverify commands. 
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_runverify:help`
 
 ***run***
 
 - Runs the specified Test Set template for the specified Scenario. 
-- **`run -s`** *`scenario.xml`* **`-t`** *`test-set.xml`* **`-i`** *`interface,host`*
+- <b>`run -s`</b> <em>`scenario.xml`</em> <b>`-t`</b> <em>`test-set.xml`</em> <b>`-i`</b> <em>`interface,host`</em>
 - `mu cmd_runverify:run -s my_scenario -t my_testset -i a1,my-server`
 
 ####Options <a id="cmd_runverify_options"/>####
@@ -314,23 +315,23 @@ network hosts.
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
 
 ###cmd\_runscenario <a id="cmd_runscenario"/>###
-#####» see [cmd_runscenario options](#cmd_runscenario_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 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.
 
+» see [cmd_runscenario options](#cmd_runscenario_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***help***
 
 - Gets help for all cmd\_runscenario commands
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_runscenario:help`
 
 ***run***
 
 - Runs the specified Scenario template. 
-- **`run -s`** *`scenario.xml`* **`-i`** *`interfaces,hosts`*
+- <b>`run -s`</b> <em>`scenario.xml`</em> <b>`-i`</b> <em>`interfaces,hosts`</em>
 - `mu cmd_runscenario:run -s my_scenario -i a1,my-server`
 
 ####Options <a id="cmd_runscenario_options"/>####
@@ -367,26 +368,27 @@ Use to load and verify a Scenario template (.xml file). Supports command-line op
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 ###cmd\_musl <a id="cmd_musl"/>###
-#####» see [cmd_musl options](#cmd_musl_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 Use to create .msl files from **H**TTP **Ar**chive (.har) files, which
 capture web page loading information in JSON format. You can use the
-**`from_har`** command to transform a .har file into a Scenario (in .msl
+<b>`from_har`</b> command to transform a .har file into a Scenario (in .msl
 format) suitable for import into Mu Studio.
 
+» see [cmd_musl options](#cmd_musl_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***help***
 
 - Gets help for all cmd\_musl commands. 
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_musl:help`
 
 ***from\_har***
 
 - Creates a .msl file from the specified .har file. If you omit the scenario filename, the output .msl file uses the har\_filename.
-- **`from_har`** *`options`* **`-s`** *`scenario_filename.msl har_filename.har`* 
+- <b>`from_har`</b> <em>`options`</em> <b>`-s`</b> <em>`scenario_filename.msl har_filename.har`</em> 
 - `mu cmd_musl:from_har --ignore-images -s my_scenario.msl
 my_har_file.har`
 
@@ -394,14 +396,14 @@ my_har_file.har`
 
 - Escape special javascript characters ( $ , " , ' ) in the return payload
 of the .msl file. 
-- **`escape -s`** *`filename.msl`*
+- <b>`escape -s`</b> <em>`filename.msl`</em>
 - `mu cmd_musl:escape -s my_scenario.msl -o escaped_characters.js`
 
 ***bin2hex***
 
 - Convert a binary file into a hex string that can be included in a
 Scenario response. 
-- **`bin2hex -s`** *`filename.msl`*
+- <b>`bin2hex -s`</b> <em>`filename.msl`</em>
 - `mu cmd_musl:bin2hex -s my_scenario.msl -o hex_string_file`
 
 ####Options <a id="cmd_musl_options"/>####
@@ -450,7 +452,7 @@ Scenario response.
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 * * * * *
 ##Legacy API Commands <a id="legacy"/>##
@@ -467,131 +469,130 @@ the Mu system.
 -   [cmd\_cli](#cmd_cli)
 
 ###cmd\_muapi <a id="cmd_muapi"/>###
-#####» see [cmd_muapi options](#cmd_muapi_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
-Use to access the legacy REST API for Test Runs (Protocol Mutation,
-Scenario Mutation, Denial-of-Service, and Published Vulnerability
-tests).
+Use to access the legacy REST API for Test Runs (Protocol Mutation, Scenario Mutation, Denial-of-Service, and Published Vulnerability tests).
+
+» see [cmd_muapi options](#cmd_muapi_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
 
 ***help***
 
 - Gets help for all cmd\_muapi commands.
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_muapi:help`
 
 ***archive***
 
 - Manage archives (reports) for Test Runs. The run command uses the uuid of the Test Run; the status and get commands require the job\_id returned by the run command. 
 - To generate an archive: 
-	- **`archive -c run -u`** *`uuid`*	
+	- <b>`archive -c run -u`</b> <em>`uuid`</em>	
 	- `mu cmdd_muapi:archive -c run -u 52add3cf-9040-42ce-b263-8233039931d5`
 - To get the status of the archive report: 
-	- **`archive -c status -u`** *`job-id`*
+	- <b>`archive -c status -u`</b> <em>`job-id`</em>
  	- `mu cmd_muapi:archive -c status -u 1296064526931`
 - To download the archive report: 
-	- **`archive -c get -u`** *`job-id`*
+	- <b>`archive -c get -u`</b> <em>`job-id`</em>
 	- `mu cmd_muapi:archive -c get -u 1296064526931`
 
 ***backup***
 
 - Manage system backup files. Supports `get`, `run`, and `status` commands.
 - To generate system backup:
-	- **`backup -c run`**
+	- <b>`backup -c run`</b>
 	- `mu cmd_muapi:backup -c run`
 - To get the status of the backup job:
-	- **`backup -c status`**
+	- <b>`backup -c status`</b>
 	- `mu cmd_muapi:backup -c status`
 - To download the backup file (requires a name):
-	- **`backup -c get -n`** *`filename`*
+	- <b>`backup -c get -n`</b> <em>`filename`</em>
 	- `mu cmd_muapi:backup -c get -n my-backup`
 
 The Mu system automatically appends the .dat extension to all backup files.
 
 ***capture***
 
-- Manage packet captures recorded using 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`*
+- Manage packet captures recorded using the Mu system. The <b>`status`</b> and
+<b>`get`</b> commands require the job-id returned by the <b>`run`</b> command. 
+- <b>`capture -c`</b> <em>`command`</em> <b>`-p`</b> <em>`port-number`</em> <b>`-u`</b> <em>`job-id`</em>
 - To start recording packets (this command returns the job-id):
-	- **`capture -c run -p`** *`port-number`*
+	- <b>`capture -c run -p`</b> <em>`port-number`</em>
 	- `mu cmd_muapi:capture -c run -p a1`	
 - To get the status of the packet recording job:
-	- **`capture -c status -p`** *`port-number`* **`-u`** *`job-id`*
+	- <b>`capture -c status -p`</b> <em>`port-number`</em> <b>`-u`</b> <em>`job-id`</em>
 	- `mu cmd_muapi:capture -c status -p a1 -u 1296064526931`
 - To download the recorded packet capture:
-	- **`capture -c get -p`** *`port-number`* **`-u`** *`job-id`*
+	- <b>`capture -c get -p`</b> <em>`port-number`</em> <b>`-u`</b> <em>`job-id`</em>
 	- `mu cmd_muapi:capture -c get -p a1 -u 1296064526931`
 
 ***delete***
 
 - Delete the specified Test Run or template
-- **`delete -u`** *`uuid`*
+- <b>`delete -u`</b> <em>`uuid`</em>
 - `mu cmd_muapi:delete -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ***export\_by\_name***
 
 - Export the specified template. 
-- **`export_by_name -n`** *`name`* **`-t`** *`type`*
+- <b>`export_by_name -n`</b> <em>`name`</em> <b>`-t`</b> <em>`type`</em>
 - `mu cmd_muapi:export_by_name -n my_monitor -t monitor`
 
 ***get\_faults***
 
 - Get a list of faults (xml format) from a Test Run. 
-- **`get_faults -u`** *`uuid`* **`-v`**
+- <b>`get_faults -u`</b> <em>`uuid`</em> <b>`-v`</b>
 - `mu cmd_muapi:get_faults -u 52add3cf-9040-42ce-b263-8233039931d5 -v`
 
 ***get\_name***
 
 - Get details for the specified Test Run or template. 
-- **`get_name -u`** *`uuid`*
+- <b>`get_name -u`</b> <em>`uuid`</em>
 - `mu cmd_muapi:get_name -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ***list***
 
 - Get a list of templates by type. 
-- **`list -t`** *`template-type`*
+- <b>`list -t`</b> <em>`template-type`</em>
 - `mu cmd_muapi:list -t monitor`
 
 ***list\_by\_status***
 
 - Get a list of Test Runs by status. 
-- **`list_by_status -s`** *`status`*
+- <b>`list_by_status -s`</b> <em>`status`</em>
 - `mu cmd_muapi:list_by_status -s finished`
 
 ***list\_type***
 
 - Get a list of all template types. 
-- **`list_types`**
+- <b>`list_types`</b>
 - `mu cmd_muapi:list_types`
 
 ***pause***
 
 - Pause a Test Run. 
-- **`pause -u`** *`uuid`*
+- <b>`pause -u`</b> <em>`uuid`</em>
 - `mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ***resume***
 
 - Resume a Test Run. 
-- **`resume -u`** *`uuid`*
+- <b>`resume -u`</b> <em>`uuid`</em>
 - `mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ***run***
 
 - Start a Test Run (to rename, use the -b argument). 
-- **`run -u`** *`uuid`* `[`**`-b`** *`new-name`*`]`
+- <b>`run -u`</b> <em>`uuid`</em> `[`<b>`-b`</b> <em>`new-name`</em>`]`
 - `mu cmd_muapi:run -u 52add3cf-9040-42ce-b263-8233039931d5 -b true`
 
 ***status***
 
 - Get the status of a Test Run. 
-- **`status -u`** *`uuid`*
+- <b>`status -u`</b> <em>`uuid`</em>
 - `mu cmd_muapi:status -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ***stop***
 
 - Stop a Test Run. 
-- **`stop -u`** *`uuid`*
+- <b>`stop -u`</b> <em>`uuid`</em>
 - `mu cmd_muapi:stop -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ####Options <a id="cmd_muapi_options"/>####
@@ -636,85 +637,86 @@ The Mu system automatically appends the .dat extension to all backup files.
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 ###cmd\_netconfig <a id="cmd_netconfig"/>###
-#####» see [cmd_netconfig options](#cmd_netconfig_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 Use to access the legacy REST API for configuring Mu interfaces, network
 hosts, and routes.
 
+» see [cmd_netconfig options](#cmd_netconfig_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***help***
 
 - Gets help for all cmd\_netconfig commands. 
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_netconfig:help`
 
 ***clear\_hosts***
 
 - Remove all network hosts configured in the Mu system. 
-- **`clear_hosts`**
+- <b>`clear_hosts`</b>
 - `mu cmd_netconfig:clear_hosts`
 
 ***clear\_interface***
 
 - Clear settings for specified Mu interfaces. 
-- **`clear_interface -i`** *`interface,interface`*
+- <b>`clear_interface -i`</b> <em>`interface,interface`</em>
 - `mu cmd_netconfig:clear_interface -i b1,b2`
 
 ***clear\_routes***
 
 - Remove all user-configured routes in the Mu system.
-- **`clear_routes`**
+- <b>`clear_routes`</b>
 - `mu cmd_netconfig:clear_routes`
 
 ***clear\_vlans***
 
 - Remove all vlans for all Mu interfaces. 
-- **`clear_vlans`**
+- <b>`clear_vlans`</b>
 - `mu cmd_netconfig:clear_vlans`
 
 ***create***
 
 - Create a network object such as a host or route. 
-- **`create -j`** *`object`* **`-e`** *`value`*
+- <b>`create -j`</b> <em>`object`</em> <b>`-e`</b> <em>`value`</em>
 - `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 routes`
 
 ***delete***
 
 - Delete a network object such as host or route. 
-- **`delete -e`** *`value`*
+- <b>`delete -e`</b> <em>`value`</em>
 - `mu cmd_netconfig:delete -e Web-Server`
 
 ***get***
 
 - Get details for a network object. 
-- **`get -e`** *`value`*
+- <b>`get -e`</b> <em>`value`</em>
 - `mu cmd_netconfig:get -e a1`
 
 ***modify***
 
 - Modify a network object such as a host or route. 
-- **`modify -j`** *`object`* **`-e`** *`value`*
+- <b>`modify -j`</b> <em>`object`</em> <b>`-e`</b> <em>`value`</em>
 - `mu cmd_netconfig:modify -j {"mac": "","name": "Web-Server","notes": "","v4_addr": "192.168.112.205", "v6_global_addr": "","v6_local_addr": ""} -e host`
 
 ***resolve\_hosts***
 
 - Get IP address for specified network host. 
-- **`resolve_hosts`** *`host`*
+- <b>`resolve_hosts`</b> <em>`host`</em>
 - `mu cmd_netconfig:resolve_hosts Web-Server`
 
 ***restore***
 
 - Restore from specified file (to overwrite existing object, use the -b
 argument). 
-- **`restore -f`** *`filepath`* `[`**`-b`** *`clear-existing`*`]`
+- <b>`restore -f`</b> <em>`filepath`</em> `[`<b>`-b`</b> <em>`clear-existing`</em>`]`
 - `mu cmd_netconfig:restore -f my_muhosts/web-server.json true`
 
 ***save***
 
 - Save changes to the Mu system. 
-- **`save`**
+- <b>`save`</b>
 - `mu cmd_netconfig:save`
 
 ####Options <a id="cmd_netconfig_options"/>####
@@ -755,131 +757,132 @@ argument).
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 ###cmd\_ddt <a id="cmd_ddt"/>###
-#####» see [cmd_ddt options](#cmd_ddt_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 Use to access the legacy REST API for Test Sets (Studio Verify).
 
+» see [cmd_ddt options](#cmd_ddt_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***display\_results***
 
 - Displays results for the current Test Set. 
-- **`display_results`**
+- <b>`display_results`</b>
 - `mu cmd_ddt:display_results`
 
 ***new\_session***
 
 - Create a new session. 
-- **`new_session`**
+- <b>`new_session`</b>
 - `mu cmd_ddt:new_session`
 
 ***load\_scenario***
 
 - Load the specified Scenario template. 
-- **`load_scenario -u`** *`uuid`*
+- <b>`load_scenario -u`</b> <em>`uuid`</em>
 - `mu cmd_ddt:load_scenario -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ***get\_hosts***
 
 - Get a list of hosts in the Test Bed. 
-- **`get_hosts`**
+- <b>`get_hosts`</b>
 - `mu cmd_ddt:get_hosts`
 
 ***set\_hosts***
 
 - Configure the hosts in the Test Bed. Requires host role, host name, and type (network layer). 
-- **`set_hosts -r`** *`role,role`* **`-n`** *`name,name`* **`-y`** *`type`*
+- <b>`set_hosts -r`</b> <em>`role,role`</em> <b>`-n`</b> <em>`name,name`</em> <b>`-y`</b> <em>`type`</em>
 - `mu cmd_ddt:set_hosts -r HTTP_Client,HTTP_Server -n a1,Web-Server -y v4`
 
 ***get\_channels***
 
 - Get a list of channels in the Test Bed. 
-- **`get_channels`**
+- <b>`get_channels`</b>
 - `mu cmd_ddt:get_channels`
 
 ***set\_channels***
 
 - Configure the channels in the Test Bed. 
-- **`set_channels -r`** *`role`* **`-n`** *`name`*
+- <b>`set_channels -r`</b> <em>`role`</em> <b>`-n`</b> <em>`name`</em>
 - `mu cmd_ddt:set_channels -r SSH_Channel -n Web-Server`
 
 ***get\_options***
 
 - Get a list of options in the Test Set. 
-- **`get_options`**
+- <b>`get_options`</b>
 - `mu cmd_ddt:get_options`
 
 ***set\_options***
 
 - Configure the option values for the Test Set. 
-- **`set_options -n`** *`name`* **`-p`** *`value`*
+- <b>`set_options -n`</b> <em>`name`</em> <b>`-p`</b> <em>`value`</em>
 - `mu cmd_ddt:set_options -n username -p jsmith`
 
 ***get\_sessions***
 
 - Get a list of all sessions. 
-- **`get_sessions`**
+- <b>`get_sessions`</b>
 - `mu cmd_ddt:get_sessions`
 
 ***setup\_test***
 
 - Setup the Test Bed, reserving the Mu interfaces. 
-- **`setup_test`**
+- <b>`setup_test`</b>
 - `mu cmd_ddt:setup_test`
 
 ***run***
 
 - Run a Test Set. 
-- **`run`**
+- <b>`run`</b>
 - `mu cmd_ddt:run`
 
 ***run\_testset***
 
 - Run the specified Test Set.
-- **`run_testset -u`** *`uuid`*
+- <b>`run_testset -u`</b> <em>`uuid`</em>
 - `mu cmd_ddt:run_testset -u 04aa248a-0b9b-4bf6-97e1-aab691d0acf1`
 
 ***get\_testset\_results***
 
 - Get results for the current Test Set. 
-- **`get_testset_results`**
+- <b>`get_testset_results`</b>
 - `mu cmd_ddt:get_testset_results`
 
 ***get\_testset\_status***
 
 - Get status for the current Test Set. 
-- **`get_testset_status`**
+- <b>`get_testset_status`</b>
 - `mu cmd_ddt:get_testset_status`
 
 ***teardown\_test***
 
 - Unsets the Test Bed selections, releasing the Mu interfaces. 
-- **`teardown_test`**
+- <b>`teardown_test`</b>
 - `mu cmd_ddt:teardown_test`
 
 ***close\_session***
 
 - Closes the current session. 
-- **`close_session`**
+- <b>`close_session`</b>
 - `mu cmd_ddt:close_session`
 
 ***close\_all\_sessions***
 
 - Closes all existing sessions. 
-- **`close_all_sessions`**
+- <b>`close_all_sessions`</b>
 - `mu cmd_ddt:close_all_sessions`
 
 ***csv\_export***
 
 - Exports a Test Set from the Mu system to a csv file. 
-- **`csv_export -u`** *`uuid`*
+- <b>`csv_export -u`</b> <em>`uuid`</em>
 - `mu cmd_ddt:csv_export -u 52add3cf-9040-42ce-b263-8233039931d5`
 
 ***csv\_import***
 
 - Imports a .csv file to create a Test Set on the Mu system. 
-- **`csv_import -t`** *`filename.csv`*
+- <b>`csv_import -t`</b> <em>`filename.csv`</em>
 - `mu cmd_ddt:csv_import -t my-testset.csv`
 
 ####Options <a id="cmd_ddt_options"/>####
@@ -928,113 +931,114 @@ Use to access the legacy REST API for Test Sets (Studio Verify).
 
 > Specify network layer (v4, v6, l2) for all hosts in the Test Bed. Example: `v4`.
 
-[back to top ↑](#top)
+
 
 ###cmd\_scale <a id="cmd_scale"/>###
-#####» see [cmd_scale options](#cmd_scale_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 Use to access the legacy REST API for Scale tests (Studio Scale).
 
+» see [cmd_scale options](#cmd_scale_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***about***
 
 - Lists information for the Scale Player and all active and inactive Scale Engines. 
-- **`about`**
+- <b>`about`</b>
 - `mu cmd_scale:about`
 
 ***configure***
 
 - Configure parameter values for any element of the scale json object. 
-- **`configure -p`** *`parameter`* **`-pv`** *`value`*
+- <b>`configure -p`</b> <em>`parameter`</em> <b>`-pv`</b> <em>`value`</em>
 - `mu cmd_scale:configure -p json_element -pv json_element_value`
 
 ***data***
 
 - Gets chart data for the Scale test. 
-- **`data -w`** *`view`* **`-z`** *`zoom`* **`-ps`** *`position`* **`-b`** *`bot_id`*
+- <b>`data -w`</b> <em>`view`</em> <b>`-z`</b> <em>`zoom`</em> <b>`-ps`</b> <em>`position`</em> <b>`-b`</b> <em>`bot_id`</em>
 - `mu cmd_scale:data -w TIMELINE -z 1 -ps 0 -b bots_10.10.6.200:1`
 
 ***delete\_scale\_engine***
 
 - Delete the specified Scale Engine. 
-- **`delete_scale_engine -b`** *`bot_id`*
+- <b>`delete_scale_engine -b`</b> <em>`bot_id`</em>
 - `mu cmd_scale:delete_scale_engine -b bots_10.10.6.200:1`
 
 **help**
 
 - Gets help for all cmd\_scale commands. 
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_scale:help`
 
 ***list***
 
 - Returns the current Scale Player's UUID. 
-- **`list`**
+- <b>`list`</b>
 - `mu cmd_scale:list`
 
 ***pcap***
 
 - Gets a pcap from a specific Scale Engine. 
-- **`pcap -b`** *`bot_id`* **`-f`** *`filename`*
+- <b>`pcap -b`</b> <em>`bot_id`</em> <b>`-f`</b> <em>`filename`</em>
 - `mu cmd_scale:pcap -b bots_10.10.6.200:1 -f bot_1_pcap`
 
 ***release***
 
 - Release the Scale Player. 
-- **`release`**
+- <b>`release`</b>
 - `mu cmd_scale:release`
 
 ***release\_scale\_engine***
 
 - Releases the specified Scale Engine. 
-- **`release_scale_engine -b`** *`bot_id`*
+- <b>`release_scale_engine -b`</b> <em>`bot_id`</em>
 - `mu cmd_scale:release_scale_engine -b bots_10.10.6.200:1`
 
 ***reserve\_scale\_engine***
 
 - Reserves the specified Scale Engine. 
-- **`reserve_scale_engine -b`** *`bot_id`*
+- <b>`reserve_scale_engine -b`</b> <em>`bot_id`</em>
 - `mu cmd_scale:reserve_scale_engine -b bots_10.10.6.200:1`
 
 ***session***
 
 - Create a new Scale Player session. 
-- **`session`**
+- <b>`session`</b>
 - `mu cmd_scale:session`
 
 ***start***
 
 - Start the Scale test. 
-- **`start -c`** *`scale-test`* **`-m`** *`user:pass@mu-ip`*
+- <b>`start -c`</b> <em>`scale-test`</em> <b>`-m`</b> <em>`user:pass@mu-ip`</em>
 - `mu cmd_scale:start -c scale.json -m admin:admin@10.10.2.2`
 
 ***status***
 
 - Gets information about the currently running Scale test. 
-- **`status`**
+- <b>`status`</b>
 - `mu cmd_scale:status`
 
 ***statuses***
 
 - Gets the status of all active and inactive Scale engines. 
-- **`statuses`**
+- <b>`statuses`</b>
 - `mu cmd_scale:statuses`
 
 ***stop***
 
 - Stops the Scale test. 
-- **`stop`**
+- <b>`stop`</b>
 - `mu cmd_scale:stop`
 
 ***update***
 
 - Update the pattern dynamically (while the Scale test is running). 
-- **`update -p`** *`parameter`* **`-pv`** *`parameter-value`*
+- <b>`update -p`</b> <em>`parameter`</em> <b>`-pv`</b> <em>`parameter-value`</em>
 - `mu cmd_scale:update -p delay -pv 250 -p volume -pv 100000`
 
 ***verify***
 
 - Verifies a Scale test. 
-- **`verify`**
+- <b>`verify`</b>
 - `mu cmd_scale:verify`
 
 ####Options <a id="cmd_scale_options"/>####
@@ -1087,48 +1091,48 @@ Use to access the legacy REST API for Scale tests (Studio Scale).
 
 > 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.
 
-[back to top ↑](#top)
+
 
 ###cmd\_homepage <a id="cmd_homepage"/>###
-#####» see [cmd_homepage options](#cmd_homepage_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
-Use to access information displayed on the Mu UI homepage, such as
-recent updates, backup status, or a list of latest test results.
+Use to access information displayed on the Mu UI homepage, such as recent updates, backup status, or a list of latest test results.
+
+» see [cmd_homepage options](#cmd_homepage_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
 
 ***all***
 
 - Gets the complete set of information displayed on the Mu home page. 
-- **`all`**
+- <b>`all`</b>
 - `mu cmd_homepage:all`
 
 ***help***
 
 - Gets help for all cmd\_homepage commands. 
-- **`help`**
+- <b>`help`</b>
 - `mu cmd_homepage:help`
 
 ***latest\_test***
 
 - Gets an array of the latest test results. 
-- **`latest_test`**
+- <b>`latest_test`</b>
 - `mu cmd_homepage:latest_test`
 
 ***queue\_test***
 
 - Gets an array of tests in the Test Queue. 
-- **`queue_test`**
+- <b>`queue_test`</b>
 - `mu cmd_homepage:queue_test`
 
 ***recent***
 
 - Gets the "What's New" section from the Mu homepage. 
-- **`recent`**
+- <b>`recent`</b>
 - `mu cmd_homepage:recent`
 
 ***status***
 
 - Gets system status for licenses, backup, and updates. 
-- **`status`**
+- <b>`status`</b>
 - `mu cmd_homepage:status`
 
 ####Options <a id="cmd_homepage_options"/>####
@@ -1149,29 +1153,30 @@ recent updates, backup status, or a list of latest test results.
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 ###cmd\_system <a id="cmd_system"/>###
-#####» see [cmd_system options](#cmd_system_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 Use to restart system services or to get status details for the Mu system.
 
+» see [cmd_system options](#cmd_system_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***restart***
 
 - Restart Mu system services (this does not reboot the appliance).
-- **`restart`**
+- <b>`restart`</b>
 - `mu cmd_system:restart`
 
 ***status***
 
 - Gets all information from the system status page. 
-- **`status`**
+- <b>`status`</b>
 - `mu cmd_system:status`
 
 ***status2***
 
 - Gets additional system information such as hard drive status, platform model, serial number. 
-- **`status2`**
+- <b>`status2`</b>
 - `mu cmd_system:status2`
 
 ####Options <a id="cmd_system_options"/>####
@@ -1192,41 +1197,42 @@ Use to restart system services or to get status details for the Mu system.
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 ###cmd\_cli <a id="cmd_cli"/>###
-#####» see [cmd_cli options](#cmd_cli_options) | » see [documentation format](#documentation_format) | » back to [top](#top)#####
 
 Use to access the Mu CLI.
 
+» see [cmd_cli options](#cmd_cli_options) | » see [documentation format](#documentation_format) | » back to [top](#top)
+
 ***cli\_help***
 
 - Get help for all cmd\_cli commands.
-- **`cli_help`**
+- <b>`cli_help`</b>
 - `mu cmd_cli:cli_help`
 
 ***cli\_history***
 
 - Display the command line history for the current session. 
-- **`cli_help`**
+- <b>`cli_help`</b>
 - `mu cmd_cli:history`
 
 ***ping***
 
 - Ping the specified IP address from the Mu system. 
-- **`ping -a`** *`ip-address`*
+- <b>`ping -a`</b> <em>`ip-address`</em>
 - `mu cmd_cli:ping -a 10.10.10.1`
 
 ***question***
 
 - Show the available CLI commands. 
-- **`question`**
+- <b>`question`</b>
 - `mu cmd_cli:question`
 
 ***traceroute***
 
 - Get the network route to a specified IP address from the Mu system. 
-- **`traceroute -a`** *`ip-address`*
+- <b>`traceroute -a`</b> <em>`ip-address`</em>
 - `mu cmd_cli:traceroute -a 10.10.10.1`
 
 ####Options <a id="cmd_cli_options"/>####
@@ -1247,7 +1253,7 @@ Use to access the Mu CLI.
 
 > Set the Logger::DEBUG level.
 
-[back to top ↑](#top)
+
 
 * * * * *
 ##Mu Gem Library Classes <a id="library"/>##
@@ -1298,7 +1304,7 @@ must pass the file contents encoded as a Ruby string. For example:
 	$log.level = Logger::INFO
 	api.get("hosts")
 
-[back to top ↑](#top)
+
 
 * * * * *
 

data/version.rb

@@ -1 +1 @@
-VERSION='5.7.36'
+VERSION='5.7.37'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mu
 version: !ruby/object:Gem::Version
-  version: 5.7.36
+  version: 5.7.37
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000Z
+date: 2012-03-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2162286860 !ruby/object:Gem::Requirement
+  requirement: &2169362860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *2162286860
+  version_requirements: *2169362860
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2162285640 !ruby/object:Gem::Requirement
+  requirement: &2169362140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2162285640
+  version_requirements: *2169362140
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &2162284220 !ruby/object:Gem::Requirement
+  requirement: &2169361380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '1.16'
   type: :runtime
   prerelease: false
-  version_requirements: *2162284220
+  version_requirements: *2169361380
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2162283140 !ruby/object:Gem::Requirement
+  requirement: &2169360280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2162283140
+  version_requirements: *2169360280
 - !ruby/object:Gem::Dependency
   name: hexy
-  requirement: &2162280600 !ruby/object:Gem::Requirement
+  requirement: &2169359460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2162280600
+  version_requirements: *2169359460
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &2162262640 !ruby/object:Gem::Requirement
+  requirement: &2169344600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2162262640
+  version_requirements: *2169344600
 description: ! "The Mu gem allows users to include Mu libraries within scripts\n    that
   interact with Mu appliance software. The gem also supplies command line interfaces\n
   \   to many of these same libraries"