wfcommand (4.2)
- Jenni Wallin
Usage
usage: wfcommand <pattern matching expression for workflow name> <'Workflow' | workflow service | agent> <instructions> ...Debug
The debug command cannot be sent to a specific agent, it is only functional on a workflow level.
To turn debug on for a workflow:
wfcommand <workflow> Workflow debug onTo turn the debug for a workflow off:
wfcommand <workflow> Workflow debug off Aggregation and Diameter agents
The Aggregation and Diameter agents allow the user to interact with the flow of data via the wfcommand. For further information, see Aggregation(4.2) and Diameter(4.2).
GTP agent
The GTP agent allows the user to view the MIM counters via the wfcommand. For further information, see GTP'(4.2).Â
The request counters and the timestamp, which are published as MIM values are also possible to view from the commandline tool.
Syntax to run the wfcommand function in mzcli:mzcli wfcommand <Workflow Name> <Agent Name> printcounters
Parameters
Parameter | Description |
| Name of the workflow which contains the GTP agent. |
| Name of the GTP agent in the workflow. |
Example - Executing the wfcommand
Supervision
By stating the Supervision service you can select to trigger and clear supervision actions with the wfcommand command.
If you want to use the wfcommand to trigger the Supervision service, you can append the following instructions:
manual which has the following syntax:Usage:Â
manual [-action actionName actionParameters]Simply entering manual will deactivate the Supervision Service configurations and switch to manual mode, which means that no conditions will be evaluated and no actions will be executed.
When using theÂ
-action option, the syntax will be as follows:Usage:Â
manual -action overload ( <ratio> | -trigger | -clear ) [strategy]
Options
Option | Description |
|---|---|
ratio | If you want to trigger overload and reject a specific ratio of incoming requests, e g reject every fifth request, you can enter the ratio number here. 2 equals every second request, 5 equals every fifth request, etc. |
-trigger | Use this option if you want to trigger overload for everything. An event will then be sent out for monitoring purposes. This will disable the automatic Supervision configuration. |
-clear | Use this option if you want to clear overload for everything. Any Diameter/Radius overload protection strategies will be cleared and no requests will be rejected. The automatic Supervision configuration will then be disabled. Note!Using this option will not enable the automatic Supervision configuration. |
[strategy] | Use this option to state a specific Diameter/Radius strategy, e g Diameter_AbortSessionRequest, Diameter_CCEventRequest, etc. |
automatic is used to revert to automatic Supervision configuration.
When switching from automatic to manual mode, all active overload protection will remain active. However, in the opposite direction, when switching from manual to automatic mode, all active overload protection will be reset and the appropriate overload protection will be set by the automatic rules.
Each time you switch between manual and automatic mode, an entry will be logged in the System Log for monitoring purposes.
Example - Trigger Overload Protection
To trigger overload protection for a workflow:
An event will then be sent out for monitoring purposes.
To clear overload protection for a workflow:
To reject every fifth Diameter AbortSessionRequest in a workflow:
To switch back to automatic mode:
See Supervision Service (4.2)Â for more information.
Return Codes
Listed below are the different return codes for the wfcommand:
Code | Description |
|---|---|
1 | Will be returned if command-line arguments are missing. |
2 | Will be returned if no matching workflows can be found, or if the workflow is not running. |
3 | Will be returned if the target agent cannot be found, or if the agent is not accepting/supporting the command. |
Â