AppsConfiguration ManagerGolden Configurations

Manage Golden Configurations

Previously in the Itential Platform, if a Golden Configuration with the same name already existed and you attempted to import a new one, you would get an error. This limitation is now removed in the UI, thereby enabling you to manage Golden Configs in Configuration Manager through a set of actions that will enhance how you handle the standard by which your devices should be configured.

Import Golden Configs

When importing Golden Configurations, certain characteristics and behaviors occur if you do not pass in an extra property with each tree. These include:

  • If the name is a duplicate, a unique index is used, such as GC Name (1)
  • If the name is not a duplicate, then the original name is used in the export, such as GC Name
  • Devices are not imported
  • Task instances are imported

To import a Golden Configuration:

2

Open Collection dialog

Select the Search icon (top toolbar) to display the Collection dialog.

3

Select Golden Configurations tab

Select the Golden Configurations tab.

ForItential Platform 2023.1 andItential Platform 2023.2 only.

4

Import file

Click the Import icon in the upper-left of the Collection dialog to open your file manager.

Downloads folder
5

Select files

Locate and select the Golden Configurations that you want to import (represented as JSON files).

6

Confirm import

Confirm you want to import the file. A notification banner displays in the upper-right upon successful file import.

If the file is a duplicate, an import dialog will open and prompt you to overwrite the existing version or rename it.

Golden Config import dialog

Export Golden Configs

Use the following steps to export a Golden Configuration for import:

1

Open Configuration Manager

Log in to Itential Platform to open the home page and click Configuration Manager under Operation in the left navigation menu to open the application.

2

Open Collection dialog

Select the Search icon (top toolbar) in Configuration Manager to display the Collection dialog.

3

View Golden Configurations

Select the Golden Configurations tab from the Collection window to display all the card options.

Golden Configurations Collection tab
4

Select and export

Select the checkbox at the bottom of each Golden Configuration you want to export and then click the Export icon (upper-left).

Select and export Golden Configuration
5

Confirm export

A message box appears asking you to confirm the export of the selected configurations. Click Okay.

Confirm export
6

Download file

The output file format is JSON. A download of the export file is shown in your browser. Once the download is complete, locate the export file in the downloads folder and perform an import.

Export file output JSON

Overwrite Golden Configs

When overwriting Golden Configurations, certain behaviors occur if you pass the overWrite: true property with each tree. These behaviors are as follows:

  • The entire Golden Configuration is replaced except for devices and task instances
  • Versions in the current Golden Configuration that do not exist in the imported Golden Configuration are deleted
  • Versions in the imported Golden Configuration that exist but are not available in the current Golden Configuration are added

To overwrite a Golden Configuration:

2

Open Collection dialog

Select the Search icon (top toolbar) to display the Collection dialog.

3

Select Golden Configurations tab

Select the Golden Configurations tab.

4

Import file

Click the Import icon in the upper-left of the Collection dialog to open your file manager.

5

Select file to overwrite

Locate and select the primary file that you want to overwrite with a secondary file of the same name.

  • Cisco 3650 - User FW was imported as a primary file
  • Cisco 3650 - User FW in the Downloads folder is the secondary file
Open file from download folder
6

Confirm overwrite

Click Open. A warning message appears indicating the primary file already exists.

Import dialog warning
7

Complete overwrite

Click Overwrite. The primary file is overwritten. A success banner appears in the upper-right of the Collections window showing the overwritten file.

Overwrite success banner

Rename a Golden Configuration

When renaming Golden Configurations, certain behaviors occur if you pass the newName": "some gc name" property. These behaviors are as follows:

  • The Golden Configuration is imported with a new name
  • If that new name already exists, the new name is indexed as New GC Name (1)
  • Devices are not imported
  • Task instances are imported

To rename a Golden Configuration:

2

Open Collection dialog

Select the Search icon (top toolbar) to display the Collection dialog.

3

Select Golden Configurations tab

Select the Golden Configurations tab.

4

Import file

Click the Import icon in the upper-left of the Collection dialog to open your file manager.

Downloads folder
5

Select file to rename

Select the Golden Configuration that you want to rename. In the example, JSON is the file to rename.

JSON file
6

Open warning dialog

Click Open. A warning message appears indicating the file already exists.

Warning dialog
7

Rename file

Rename the file name directly in the error message by clicking on the name (for example, JSON to JSON Copy). Notice that the error message and the Overwrite button changes to Rename instead.

Rename file
8

Complete rename

Click Rename. A success banner appears and the original JSON and the newly named JSON Copy file are displayed in the Collections window.

Success confirmation

Use the import API in Golden Configuration

This section provides backend developer information for importing, overwriting, and renaming Golden Configurations. Here are the parameters for calling the API:

1{
2    "trees": [
3        {
4            "data": [{treeVersion1}, {treeVersion2}],
5            "overwrite": true
6        },
7        {
8            "data": [{treeVersion1}, {treeVersion2}],
9            "newName": "New GC Name"
10        },
11        {
12            "data": [{treeVersion1}, {treeVersion2}]
13        }
14    ],
15    "options": {}
16}

Each element in the trees array represents a Golden Configuration. Within each Golden Configuration, the data array represents each version that belongs to a Golden Configuration. For example, if a Golden Configuration has three versions, then the data array is going to have three objects inside of it for each version. Essentially, the payload is saying to import three Golden Configurations and each of those three Golden Configurations has two versions each.

To import a Golden Configuration, you can just pass in the import data and nothing else. It will:

  • Either import the tree normally, assuming it’s not a duplicate
  • Index the name if it is a duplicate in which a tree name already exists (for example, if a tree called IOS Tree already exists then it will import as IOS Tree (1))

Overwrite property

To overwrite for a Golden Configuration, you have to pass the overwrite: true property.

Renaming property

To rename a Golden Configuration, you have to pass in the newName property.