SuggestGroupName
Note:
For more details, see
Note: Service group support can also be added via CSV file.
In this topic:
Syntax
sub SuggestGroupName
Description
This function is called for every change request, in which the work order contains a group of IP addresses/subnets or services that are not associated with a group name. It receives the change request as input, as well as the IP addresses/subnets or services (members) and an indication of whether the members are a source, destination, or service. It returns a suggested group name for the members.
Configuration
By default, this hook is not called. To configure the hook, complete the procedure below.
To enable the SuggestGroupName hook, use the generic procedure for overriding system defaults to set the configuration parameter SuggestGroupNamesInWorkOrder to the value 1. For details, see Override FireFlow system defaults.
Note: After setting this parameter, you must restart FireFlow for the change to take affect. See Restart FireFlow.
Input Parameters
$ticket |
A Perl hash reference containing a single key called flatTicket, which points to the flat ticket representation of the change request. For details, see Flat Ticket Examples. |
$trafficLineNumber |
The current traffic line in the change request. |
$trafficFieldType |
The IP addresses/subnets or services' function. This can have the following values:
|
Return Values
A suggested group name for the members.