Configuration Refresh
Overview
Universal Broker maintains the configuration files for all Universal Agent components, including itself. The components do not read their configuration files themselves (except for Universal Enterprise Controller, which does read its own configuration file).
At initial start-up, Universal Broker reads the configuration files of all components and places the configuration data in Universal Broker memory. When a component starts, it first registers with its local Universal Broker. As part of the registration process, Universal Broker sends that component's configuration data to the component. Thereafter, if a configuration file is modified, Universal Broker must be refreshed. This directs Universal Broker to re-read all component configuration files and update the configuration data in memory.
A Universal Broker is refreshed when any of the following occurs:
- Universal Broker is recycled (stopped and restarted).
- Universal Broker is refreshed via Universal Control.
- Universal Broker is refreshed via the I-Management Console UEC client application.
- Universal Broker is refreshed via Universal Configuration Manager (Windows only).
Then, when a component restarts, it again registers with its local Universal Broker, which sends that component's configuration data to the component.
Configuration Refresh via Universal Control
Universal Control refreshes the Universal Broker by issuing a configuration refresh request via its REFRESH_CMD configuration option.
The configuration refresh request directs Universal Broker to take the following actions:
Step 1 | Read all component configuration files, or the configuration file of a single, specified component, and update the configuration data in Universal Broker memory. (Currently, the only individual component that can be refreshed this way is the Universal Event Monitor Server, uems.) |
|---|---|
Step 2 | Read all component definitions (or only the component definition for uems) in the Component Definition directory. Universal Broker replaces all component definitions with the newly read component definitions. New component definitions are added and deleted component definitions are removed. |
Step 3 | Read the Universal Access Control List (UACL) configuration entries (or only entries for uems) from the registry. Universal Broker replaces its UACL entries with the newly read entries. |
Configuration Refresh via Universal Control for Universal Event Monitor Server
Because an event-driven Universal Event Monitor Server typically is a long-running process, the ability to refresh an active UEM Server's configuration and list of assigned event definitions is provided. Automatic refresh of configuration and event information for a demand-driven UEM Server is not supported; the values it obtains at start-up are the ones it uses throughout its lifetime.
When a change is made to the stored UEM Server configuration settings (see Configuration File), active event-driven UEM Servers must be notified that a change has taken place. This is done via Universal Control, using the Universal Control Manager REFRESH_CMD option, along with a component type value that identifies the component to refresh (see Refreshing via Universal Control Examples).
Windows
A request to update the configuration of local event-driven UEM Servers is issued automatically whenever a change is made to a UEM Server's configuration through the Universal Configuration Manager.
When Universal Control or the Universal Configuration Manager (Windows only) instructs an active event-driven UEM Server to refresh its cached configuration, the event-driven Server processes the request immediately.
The UEMLoad utility automatically notifies an event-driven UEM Server of an event definition change via a flag that resides in the local Universal Broker. UEM Server checks this flag every two minutes and updates its cached list of event definitions whenever UEMLoad updates them. This eliminates the need to refresh UEM Server with Universal Control following a database change.
Configuration Refresh via Universal Control for Universal Automation Center Agent
Since Universal Automation Center Agent (UAG) starts automatically when the Universal Broker starts, the ability to refresh an active Universal Automation Center Agent's configuration is provided.
When a change is made to the stored UAG configuration settings (see Configuration File), active UAG components must be notified that a change has taken place. This is done via Universal Control, using the Universal Control Manager REFRESH_CMD option, along with a component type value that identifies the component to refresh (see Refreshing via Universal Control Examples).
Windows
A request to update the configuration of UAG is issued automatically whenever a change is made to UAG configuration through the Universal Configuration Manager.
When Universal Control or the Universal Configuration Manager (Windows only) instructs UAG to refresh its cached configuration, UAG processes the request immediately.
The following UAG configuration file options are dynamically updated by Universal Control Manager REFRESH_CMD:
Option | Description |
|---|---|
Logging level of UAG. | |
Level of messages to write for UAG. | |
Activates user security. | |
Timeout period between CANCEL request and force termination. | |
Directory that UAG uses for trace files (MESSAGE_LEVEL option value is set to trace). | |
Maximum number of lines to write to the trace file. | |
Size of a wrap-around trace table maintained in memory. |
Additionally, the following UAG UACL file entry is dynamically updated by Universal Control Manager REFRESH_CMD:
Entry | Description |
|---|---|
Allows or denies access to a task execution request and if allowed, specifies whether or not user authentication is performed. |
Configuration Refresh via I-Management Console
When configuration options are updated using the I-Management Console, a configuration refresh request automatically is sent to Universal Broker, and its configuration data is refreshed.
The configuration refresh request directs Universal Broker to take the following actions:
Step 1 | Read all component configuration files and update the configuration data in Universal Broker memory. |
|---|---|
Step 2 | Read all component definitions in the Component Definition directory. Universal Broker replaces all component definitions with the newly read component definitions. New component definitions are added and deleted component definitions are removed. |
Step 3 | Read the Universal Access Control List (UACL) configuration entries from the registry. Universal Broker replaces its UACL entries with the newly read entries. |
Configuration Refresh via Universal Configuration Manager
When configuration options are updated using the Universal Configuration Manager, a configuration refresh request is sent to Universal Broker, and its configuration is refreshed automatically.
The configuration refresh request directs Universal Broker to take the following actions:
Step 1 | Read its configuration file. Universal Broker refreshes its configuration options. |
|---|---|
Step 2 | Read all component definitions in the Component Definition directory. Universal Broker replaces all component definitions with the newly read component definitions. New component definitions are added and deleted component definitions are removed. |
Step 3 | Read the Universal Access Control List (UACL) configuration entries from the registry. The Broker replaces its UACL entries with the newly read entries. |
Configuration Refresh of Universal Broker for its own Configuration Options
As with all Universal Agent components, all Universal Broker options can be modified by editing its configuration file (ubroker.conf) directly.
However, unlike other components, not all Universal Broker options can be modified via I-Management Console. (In I-Management Console, these Universal Broker options are read-only.). These options can be modified only by editing the Universal Broker configuration file, ubroker.conf. For these modifications to be updated in Universal Broker memory and take immediate effect, Universal Broker must be recycled.
All other Universal Broker options can be modified either:
- By editing ubroker.conf.
- Via I-Management Console.
- Via the Universal Configuration Manager.
Depending on the configuration option, for a modification to be updated in Universal Broker memory and take immediate effect:
- Universal Broker must be recycled.
- Universal Broker must be refreshed by issuing a Universal Control configuration refresh request (via the REFRESH_CMD configuration option), if the modifications are made in ubroker.conf.
- Universal Broker is refreshed automatically, if the modifications are made via I-Management Console or the Universal Configuration Manager.
For a list of the Universal Broker configuration options in each category, see Universal Broker Configuration Options Refresh.