Configuration UI
  • 22 May 2024
  • Dark
    Light
  • PDF

Configuration UI

  • Dark
    Light
  • PDF

Article summary

This article provides information on configuring the properties file for Itential Automation Gateway (IAG), including its web server, associated integrations, and custom content supplied by end users.

System Configuration

The System 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
04_Config_UI-2023.1

All configuration parameters, except those that reside in the System and Databases section of the properties file, can be modified via UI. Only properties in the UI that have a lock icon next to them can be changed via properties.yml. The changes made via UI take effect dynamically without rebooting the IAG server. Changes made to properties.yml do require a reboot. With RBAC, configuration changes are restricted to users who are members of the admin group.

Breaking changes to the data types of certain configuration parameters can be found here: IAG Breaking Changes in Product Notices.

Click here for the Configuration UI in an earlier version.

IAG 2022.1

01-ConfigUI

Backup Database

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. 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 properties.yml file. Those parameters are still modified by editing the properties file and restarting the server.

Save Config

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
02-SaveConfig

System Configuration

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
03-SystemConfig


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.