Description

The GROUPS option specifies a list of groups to which an ADD or DELETE option will be applied. Universal Brokers (supplied on the command line or in a definition file) are added or deleted from this list of groups.

If GROUPS is not specified on the command line, ADD or DELETE processing is performed for the Universal Broker definitions themselves.

Add Action

The Add action behaves as follows:

1. When a fully qualified broker definition is specified on the command line (that is, broker_name, broker_host, and broker_port):
   1. An attempt is made to add the broker definition to the UEC database.
   2. If the GROUPS option also is specified on the command line, an attempt is made to add the specified broker to each group in the groups list.
2. When a partial broker definition is specified on the command line along with the GROUPS option:
   1. A list of broker definitions from the UEC database that matches the command line broker values is returned from the UEC database.
   2. An attempt is made to add each broker in the returned broker list to each group in the specified groups list.
3. When a broker definition file is specified on the command line:
   1. An attempt is made to add each broker definition in the definition file to the UEC database.
   2. For each broker definition in the definition file that contains a GROUPS option, the following processing will be performed:
      If the broker definition was successfully added to the UEC database, an attempt will be made to add the specified broker to each group in the groups list.
   3. If the GROUPS option is specified on the command line, the command line groups value is applied to each broker definition in the definition file, overriding the groups option specified in any individual broker definition.

Also, using -deffile file and specifying the GROUPS option on the command line constrains the ADD action to only adding broker definitions to groups. New broker definitions are added to the UEC database. Therefore, only broker definitions in the definition file that already exist in the UEC database will be added to the specified groups list.

If a broker definition in the definition file does not exist in the database, UECLoad will write an error message to inform the user and continue processing the definition file.

If the broker definition already exists in the UEC database, an attempt will be made to add the specified broker to each group in the groups list. In this case the ADD action will be constrained.

Delete Action

The Delete action behaves as follows when the GROUPS option is specified on the command line:

1. When a broker definition (partial or complete) is specified on the command line along with the GROUPS option:
   1. A list of broker definitions from the UEC database that match the command line broker values is returned from the UEC database.
   2. An attempt will be made to delete each broker in the returned broker list from each group in the specified groups list.
2. When a broker definition file is specified on the command line along with the GROUPS option:
   1. An attempt will be made to delete each broker in the definition file from each group in the groups list specified on the command line.

If a broker definition in the definition file contains a groups option, it will be ignored.

Export Action

The Export action includes the GROUPS option as part of the broker definition. For each broker definition that is exported, a GROUPS option will be included if the broker is associated with groups other than the default "All Brokers" group.

Usage

Values

groupslist is a comma-separated list of groups either to which the Agent is added or from which the Agent is removed or exported. (The All Agents group is implied; it does not have to be included in the list.)

To specify a comma that is part of a group name, enter two consecutive commas. For example, to include Atlanta, GA in list of groups, specify:

-groups "GroupA,GroupB,Atlanta,, GA,GroupC"

If a single Agent definition is being added, deleted, or exported via the command line, an attempt will be made to add the Agent to, or delete / export the Agent from, each group in groupslist. If a group in the list does not exist, an error message is written and processing continues with the next group in the list. (If -groups is not specified, the All Agents group is used.)

If a definition file is being processed, an attempt will be made to add all Agents in the definition file to, or delete / export all Agents in the definition file from, each group in groupslist. If a group in the list does not exist, a warning message will be written and processing will continue with the next group in the list.