maeEnableFaults
maeEnableFaults(
[ ?session t_sessionName ]
[ ?groupNamesList l_groupNamesList ]
[ ?ruleNamesList l_ruleNamesList ]
[ ?enable g_enable ]
[ ?enableAll g_enableAll ]
[ ?disableAll g_disableAll ]
)
=> list(libName cellName viewName) / nil
Description
Enables or disables the given fault rules and groups.
Arguments
|
?session t_sessionName
|
|
|
Name of a session.
Default: Current session
|
|
?groupNamesList l_groupNamesList
|
|
|
A space-separated list of fault group names that need to be enabled or disabled. It is mandatory to provide at least one of the two arguments, ?groupNamesList and ?ruleNamesList.
|
|
?ruleNamesList l_ruleNamesList
|
|
|
A space-separated list of fault group names that need to be enabled or disabled. It is mandatory to provide at least one of the two arguments, ?groupNamesList and ?ruleNamesList.
|
|
?enable g_enable
|
|
|
The enabled or disabled status to be set for the given list of faults or groups.
Default value: t
|
|
?enableAll g_enableAll
|
|
|
A Boolean value that specifies whether to enable all fault rules and groups in the active setup.
Default value: nil
You can set either ?enableAll or ?disableAll to t at the same time.
|
|
?disableAll t_disableAll
|
|
|
A Boolean value that specifies whether to disable all fault rules and groups in the active setup.
Default value: nil
|
Value Returned
|
t
|
When the specified rules and groups are enabled or disabled, as specified.
|
|
nil
|
In case of an error.
|
Example
The following example shows how to enable two fault rules and two groups:
maeEnableFaults(?ruleNamesList '("RB1" "ROT1") ?groupNamesList '("Group1" "Group2"))
=> t
The following example code disables two fault rules and a group:
maeEnableFaults(?ruleNamesList '("RB1" "RB2") ?groupNamesList '("grp1") ?enable nil)
t
Related Topics
Previewing Faults in a Fault Group
maeGetFaults
Return to top
