FailureSimulationAccess

class FailureSimulationAccess
Add(failureSimulationKey, failureSimulationFile='', failureSimulationPort='')

Adds a failure simulation

Parameters:
failureSimulationKey : str

Name of the failure simulation to add

failureSimulationFile : str

Name of the failure simulation file

failureSimulationPort : str

Name of the failure simulation port

Returns:

The failure simulation which was added

Return type:

FailureSimulation

Clone()

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

FailureSimulationAccess

Delete(failureSimulationKey)

Deletes a failure simulation.

Parameters:
failureSimulationKey : str

Name of failure simulation to delete

Get(failureSimulationKey)

Returns the failure simulation object specified by the given key.

Parameters:
failureSimulationKey : str

Name of the failure simulation

Returns:

The failure simulation object

Return type:

FailureSimulation

GetAll()

Returns a list of the names of all the failure simulations.

Returns:

List of names of all failure simulations

Return type:

list[str]