Specify Outcome Code(s) to shut down COPIAFACTS
$kill_group changroup outcome number
This command specifies one or more fax transmission outcome codes which will cause COPIAFACTS to shut down the channels and/or the node if they occur consecutively more than number times in the specified channel group. The count is reset if any other outcome occurs in the channel group.
There is a limit (currently 16) to the number of permitted active $kill_group commands. The count only includes channel groups which have members in the node.
The parameters on this command are used as follows:
| changroup | The channel group to be monitored. If the group spans multiple CopiaFacts nodes, the channels in each node will be monitored as a separate entity. |
| outcome | Up to eight outcome codes to be tested (as listed in CF9.SMR). Use a comma-separated list if more than one, in which case a sequence consisting of any of these outcome codes (and no others) will cause the trigger. |
| number | The number of consecutive occurrences of any of the outcome values which must be exceeded to trigger the shutdown. The value must be 0 or positive. |
When the kill group is triggered in a node, all the channel in the group in that node are taken out of service. They can only be re-activated by restarting the COPIAFACTS engine. Then, if control variable KILL_GROUP_ACTION is defined in FAXFACTS.CFG, its filename contents are used to launch an action: if the file extension is .FS, it is copied to TOSEND, and if its extension is .CMD, .EXE or .BAT, it is executed, passing a single parameter containing the nodename. This action can be used to notify an operator of the failure, or to shut down the node by calling KILLFF from a workerbox.
If there is no defined action, or the action fails, or if taking the channel out of service left no channels in the node operational, the node is shut down. OMACHECK should then activate if enabled.
This command can be used to shut down a CopiaFacts node in the event of a catastrophic failure such as a complete T1 or E1 going down. In this case the appropriate outcome code(s) can be specified to prevent faxes failing and force them to be transmitted on another node.
Examples:
To shut down on the 25th consecutive 'no loop current' or 'silent line' outcome for Brooktrout:
$kill_group T1 "259,328" 24 ; shut down on 25th consecutive 259 or 328 code
To shut down EITHER if there are five consecutive outcomes of 7311 in the monitored channel group SIP, with NO other outcomes mixed in among them; OR if there are five consecutive outcomes of 7010 in the monitored group, with NO other outcomes mixed in among them (but not if there are a mix if 7311 and 7810 occurring, however many there are):
$kill_group SIP 7311 5
$kill_group SIP 7810 5
To shut down if there are five consecutive outcomes of EITHER 7311 OR 7810 in the monitored group with NO other outcomes mixed in among them:
$kill_group SIP "7311,7810" 5
