Engine Configuration Sync Workflow - User Guide - LiveWire

Navigating to the Engine Configuration Sync UI

To navigate to the LiveWire Engine Configuration Sync UI:

Select the hamburger menu in the top-left corner of the LiveWire UI.
Under Workflows, select Engine Configuration Sync.

The Engine Configuration Sync feature is expressed as a wizard in the Engine Configuration Sync view consisting of the following steps:

Choose Engines
Choose Configuration
Review & Confirm
Progress
Complete

1. Choose Engines

The first step in the Engine Configuration Sync workflow is to choose the target engines to which the configuration items will be pushed.

In this step, you must select which engines to push the configuration settings to. The list of engines is populated from the engines you provide in the LiveWire multi-engine manager.

After selecting the engines from the list, click the Next button to proceed to the next step in the wizard. You must select at least 1 engine. Additionally, you may select the Use the same credentials for all engines checkbox and configure the credentials by clicking the Set Credentials button. Otherwise, the saved credentials for each engine will be used.

You may filter the engine list by typing in the search box.

2. Choose Configuration

In this step, you must select which configuration settings to push to the engines selected in the previous step. After selecting the configurations from the list, click the Next button to proceed to the next step in the wizard. You must select at least 1 configuration setting. Additionally, you may check the Remove all capture data on selected engines when pushing captures checkbox to delete all capture sessions and packet files from the target engine when pushing captures. The blue boxes display information that may be informative to you.

Global Operations

There are 3 button operations that are global:

Do not sync all- When clicked, all configuration items will have their status changed to the Do not sync option and will not be pushed to the selected target engines.
Sync all- When clicked, all configuration items will have their status changed to the Sync option and will be pushed to the selected target engines.

Note: The Next button allowing the user to continue to Step 3 of the Engine Configuration Sync workflow will remain disabled until you select at least 1 configuration item to sync.

Alarms

Alarms have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of alarms (Sync selected). When the Sync selected option is selected, a list box of all alarms will be displayed underneath, allowing you to choose a subset using the checkboxes next to each alarm. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all alarms, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Captures

Captures have the capability of pushing nothing (Do not sync), everything (Sync), or a selected subset of features (Sync selected). When the Sync selected option is selected, a list box of all captures will be displayed underneath, allowing you to choose a subset using the checkboxes next to each capture. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all captures, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Note: If the LiveFlow Capture is pushed then the LiveFlow configuration will also be pushed.

Decryption Keys

Decryption Keys have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of decryption keys (Sync selected). When the Sync selected option is selected, a list box of all decryption keys will be displayed underneath, allowing you to choose a subset using the checkboxes next to each decryption key. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all decryption keys, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Engine Settings

Engine Settings have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of engine settings (Sync selected). When the Sync selected option is selected, a list box of all engine settings will be displayed underneath, allowing you to choose a subset using the checkboxes next to each engine setting. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all engine settings, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Expert Settings

Expert Settings have the capability of pushing nothing (Do not sync) or everything (Sync), and does not support pushing a selected subset of expert settings (Sync selected).

Filters

Filters have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of filters (Sync selected). When the Sync selected option is selected, a list box of all filters will be displayed underneath, allowing you to choose a subset using the checkboxes next to each filter. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all filters, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Graphs

Graphs have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of graphs (Sync selected). When the Sync selected option is selected, a list box of all graphs will be displayed underneath, allowing you to choose a subset using the checkboxes next to each graph. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all graphs, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Name Table

The Name Table has the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of graphs (Sync selected). When the Sync selected option is selected, a list box of all graphs will be displayed underneath, allowing you to choose a subset using the checkboxes next to each graph. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all graphs, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Notifications

Notifications have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of graphs (Sync selected). When the Sync selected option is selected, a list box of all graphs will be displayed underneath, allowing you to choose a subset using the checkboxes next to each graph. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all graphs, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

Protocol Translations

Protocol Translations have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of graphs (Sync selected). When the Sync selected option is selected, a list box of all graphs will be displayed underneath, allowing you to choose a subset using the checkboxes next to each graph. Enable all and Disable all buttons will be provided below the list box to allow you to select all or deselect all graphs, respectively. This list box, Enable all button, and Disable all button will only be visible when the Sync selected option is selected. If you change the status to Do not sync or Sync, and then back again to Sync selected, any items previously selected in the list box will be remembered and selected.

