- 10 Mar 2023
- Updated on 10 Mar 2023
This guide provides information pertaining to configuring the properties file for Itential Automation Gateway (IAG). This entails configuration for its web server, associated integrations, and custom content supplied by end users.
The Configuration user interface (UI) is used to administer IAG properties. The UI provides a simple and straightforward way to view and modify the IAG server configuration.
Figure 1: Configuration UI
All configuration parameters except those that reside in the System and Databases section of the properties file can be modified via the UI. The changes take effect dynamically without rebooting the IAG server. With the introduction of RBAC in the 2021.2 release, configuration changes are restricted to users who are members of the admin group.
⚠ Note: Breaking changes have been made to the data types of certain configuration parameters. To learn more, refer to IAG Breaking Changes in Product Notices.
The IAG server configuration is saved in the database,
automation-gateway.db. Therefore, it is very important to take a backup of this file before doing any upgrades. During the first boot of the server, the configuration parameters found in the properties file are injected into the database. This applies to both newly created property files as well as pre-2021.2 property files being utilized to upgrade to 2021.2. All subsequent reboots of the server will use the configuration stored in the database. Any changes to the configuration parameters after the first server boot are required to be made from the Configuration UI. The only exception to this paradigm are parameters found in the System and Databases sections of the 2021.2 properties file. Those parameters are still modified by editing the properties file and restarting the server.
To modify the configuration for a subsystem, (i.e., Ansible, Nornir, Scripts), click the appropriate subsystem needed in the left sidenav menu and edit the properties (Ansible is used in the example below). Once changes are ready to be saved, click the save icon button on the top left corner and verify the success dialog appears on the top right corner of the page.
Figure 2: Save Config UI
The System Configuration menu option is read-only. The page is only to be used to view System Configuration parameters and cannot be edited.
Figure 3: System Configuration UI