Actions on Rulebase Repository Configuration Objects
Hawk Console contains a rulebase repository that stores configuration objects and then distributes and deploys them to Hawk agents. The configuration objects include rulebases, schedules, and rulebase map.
Rulebase Repository Configuration Objects Files
You must configure the repository in Hawk Console by using the hawk_console_repository_path environment variable. Hawk Console loads and saves configuration objects in the repository at <hawk_console_repository_path>/< domain_name>. Hawk Console stores the configuration objects in the following files:
Hawk Console Actions
The following table lists the effect of the action performed on the Hawk Console to the configuration objects:
| Event / Action | Effect on Rulebase Map | Effect on Rulebase | Effect on Schedule |
|---|---|---|---|
| Hawk Console starts up | Hawk Console loads rulebase mapping and agent groups from the rbmap.hrm file present in the rulebase repository. | Hawk Console loads all rulebase files from the rulebase repository. | Hawk Console loads schedules from the schedules.hsf file present in the rulebase repository. |
| Hawk agent starts up | If the agent group for Hawk agent operating system is not present, Hawk Console adds a new agent group to the list of operating system groups of the rulebase repository. | Hawk Console deploys rulebases to the respective Hawk agent based on the rulebase mapping. | Hawk Console deploys all the schedules from the rulebase repository to the Hawk agent. |
| Create and save a new rulebase or schedule | Not applicable | The Hawk Console adds the new rulebase to the rulebase repository and saves it to a
.hrb file.
What to do next: To deploy the new rulebase to Hawk agents, you must create a rulebase mapping for it, see Creating Rulebase Mapping. |
Hawk Console adds a new schedule to the rulebase repository and saves it to the
schedule.hsf file.
What to do next: To deploy this new schedule to all Hawk agents in the domain, on the Schedules tab, click the Deploy Schedule icon and confirm the action. |
| Update and save an existing rulebase or schedule | Not applicable | The Hawk Console updates the rulebase in the rulebase repository and saves the update to the respective
.hrb file.
What to do next: To deploy the updated rulebase to all mapped Hawk agents, on the Rulebase Mapping tab, click Save Mapping for the rulebase. |
Hawk Console updates the schedule in the rulebase repository and saves the update to the
schedule.hsf file.
What to do next: To deploy this updated schedule to all Hawk agents in the domain, on the Schedules tab, click the Deploy Schedule icon and confirm the action. |
| Delete a rulebase | Hawk Console removes all the rulebase mappings for the rulebase and updates the rbmap.hrm file. | Hawk Console deletes the rulebase file (.hrb) from the rulebase repository. If the deleted rulebase was mapped to Hawk agents or agent groups, then these mapped rulebases are undeployed from Hawk agents after they are restarted. | Not applicable |
| Delete a schedule | Not applicable | Not applicable | Hawk Console deletes the schedule from the rulebase repository and the schedule.hsf file. If the deleted schedule was deployed to Hawk agents or agent groups, then these schedules are undeployed from Hawk agents after they are restarted. |
| Create and save a rulebase mapping | Hawk Console adds rulebase mapping to the rulebase repository and updates the rbmap.hrm file. | Hawk Console deploys the rulebase to the mapped Hawk agents and agent groups. | Not applicable |
| Update and save existing rulebase mapping | Hawk Console updates rulebase mapping in the rulebase repository and updates the rbmap.hrm file. | If Hawk agents or agent groups are added to the rulebase mapping, Hawk Console deploys the rulebase to new members.
If Hawk agents or agent groups are removed from the rulebase mapping, Hawk Console undeploys the respective rulebase from those Hawk agents or members of agent group. |
Not applicable |
| Create a new agent group | Hawk Console creates an agent group in memory only.
What to do next: To save the agent group information in the rbmap.hrm file, either add Hawk agents to the agent group or map the group to a rulebase. For details, see Creating Agent Groups and Creating Rulebase Mapping. |
Not applicable | Not applicable |
| Add new Hawk agents to the agent group and save the agent group mapping | Hawk Console updates the group mapping information in the rbmap.hrm file in the rulebase repository. | If the agent group is already mapped to rulebases, then these mapped rulebases are not automatically deployed to new agents.
What to do next: To deploy the mapped rulebase to new Hawk agents, on the Rulebase Mapping tab, click Save Mapping for the rulebases that are mapped to the updated agent group. |
Not applicable |
| Remove Hawk agents from the agent group and save the agent group mapping | Hawk Console updates the group mapping information in the rbmap.hrm file in the rulebase repository. | If the agent group is already mapped to rulebases, then these mapped rulebases are not automatically undeployed from the removed Hawk agents.
What to do next: To undeploy the mapped rulebases from the removed Hawk agents, on the Rulebase Mapping tab, click Save Mapping for those mapped rulebases. |
Not applicable |
| Delete an agent group | Hawk Console deletes the agent group from the rulebase repository and updates the rbmap.hrm file. | If the deleted agent group was mapped to rulebases, then these mapped rulebases are undeployed from Hawk agents after they are restarted. | Not applicable |