Class Mu::Muapi
In: lib/mu/api/muapi.rb
Parent: Object

Methods

archive   backup   capture   delete   export_by_type_and_name   export_by_uuid   get_faults   get_name   list   list_by_status   new   pause   resume   run   status   stop   types  

Included Modules

Helper

Attributes

docroot  [RW] 
expected_error  [RW] 
host  [RW] 
job_id  [RW] 
params  [RW] 
password  [RW] 
posted_uuid  [RW] 
run_uuid  [RW] 
username  [RW] 

Public Class methods

Public Instance methods

archive(command="run", id=@run_uuid)

performs archive operations 

  * command=run to create a test archive
  * command=status to view the status of a test archive job
  * command=get to download a test archive job
  * uuid = the uuid of the test
backup(command="run", name="")

performs backup operations 

 * command=run to create a system backup file.
 * command=status to view the status of a backup job. If no backup job is running, gets the date of the most recent backup.
 * command=get to retrieve the backup file
 * name = backup file name
capture(command='run', port='a1', id=@job_id)

packet capture operations 

  * command=run to start capturing packets on the specified Mu appliance port
  * command=status tp view the status of packet capture activity
  * command=get to download the pcap file generated during packet capture
  * port = the Mu appliance port
  * id = job_id for status and get commands
delete(uuid=@run_uuid)

deletes the specified test 

 * uuid = the uuid of the test
export_by_type_and_name(type, name)

exports a template from the Mu system using the template type and template name 

 * name = the template name
export_by_uuid(uuid)

exports a template from the Mu system using the template uuid 

 * uuid = the template uuid
get_faults(uuid=@run_uuid)

returns a list of faults from the specified test 

 * uuid = the uuid of the test
get_name(uuid=@run_uuid)

returns the name of an test 

  * uuid = the uuid of the test
list(type)

lists the templates on the Mu system using the template type and template name: 

 * type = the template type, such as 'scenario' or 'monitor'
list_by_status(status="")

lists the statuses of tests 

 * status = the status type, such as 'running' or 'failed'
pause(uuid=@run_uuid)

pauses a running test 

 * uuid = the uuid of the test
resume(uuid=@run_uuid)

resumes a suspended test 

 * uuid = the uuid of the test
run(uuid, rename="")

starts a test 

 * uuid = the uuid of the test
status(uuid=@run_uuid)

returns the status of a test 

 * uuid = the uuid of the test
stop(uuid=@run_uuid)

stops a running test 

 * uuid = the uuid of the test
types()

lists the types of templates on the Mu system

[Validate]