Page tree
Skip to end of metadata
Go to start of metadata

This page describes how to import and export zone, collector, and other types of configurations via Lumeta’s graphical user (GUI), Command-Line (CLI) and application programming (API) interfaces. This is one way you can back up your valuable settings. After importing a configuration, be sure to check your interface settings

A variety of configuration types can be successfully imported from either the Settings menu or the Admin menu:

Import from Settings MenuImport from Admin Menu
  • Collectors
  • Scout identifiers and connections
  • Notification subscriptions
  • Organizations
  • Report & Notification Schedules
  • Lumeta system connections
  • User-created device attributes/labels 
  • Users
  • Zones
  • User-created dashboard widgets
  • User-created dashboards 
  • User-created reports (aka report widgets) 


Importing Configurations via the Settings Menu 

  1. On the Lumeta GUI, browse to Settings > Support Tools > Import/Export System.

  2. Select a system configuration file on your local computer to import.


  3. Click Import.
    The configuration imports. Stay on the web page while the import takes place to avoid disrupting the import process.

    If you see the message "Not all remote systems could be imported. Collector interface, OSPF and leak configuration could be affected. Other components were successfully imported" this is likely due to remote systems being unreachable and hence not imported. Please check your configuration and verify your remote systems settings (Settings=>Lumeta Systems).

  4. Review the imported collector configurations in Settings > Zones > Zone Collectors and edit as needed.
    Be sure to check the interface of any leak scout you've set up. See About Importing Leak Path Configurations for the procedure.

  5. Reset collector interfaces:
    1. Browse to Settings > Zones.
    2. Select a zone name.
    3. Select a collector name.
    4. Click Edit to update a collector.
    5. Select an option from the Interface dropdown list.

  6. Enable the imported collectors.
    1. Select a collector name.
    2. Select a discovery-type tab (e.g., BGP, Path, Host)
    3. Click Edit to update the discovery type.
    4. Select the Enable checkbox to enable that type of discovery.

  7. Reset the passwords of imported user accounts. Existing user accounts are maintained.
    • Browse to Settings > Users.
    • Select a username requiring a password reset.
    • Click Edit User.
    • Update the Password and Confirm Password fields.
    • Click Update to save your changes.

  8. Renew the subscription to imported notifications and reset the priority-level for each.  The default notification settings are maintained. The system does not accept imported changes to the default notifications settings.
    • Browse to Settings > Notifications.
    • Select the Systems tab and an event type.
    • Update your preferences.
    • Click Update.
      Repeat this update for other system event types, as needed.
    • Select the Devices tab and an event type.
    • Update your preferences.
    • Click Update.

    Repeat this update for other device event types, as needed.

Importing Configurations via the Admin Menu 

  1. On the Lumeta GUI, browse to Admin > Settings > Import.

  2. Select a report, dashboard, or widget DDL configuration file from your local computer to import. 

  3. Click Import Metadata.
    The configuration imports. 

Importing a Collector Configuration via CLI

  • To import/restore configuration from a remote system, run:
    system configuration import username@hostname:<path to file>
  • To import/restore configuration from the local system, run:
    system configuration import <path to file

Importing via API

Import a configuration as follows:

  1. Run the following curl command, replacing <exported configuration file name> with the full path of the exported configuration file name and replacing <Lumeta-system> with the IP Address or DNS name of your Lumeta box.

    curl -k -u admin -d @<exported configuration file name> -H 'Content-Type: application/xml' 'https://<Lumeta-system>/api/rest/config/import'

The import should complete successfully.
If, however, you encounter the following error, it means that the remote systems to which you wanted to connect were unreachable and hence not imported. To resolve, check your configuration and verify your remote systems (Settings=>Lumeta Systems).

Not all remote systems could be imported. Collector interface, OSPF and leak configuration could be affected. Other components were successfully imported.</message><type>ApplicationException</type><detail>com.lumeta.api.core.client.exception.ApplicationException: Difficulty importing configuration:

Not all remote systems could be imported. Collector interface, OSPF and leak configuration could be affected. Other components were successfully imported.

Exporting Configurations via the Settings Menu

This section describes how to export zone, collector, and other types of configurations via Lumeta’s graphical user (GUI) and application programming (API) interfaces. When exporting data from one Command Center to another, user passwords are not preserved and must be reset at the new Command Center.

  1. Browse to Settings > Support Tools > Import/Export System.


  2. Click Export.
    The following configuration types export:
    • Collectors
    • Scout identifiers and connections
    • Notification subscriptions
    • Organizations
    • Report & Notification Schedules
    • Lumeta system connections
    • User-created device attributes/labels 
    • Users
    • Zones

    • Lumeta System Connections
    • Organizations
    • Zones
    • Collectors
    • Custom Attributes by Zone
    • Users
    • Notification Subscriptions

    The export file opens in a new tab on your preferred browser.

  3. Save the file to your local computer.
  4. Exporting Configurations via the Admin Menu 

    1. On the Lumeta GUI, browse to Admin > Settings > Export.

    2. Select a report, dashboard, or widget DDL configuration file from your local computer to export. 

    3. Click Export Metadata.
      The configuration exports. 

Exporting a Collector Configuration via CLI

  • To export/backup the configuration and save the file remotely, run:
    system configuration export username@hostname:<path to file>
  • To export the configuration and save the file locally, run:
    system configuration export <path to  file>

Exporting via API

  1. Enter the following API to the address bar of an Lumeta-supported browser:
    https://<CC IP Address>/api/rest/config/export
    Example:https://10.9.0.142/api/rest/config/export

  2. Save the file in XML format. Refer to the file export.xml for sample output. You can view or edit this sample in your preferred browser.



After an Import

Collector configuration and Leak Path configuration are disabled upon import.  This is by design to ensure that you first check the interface used by collectors and reset them, if necessary, to the ones you intend to use.

To check your the interface setting for a selected Collector:

  1. Navigate to Settings > Zones > Zone Collectors for your selected Zone.

  2. Click Edit > Interface.

     

  3. Select your preferred interface option from the dropdown.

  4.  Enable the collector.

Leak Path Interface

To check your the interface setting for a selected Leak Path Collector:

  1. Navigate to Settings > Zones  and select a Collector for which Leak Path is enabled.

  2.  Select Zone Collectors > Edit

  3. Select your preferred interface option from the dropdown and enable the Leak Path collector.
  • No labels
Write a comment...