Configuration Management Commands

Configuration management commands are used to manage dynamic configurations of an UltraESB instance or a cluster of UltraESB instances. This section describes each and every command in the configuration management category.

The commands of UTerm under configuration management are;

Add or update configuration

Add or update configuration command adds new configuration or update an existing configuration via a dynamic sub context of an UltraESB instance or a cluster of instances. The short form of the command is 'cau' which is equivalent to calling it's long form 'config-add-or-update'

Available options for the add or update configuration command are described in the following table.

To invoke this command the '-f' option is mandatory, which provides the file name to look for configurations to be added or updated.

This command is useful in updating the configuration of a production UltraESB cluster or a single instance without any down time, yet the transition being completely graceful (live updates of the UltraESB).

Note Once this command is invoked it result in the previously running configuration to be stale after some time (after completing the processing of all the messages accepted by this configuration) this consumes a little it of memory and hence, you could use the config-purge-all command to remove these stale configurations.

Purge all configurations

Purge all configurations command removes old stale configurations of an UltraESB instance or a cluster of instances. The short form of the command is 'cpa' which is equivalent to calling it's long form 'config-purge-all'

Available options for the purge all configurations command are described in the following table.

To remove stale configurations which are being stacked due to execution of config-add-or-update command, use this command. This command removes all the stale configuration at the execution point. The execution of this command should be done after making sure all the messages accepted by the configuration before the last update.

This command is useful in removing stale configurations of a production UltraESB cluster to gain a little bit of memory.

Best Practice - Purge as late as possible after an update As a best practice, make sure to give the previous configuration a good long time to complete its messages, after an update. A configuration shouldn't take much memory, so it is OK to purge even after a day or just before the next update.

Unload configuration

Unload configuration command unloads an existing live configuration of an UltraESB instance or a cluster of instances. The short form of the command is 'cu' which is equivalent to calling it's long form 'config-unload'

Available options for the unload configuration command are described in the following table.

To invoke this command the '-f' option is mandatory, which provides the file name to look for the child configuration (dynamic sub context) to be unloaded. How ever, if you have only one child configuration in the UltraESB, you may get rid of having to type in file name by using the config-unload-all command, which unloads all the child configurations of the UltraESB instance.

This command is useful in unloading a particular configuration of an UltraESB cluster or a single instance in an integration environment.

Unload all configurations

Unload all configurations command unloads all the existing live child configurations of an UltraESB instance or a cluster of instances. The short form of the command is 'cua' which is equivalent to calling it's long form 'config-unload-all'

Available options for the unload all configurations command are described in the following table.

To unload all the child configurations in an integration environment for testing purposes this command can be used. You may also unload configurations one by one, if you have more than one configurations with the config-unload command.