mu 5.7.35 → 5.7.36

data/README.md

@@ -0,0 +1,1305 @@
+#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`*):
+
+- *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.
+- *rest-client*. Used for HTTP calls.
+- *mime-types*. Required by REST-client.
+
+You also need to set the following Mu environment variables:
+
+- *MU\_IP*. Set the default IP address of the Mu management interface.
+- *MU\_ADMIN\_USER*. Set the default name of the admin user.
+- *MU\_ADMIN\_PASS*. Set the default admin user password.
+
+###Supported Command Types###
+
+- [Executables](#executables) are command-line applications are used for loading and verifying Scenarios, creating and running Test Sets, and configuring and running Scale tests.
+
+	-   [cmd\_appid](#cmd_appid)
+	-   [cmd\_runscale](#cmd_runscale)
+	-   [cmd\_runverify](#cmd_runverify)
+	-   [cmd\_runscenario](#cmd_runscenario)
+
+- [Legacy REST API Commands](#legacy) provide access to legacy REST API commands supported by the Mu system.
+
+	-   [cmd\_ddt](#cmd_ddt)
+	-   [cmd\_scale](#cmd_scale)
+	-   [cmd\_netconfig](#cmd_netconfig)
+	-   [cmd\_muapi](#cmd_muapi)
+	-   [cmd\_homepage](#cmd_homepage)
+	-   [cmd\_system](#cmd_system)
+	-   [cmd\_cli](#cmd_cli)
+
+- [API Library Classes](#library) can be ‘required’ and used within Ruby scripts
+(like most ruby gems).
+
+	-   [ddt](#ddt)
+	-   [scale](#scale)
+	-   [netconfig](#netconfig)
+	-   [muapi](#muapi)
+
+###Documentation Format	<a id="documentation_format"/>###
+
+Command documentation uses the format:
+
+***command***
+
+- description
+- syntax
+- example
+
+***options***
+
+**-command-short-name**/**--command-long-name** *parameter*
+
+> description
+
+
+* * * * *
+##Executables <a id="executables"/>##
+
+The following command-line applications are used for loading and
+verifying Scenarios, creating and running Test Sets, and configuring and
+running Scale tests.
+
+-   [cmd\_appid](#cmd_appid)
+-   [cmd\_runscale](#cmd_runscale)
+-   [cmd\_runverify](#cmd_runverify)
+-   [cmd\_runscenario](#cmd_runscenario)
+-   [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
+(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. 
+
+***help*** 
+
+- Gets help for all cmd\_appid commands. 
+- **`help`**
+- `mu cmd_appid:help`
+
+***run\_file*** 
+
+- Runs the specified .msl file. 
+- **`run_file -s`** *`msl-filename`*
+- `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`*
+- `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?`**
+- `mu cmd_appid:running?`
+
+####Options <a id="cmd_appid_options"/>####
+
+**-c**/**--csv** *csv-filename*
+
+> Specify the .csv filename with test cases to run.
+
+**-d**/**--dir** <directory\>
+
+> Specify the directory with .msl files to run (required for run\_dir).
+
+**-h**/**--help**
+
+> Get help on command line options.
+
+**-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`.
+
+**-m**/**--mu\_string** *user:pass@mu-ip*
+
+> Specify the user, password, and mgmt IP of the Mu system. Example: `admin:admin@10.9.8.7`.
+
+**-o**/**--output** <filename\>
+
+> Specify the filename to which you want to output logs.
+
+**-p**/**--pattern** <start:dur,end:dur\>
+
+> Specify pattern as concurrency-start:duration,concurrency-end:duration. Duration is in seconds. Example: `1-10000:60,10000-1:30`.
+
+**-s**/**--scenario** <msl-filename\>
+
+> Specify the .msl filename (required for run\_msl)
+
+**-t**/**--test**
+
+> Run a verification check only.
+
+**-v**/**--verbose**
+
+> 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.
+
+***help***
+
+- Gets help for all cmd\_runscale commands
+- **`help`**
+- `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`*
+- `mu cmd_runscale:run_file -s msl_file -i a1,dell-9 -p 1-100:30`
+
+***run\_dir***
+
+- 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`**
+- `mu cmd_runscale:run_dir -d msl_file_directory`
+
+***running?***
+
+- Gets status of the Scale player. 
+- **`running?`**
+- `mu cmd_runscale:running?`
+
+***run\_files***
+
+- Runs a Scale test for each .msl file in the specified directory
+(optionally, you can specify single .msl file). To include all .msl
+files in nested directories, use **-r** to perform a recursive directory
+search. 
+- **`run_file -d`** *`msl-directory`* **`-r -i`** *`interfaces,hosts`* **`-p`** *`pattern`*
+- `mu cmd_runscale:run_file -d msl_file_directory -r -i a1,dell-9 -p
+1-100:30`
+
+####Options <a id="cmd_runscale_options"/>####
+
+**-c/--csv** *csv-filename*
+
+> Specify the filename of the .csv file that contains the test cases to run.
+
+**-d/--dir** *directory*
+
+> Specify the directory that contains .msl files to run (required for run\_dir). Does not include nested directories.
+
+**-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.
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-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`.
+
+**-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`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-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`.
+
+**-r/--recursive**
+
+> Perform a recursive directory search. Use with run\_dir and run\_files to run Scale tests for all .msl files contained in nested directories.
+
+**-s/--scenario** *msl-filename*
+
+> Specify the .msl filename (required for run\_msl).
+
+**-t/--test**
+
+> Run a verification check only.
+
+**-v/--verbose**
+
+> 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.
+
+***help***
+
+- Gets help for all cmd\_runverify commands. 
+- **`help`**
+- `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`*
+- `mu cmd_runverify:run -s my_scenario -t my_testset -i a1,my-server`
+
+####Options <a id="cmd_runverify_options"/>####
+
+**-c/--channels** *hosts*
+
+> Specify channel hosts as a comma-separated list.
+
+**-d/--dir** *directory*
+
+> Specify the directory with Scenario templates to run.
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-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`.
+
+**-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`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-p/--options** *option:value*
+
+> Specify option/value pairs as a comma-separated list. Example: `user:jane,email:jsmith@itemp.com`.
+
+**-s/--scenario** *scenario-template*
+
+> Specify the Scenario template to run (must be xml).
+
+**-t/--testset** *testset-template*
+
+> Specify the Test Set template to run (must be xml).
+
+**-v/--verbose**
+
+> 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.
+
+***help***
+
+- Gets help for all cmd\_runscenario commands
+- **`help`**
+- `mu cmd_runscenario:help`
+
+***run***
+
+- Runs the specified Scenario template. 
+- **`run -s`** *`scenario.xml`* **`-i`** *`interfaces,hosts`*
+- `mu cmd_runscenario:run -s my_scenario -i a1,my-server`
+
+####Options <a id="cmd_runscenario_options"/>####
+
+**-c/--channels** *hosts*
+
+> Specify channel hosts as a comma-separated list.
+
+**-d/--dir** *directory*
+
+> Specify the directory with Scenario templates to run.
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-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`.
+
+**-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`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-s/--scenario** *scenario-template*
+
+> Specify the Scenario template to run (must be xml).
+
+**-v/--verbose**
+
+> 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
+format) suitable for import into Mu Studio.
+
+***help***
+
+- Gets help for all cmd\_musl commands. 
+- **`help`**
+- `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`* 
+- `mu cmd_musl:from_har --ignore-images -s my_scenario.msl
+my_har_file.har`
+
+***escape***
+
+- Escape special javascript characters ( $ , " , ' ) in the return payload
+of the .msl file. 
+- **`escape -s`** *`filename.msl`*
+- `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`*
+- `mu cmd_musl:bin2hex -s my_scenario.msl -o hex_string_file`
+
+####Options <a id="cmd_musl_options"/>####
+
+**-h/--help**
+
+> Get help on command line options.
+
+**--ignore-non-essentials**
+
+> Ignore unknown application files, Javascript (js) files, Cascading Style Sheet (css) files, and all image files.
+
+**--ignore-images**
+
+> Ignore image files.
+
+**--ignore-css**
+
+> Ignore CSS files.
+
+**--ignore-js**
+
+> Ignore Javascript (js) files.
+
+**--ignore-payload**
+
+> Ignore the content payload.
+
+**--strip-large-content**[*size*]
+
+> Replace large blocks of response content with a repeated field.
+
+**--skip-ssl-passthru**[*size*]
+
+> Skip all SSL transport options and structure as TCP.
+
+**-o/--output** *filename*
+
+> Specify the filename of the output file. For **escape** output, the output file is typically a .js file. For **bin2hex** output, you can assign the file extension of your choice.
+
+**-s/--scenario** *filename*
+
+> Specify the name of the msl file. When this option is not used in the command, the system uses the har filename as the msl filename.
+
+**-v/--verbose**
+
+> Set the Logger::DEBUG level.
+
+[back to top ↑](#top)
+
+* * * * *
+##Legacy API Commands <a id="legacy"/>##
+
+These commands provide access to legacy REST API commands supported by
+the Mu system.
+
+-   [cmd\_muapi](#cmd_muapi)
+-   [cmd\_netconfig](#cmd_netconfig)
+-   [cmd\_ddt](#cmd_ddt)
+-   [cmd\_scale](#cmd_scale)
+-   [cmd\_homepage](#cmd_homepage)
+-   [cmd\_system](#cmd_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).
+
+***help***
+
+- Gets help for all cmd\_muapi commands.
+- **`help`**
+- `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`*	
+	- `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`*
+ 	- `mu cmd_muapi:archive -c status -u 1296064526931`
+- To download the archive report: 
+	- **`archive -c get -u`** *`job-id`*
+	- `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`**
+	- `mu cmd_muapi:backup -c run`
+- To get the status of the backup job:
+	- **`backup -c status`**
+	- `mu cmd_muapi:backup -c status`
+- To download the backup file (requires a name):
+	- **`backup -c get -n`** *`filename`*
+	- `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`*
+- To start recording packets (this command returns the job-id):
+	- **`capture -c run -p`** *`port-number`*
+	- `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`*
+	- `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`*
+	- `mu cmd_muapi:capture -c get -p a1 -u 1296064526931`
+
+***delete***
+
+- Delete the specified Test Run or template
+- **`delete -u`** *`uuid`*
+- `mu cmd_muapi:delete -u 52add3cf-9040-42ce-b263-8233039931d5`
+
+***export\_by\_name***
+
+- Export the specified template. 
+- **`export_by_name -n`** *`name`* **`-t`** *`type`*
+- `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`**
+- `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`*
+- `mu cmd_muapi:get_name -u 52add3cf-9040-42ce-b263-8233039931d5`
+
+***list***
+
+- Get a list of templates by type. 
+- **`list -t`** *`template-type`*
+- `mu cmd_muapi:list -t monitor`
+
+***list\_by\_status***
+
+- Get a list of Test Runs by status. 
+- **`list_by_status -s`** *`status`*
+- `mu cmd_muapi:list_by_status -s finished`
+
+***list\_type***
+
+- Get a list of all template types. 
+- **`list_types`**
+- `mu cmd_muapi:list_types`
+
+***pause***
+
+- Pause a Test Run. 
+- **`pause -u`** *`uuid`*
+- `mu cmd_muapi:pause -u 52add3cf-9040-42ce-b263-8233039931d5`
+
+***resume***
+
+- Resume a Test Run. 
+- **`resume -u`** *`uuid`*
+- `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`*`]`
+- `mu cmd_muapi:run -u 52add3cf-9040-42ce-b263-8233039931d5 -b true`
+
+***status***
+
+- Get the status of a Test Run. 
+- **`status -u`** *`uuid`*
+- `mu cmd_muapi:status -u 52add3cf-9040-42ce-b263-8233039931d5`
+
+***stop***
+
+- Stop a Test Run. 
+- **`stop -u`** *`uuid`*
+- `mu cmd_muapi:stop -u 52add3cf-9040-42ce-b263-8233039931d5`
+
+####Options <a id="cmd_muapi_options"/>####
+
+**-b/--boolean** *value*
+
+> Specify a boolean value (true or false).
+
+**-c/--command** *command*
+
+> Specify the command to run (run, get, status, etc.)
+
+**-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`.
+
+**-n/--name** *name*
+
+> Specify a Test Run or template name.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-p/--port** *port-number*
+
+> Specify the port number.
+
+**-s/--status** *status*
+
+> Specify the status filter (running, finished, aborted queued, or failed)
+
+**-t/--type** *template-type*
+
+> Specify the type of template.
+
+**-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.
+
+**-v/--verbose**
+
+> 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.
+
+***help***
+
+- Gets help for all cmd\_netconfig commands. 
+- **`help`**
+- `mu cmd_netconfig:help`
+
+***clear\_hosts***
+
+- Remove all network hosts configured in the Mu system. 
+- **`clear_hosts`**
+- `mu cmd_netconfig:clear_hosts`
+
+***clear\_interface***
+
+- Clear settings for specified Mu interfaces. 
+- **`clear_interface -i`** *`interface,interface`*
+- `mu cmd_netconfig:clear_interface -i b1,b2`
+
+***clear\_routes***
+
+- Remove all user-configured routes in the Mu system.
+- **`clear_routes`**
+- `mu cmd_netconfig:clear_routes`
+
+***clear\_vlans***
+
+- Remove all vlans for all Mu interfaces. 
+- **`clear_vlans`**
+- `mu cmd_netconfig:clear_vlans`
+
+***create***
+
+- Create a network object such as a host or route. 
+- **`create -j`** *`object`* **`-e`** *`value`*
+- `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`*
+- `mu cmd_netconfig:delete -e Web-Server`
+
+***get***
+
+- Get details for a network object. 
+- **`get -e`** *`value`*
+- `mu cmd_netconfig:get -e a1`
+
+***modify***
+
+- Modify a network object such as a host or route. 
+- **`modify -j`** *`object`* **`-e`** *`value`*
+- `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`*
+- `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`*`]`
+- `mu cmd_netconfig:restore -f my_muhosts/web-server.json true`
+
+***save***
+
+- Save changes to the Mu system. 
+- **`save`**
+- `mu cmd_netconfig:save`
+
+####Options <a id="cmd_netconfig_options"/>####
+
+**-b/--boolean** *value*
+
+> Specify a boolean value (true or false).
+
+**-e/--element** *value*
+
+> Specify a value for the associated command. Example: `interfaces` or `interfaces/a1`.
+
+**-f/--filepath** *filepath*
+
+> Specify the path to a file.
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-i/--interfaces** *interface-or-host*
+
+> Specify Mu interfaces or network hosts as a comma-separated list. Example: `b1,web-server`.
+
+**-j/--json** *object*
+
+> Specify a json object as a text string.
+
+**-m/--mu\_string** *user*:*password*@*mu-ip*
+
+> Specify a user, password, and management IP of a Mu system. Example: `admin:admin@10.9.8.7`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-v/--verbose**
+
+> 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).
+
+***display\_results***
+
+- Displays results for the current Test Set. 
+- **`display_results`**
+- `mu cmd_ddt:display_results`
+
+***new\_session***
+
+- Create a new session. 
+- **`new_session`**
+- `mu cmd_ddt:new_session`
+
+***load\_scenario***
+
+- Load the specified Scenario template. 
+- **`load_scenario -u`** *`uuid`*
+- `mu cmd_ddt:load_scenario -u 52add3cf-9040-42ce-b263-8233039931d5`
+
+***get\_hosts***
+
+- Get a list of hosts in the Test Bed. 
+- **`get_hosts`**
+- `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`*
+- `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`**
+- `mu cmd_ddt:get_channels`
+
+***set\_channels***
+
+- Configure the channels in the Test Bed. 
+- **`set_channels -r`** *`role`* **`-n`** *`name`*
+- `mu cmd_ddt:set_channels -r SSH_Channel -n Web-Server`
+
+***get\_options***
+
+- Get a list of options in the Test Set. 
+- **`get_options`**
+- `mu cmd_ddt:get_options`
+
+***set\_options***
+
+- Configure the option values for the Test Set. 
+- **`set_options -n`** *`name`* **`-p`** *`value`*
+- `mu cmd_ddt:set_options -n username -p jsmith`
+
+***get\_sessions***
+
+- Get a list of all sessions. 
+- **`get_sessions`**
+- `mu cmd_ddt:get_sessions`
+
+***setup\_test***
+
+- Setup the Test Bed, reserving the Mu interfaces. 
+- **`setup_test`**
+- `mu cmd_ddt:setup_test`
+
+***run***
+
+- Run a Test Set. 
+- **`run`**
+- `mu cmd_ddt:run`
+
+***run\_testset***
+
+- Run the specified Test Set.
+- **`run_testset -u`** *`uuid`*
+- `mu cmd_ddt:run_testset -u 04aa248a-0b9b-4bf6-97e1-aab691d0acf1`
+
+***get\_testset\_results***
+
+- Get results for the current Test Set. 
+- **`get_testset_results`**
+- `mu cmd_ddt:get_testset_results`
+
+***get\_testset\_status***
+
+- Get status for the current Test Set. 
+- **`get_testset_status`**
+- `mu cmd_ddt:get_testset_status`
+
+***teardown\_test***
+
+- Unsets the Test Bed selections, releasing the Mu interfaces. 
+- **`teardown_test`**
+- `mu cmd_ddt:teardown_test`
+
+***close\_session***
+
+- Closes the current session. 
+- **`close_session`**
+- `mu cmd_ddt:close_session`
+
+***close\_all\_sessions***
+
+- Closes all existing sessions. 
+- **`close_all_sessions`**
+- `mu cmd_ddt:close_all_sessions`
+
+***csv\_export***
+
+- Exports a Test Set from the Mu system to a csv file. 
+- **`csv_export -u`** *`uuid`*
+- `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`*
+- `mu cmd_ddt:csv_import -t my-testset.csv`
+
+####Options <a id="cmd_ddt_options"/>####
+
+**-f/--filename** *filename*
+
+> Specify the template name for saving an imported Test Set.
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-m/--mu\_string** *user*:*password*@*mu-ip*
+
+> Specify a user, password, and management IP address of a Mu system. Example: `admin:admin@10.9.8.7`.
+
+**-n/--names** *name-array*
+
+> Specify host names or channel names in a comma-separated array. Example: `a1,Web-Server`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-p/--option\_values** *value-array*
+
+> Specify values for Test Set options in a comma-separated array. Example: `bob,jane,mary,tom`.
+
+**-r/--roles** *role-array*
+
+> Specify host roles in a comma-separated array. Example: `HTTP\_Client,HTTP\_Server`.
+
+**-t/--testset** *filename.csv*
+
+> Specify the name of the .csv file to import.
+
+**-u/--uuid** *uuid*
+
+> Specify the UUID of the Scenario or Test Set.
+
+**-v/--verbose**
+
+> Set the Logger::DEBUG level.
+
+**-y/--type** *type*
+
+> 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).
+
+***about***
+
+- Lists information for the Scale Player and all active and inactive Scale Engines. 
+- **`about`**
+- `mu cmd_scale:about`
+
+***configure***
+
+- Configure parameter values for any element of the scale json object. 
+- **`configure -p`** *`parameter`* **`-pv`** *`value`*
+- `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`*
+- `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`*
+- `mu cmd_scale:delete_scale_engine -b bots_10.10.6.200:1`
+
+**help**
+
+- Gets help for all cmd\_scale commands. 
+- **`help`**
+- `mu cmd_scale:help`
+
+***list***
+
+- Returns the current Scale Player's UUID. 
+- **`list`**
+- `mu cmd_scale:list`
+
+***pcap***
+
+- Gets a pcap from a specific Scale Engine. 
+- **`pcap -b`** *`bot_id`* **`-f`** *`filename`*
+- `mu cmd_scale:pcap -b bots_10.10.6.200:1 -f bot_1_pcap`
+
+***release***
+
+- Release the Scale Player. 
+- **`release`**
+- `mu cmd_scale:release`
+
+***release\_scale\_engine***
+
+- Releases the specified Scale Engine. 
+- **`release_scale_engine -b`** *`bot_id`*
+- `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`*
+- `mu cmd_scale:reserve_scale_engine -b bots_10.10.6.200:1`
+
+***session***
+
+- Create a new Scale Player session. 
+- **`session`**
+- `mu cmd_scale:session`
+
+***start***
+
+- Start the Scale test. 
+- **`start -c`** *`scale-test`* **`-m`** *`user:pass@mu-ip`*
+- `mu cmd_scale:start -c scale.json -m admin:admin@10.10.2.2`
+
+***status***
+
+- Gets information about the currently running Scale test. 
+- **`status`**
+- `mu cmd_scale:status`
+
+***statuses***
+
+- Gets the status of all active and inactive Scale engines. 
+- **`statuses`**
+- `mu cmd_scale:statuses`
+
+***stop***
+
+- Stops the Scale test. 
+- **`stop`**
+- `mu cmd_scale:stop`
+
+***update***
+
+- Update the pattern dynamically (while the Scale test is running). 
+- **`update -p`** *`parameter`* **`-pv`** *`parameter-value`*
+- `mu cmd_scale:update -p delay -pv 250 -p volume -pv 100000`
+
+***verify***
+
+- Verifies a Scale test. 
+- **`verify`**
+- `mu cmd_scale:verify`
+
+####Options <a id="cmd_scale_options"/>####
+
+**-b/--bot-id** *scale-engine-id*
+
+> Specify a Scale Engine using its bot-id value.
+
+**-c/--config-file** *json-filename*
+
+> Specify a .json file that contains the configuration data.
+
+**-f/--filename** *pcap-filename*
+
+> Specify a name for the .pcap file.
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-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`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-p/--params** *parameters*
+
+> Specify parameters for initial configuration or for update. Supports delay and volume parameters.
+
+**-ps/--view\_position** *value*
+
+> Specify the position in the timeline view for which to return data. At this time, only position 0 is supported.
+
+**-pv/--param\_value** *value*
+
+> Specify a value for a parameter.
+
+**-v/--verbose**
+
+> Set the Logger::DEBUG level.
+
+**-w/--view** *view*
+
+> Specify the view (RUNTIME or CALLGRAPH) for which to return data.
+
+**-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.
+
+[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.
+
+***all***
+
+- Gets the complete set of information displayed on the Mu home page. 
+- **`all`**
+- `mu cmd_homepage:all`
+
+***help***
+
+- Gets help for all cmd\_homepage commands. 
+- **`help`**
+- `mu cmd_homepage:help`
+
+***latest\_test***
+
+- Gets an array of the latest test results. 
+- **`latest_test`**
+- `mu cmd_homepage:latest_test`
+
+***queue\_test***
+
+- Gets an array of tests in the Test Queue. 
+- **`queue_test`**
+- `mu cmd_homepage:queue_test`
+
+***recent***
+
+- Gets the "What's New" section from the Mu homepage. 
+- **`recent`**
+- `mu cmd_homepage:recent`
+
+***status***
+
+- Gets system status for licenses, backup, and updates. 
+- **`status`**
+- `mu cmd_homepage:status`
+
+####Options <a id="cmd_homepage_options"/>####
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-m/--mu\_string** *user*:*password*@*mu-ip*
+
+> Specify a user, password, and management IP address of a Mu system. Example: `admin:admin@10.9.8.7`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-v/--verbose**
+
+> 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.
+
+***restart***
+
+- Restart Mu system services (this does not reboot the appliance).
+- **`restart`**
+- `mu cmd_system:restart`
+
+***status***
+
+- Gets all information from the system status page. 
+- **`status`**
+- `mu cmd_system:status`
+
+***status2***
+
+- Gets additional system information such as hard drive status, platform model, serial number. 
+- **`status2`**
+- `mu cmd_system:status2`
+
+####Options <a id="cmd_system_options"/>####
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-m/--mu\_string** *user*:*password*@*mu-ip*
+
+> Specify a user, password, and management IP address of a Mu system. Example: `admin:admin@10.9.8.7`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-v/--verbose**
+
+> 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.
+
+***cli\_help***
+
+- Get help for all cmd\_cli commands.
+- **`cli_help`**
+- `mu cmd_cli:cli_help`
+
+***cli\_history***
+
+- Display the command line history for the current session. 
+- **`cli_help`**
+- `mu cmd_cli:history`
+
+***ping***
+
+- Ping the specified IP address from the Mu system. 
+- **`ping -a`** *`ip-address`*
+- `mu cmd_cli:ping -a 10.10.10.1`
+
+***question***
+
+- Show the available CLI commands. 
+- **`question`**
+- `mu cmd_cli:question`
+
+***traceroute***
+
+- Get the network route to a specified IP address from the Mu system. 
+- **`traceroute -a`** *`ip-address`*
+- `mu cmd_cli:traceroute -a 10.10.10.1`
+
+####Options <a id="cmd_cli_options"/>####
+
+**-h/--help**
+
+> Get help on command line options.
+
+**-m/--mu\_string** *user***:***password***@***mu-ip*
+
+> Specify a user, password, and management IP address of a Mu system. Example: `admin:admin@10.9.8.7`.
+
+**-o/--output** *filename*
+
+> Specify the filename to which you want to output logs.
+
+**-v/--verbose**
+
+> Set the Logger::DEBUG level.
+
+[back to top ↑](#top)
+
+* * * * *
+##Mu Gem Library Classes <a id="library"/>##
+
+These API library classes can be required and used within Ruby scripts (like most ruby gems).
+
+###muapi <a id="muapi"/>##
+
+	require 'rubygems'
+	require 'mu'
+	api = Mu::Muapi.new(“*mu-ip*”,”*user*”,”*pass*”)
+	$log.level = Logger::INFO
+	api.list_by_status("running")
+
+###ddt <a id="ddt"/>###
+
+	require 'rubygems'
+	require 'mu'
+	api = Mu::Ddt.new(“*mu-ip*”,”*user*”,”*pass*”)
+	$log.level = Logger::INFO
+	api.new_session
+
+###scale <a id="scale"/>###
+
+	require ‘rubygems’
+	require ‘mu’
+	api = Mu::Scale.new(“*mu-ip*”,”*user*”,”*pass*”)
+	$log.level=Logger::INFO
+	api.configure(musl, *scenario.msl*)
+	api.configure(csv, *testset.csv*)
+	api.configure(pattern, *pattern.json*)
+
+For each file type (*scenario.msl*, *testset.csv*, *pattern.json*) you
+must pass the file contents encoded as a Ruby string. For example:
+
+	muslString = File.open(‘*scenario.msl*’, ‘r’, {|f| f.read}
+	api.configure(musl, muslString)
+	api.start
+	api.status
+	api.stop
+	api.release
+
+###netconfig <a id="netconfig"/>###
+
+	require 'rubygems'
+	require 'mu'
+	api = Mu::Netconfig.new(“*mu-ip*”,”*user*”,”*pass*”)
+	$log.level = Logger::INFO
+	api.get("hosts")
+
+[back to top ↑](#top)
+
+* * * * *
+
+Copyright 2012 Mu Dynamics Inc., All Rights Reserved.