SNMP Settings

SNMP Protocols have the capability of pushing nothing (Do not sync), everything (Sync) or a selected subset of graphs (Sync selected).

3. Review & Confirm

In this step, you must confirm which engines, selected from step 1, will receive the configuration settings selected from step 2, by checking the appropriate checkbox in the Name column. The table will display the list of engines selected from step 1. Each row in the table represents an engine along with its engine version. Additionally, the Configuration column specifies which configurations will be pushed to the engine, as specified in step 2.

If due to access control restrictions a configuration item cannot be synced to the specified engine, it will be displayed as strikethrough text and will not be synced.

Engine configuration can only be synced between engines of the same version. For any engines in the table that have versions that do not match the source engine, the entire row representing that engine will be disabled and unselectable.

After selecting the engines from the list, click the Next button to proceed to the next step in the wizard. You must select at least 1 configuration setting. The blue boxes display information that may be informative to you.

The Configuration column in the review table has changed in LiveWire 26.1.0. The column still lists the configuration items that will be synced but after each item, the number of items that will be pushed is displayed in one of the following three ways:

If you selected the Do not sync status option, the configuration items will not be displayed. This was the behavior in previous versions.
If you selected the Sync status option, indicating that all items should be pushed, an (all) suffix is added to the configuration items. For example, if you chose the Sync status option for Alarms, the Alarms (all) status is displayed.
If you selected the Sync selected status option, indicating that selected items should be pushed, a (X selected) suffix is added to the configuration items, where X is the number of items that will be pushed. For example, if you chose the Sync selected status option for Filters and selected 2 items, the Alarms (2 selected) status is displayed.

4. Progress

In this step, you will see the progress of configuration items being pushed to target engines. When the sync status is running, you will see a spinner in the right-most area of the engine row. The progress is representative of the following sequence: running, success or error.

The Configuration column in the review table has changed in LiveWire 26.1.0. The column still lists the configuration items that will be synced but after each item, the number of items that will be pushed is displayed in one of the following three ways:

If you selected the Do not sync status option, the configuration items will not be displayed. This was the behavior in previous versions.
If you selected the Sync status option, indicating that all items should be pushed, an (all) suffix is added to the configuration items. For example, if you chose the Sync status option for Alarms, the Alarms (all) status is displayed.
If you selected the Sync selected status option, indicating that selected items should be pushed, a (X selected) suffix is added to the configuration items, where X is the number of items that will be pushed. For example, if you chose the Sync selected status option for Filters and selected 2 items, the Alarms (2 selected) status is displayed.

When the sync status is complete, you will see either a green check for success or a red X for error in the right-most area of the engine row. If the red X for error is displayed, you can hover over the icon with your mouse and see detailed error information.

5. Complete

In this step, you can see the result of the sync operation for each engine. Each target engine that had configuration pushed to it will be displayed in the table. The Configuration column will display the results for each configuration item pushed along with some actions the user can perform. You will see either a green checkbox for success or a red X for error immediately to the left of each configuration, letting you know the push status for each configuration. If the red X for error is displayed, you can hover over the icon with your mouse and see detailed error information. You can also click the Details link next to a configuration to see detailed messages about the push for that configuration, or click the download icon to download those detailed messages to a CSV file. The Configuration column in the review table has changed in LiveWire 26.1.0. The column still lists the configuration items that attempted to sync but after each item, the number of items that had been pushed is displayed in one of the following three ways:

If you selected the Do not sync status option, the configuration items will not be displayed. This was the behavior in previous versions.
If you selected the Sync status option, indicating that all items should be pushed, an (all) suffix is added to the configuration items. For example, if you chose the Sync status option for Alarms, the Alarms (all) status is displayed.
If you selected the Sync selected status option, indicating that selected items should be pushed, a (X selected) suffix is added to the configuration items, where X is the number of items that will be pushed. For example, if you chose the Sync selected status option for Filters and selected 2 items, the Alarms (2 selected) status is displayed.

You may also download all detailed messages for all engines and all configurations by clicking on the Download All Details button, which will download all detailed messages to a CSV file.

Click the Finish button to go back to the beginning of this Engine Configuration Sync wizard.