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

Export

This section describes how to export configurations, subscriptions, schedules and some user-created elements via Lumeta’s graphical user (GUI), command-line (CLI), and application programming (API) interfaces. It also includes how to export user-created device attributes/labels and user-created queries from the Lumeta GUI only.

Exporting Configurations via Lumeta GUI

What does not export

  1. User passwords and integration credentials are not preserved and must be reset at the new Command Center
  2. User-created queries (i.e., custom queries) cannot be exported in bulk. They can, however, be individually exported. Jump to Exporting User-Created Queries on this page for the procedure.

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

  2. Click Export.
    The following configuration types export:
    • Collectors (including SNMP and Cloud credentials)
    • Lists (Target, Eligible, Known, Internal, Avoid, Stop)
    • Notification subscriptions
    • Organizations
    • Report schedules
    • Notification schedules
    • Lumeta system connections
    • User-created dashboard widgets
    • User-created dashboards
    • User-created device attributes/labels
    • User-created reports (aka report widgets)
    • Users (but not user passwords)
    • Zones

    The export file opens in a new tab on your preferred browser. 
    Note: The default behavior is to display the export file on a new tab. Save the display (i.e. File > Save) to your system and note the filename and location because you'll need the file again later. As an aside, you can change the default behavior of most browsers, but the details on that are outside the scope of this procedure. 

  3. Save the file to your local computer.

  4. OPTIONAL: To export user-created device attributes/labels via GUI, browse to Settings > Zones > Custom Attributes.

    1. Select the attributes to download.
    2. Click Download
      The attributes are saved to your local system as a txt file.

  5. OPTIONAL: To individually export user-created queries (i.e., custom queries)
    1. Browse to Search > Advanced Queries.
    2. Select the user-created query export.
    3. Click Open and if prompted, enter its associated response format (e.g., string, boolean) and specify the zone to which the query should be applied.
    4. Run the query by clicking Run Search
    5. Click the down arrow icon next to Save Query.
    6. Click Export.
    7. Indicate to which format (i.e., CSV, JSON, NDJSON) you'd like the export file saved.
    8. Click OK
      The query is exported to your local system.
    9. Repeat this procedure to export any other user-created queries you'd like to save off-line. 

  6. OPTIONAL: Later, when you open your new "warm spare" Command Center, all of the collectors will be disabled. You may find it helpful to have a report like this one, that shows the enabled/disabled status of all collectors on your primary Command Center so you can quickly match them on your new box.


To generate this report,

    1. Browse to Search > Advanced Queries.
    2. Select any query.
    3. Paste this Collector Status query in the query editor.
    4. Click Run
    5. Save as a new query called "Collector Status" so that you can run the saved query whenever you want.

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 a Collector Configuration 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.

Import

Restore the exported items to your "warm spare" Command Center by importing the system configuration and attributes files.

Don't forget to upload the license to your new "warm spare" Command Center. 

See Deployment to review the full installation procedure for Lumeta. 

Importing Configurations via Lumeta GUI

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

  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. To import user-created device attributes/labels via GUI, browse to Settings > Zones > Custom Attributes.

  5. Click Upload.

  6. Upload an attributes.txt file from your local system.

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.

Validate

  1. 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.

  2. Reset collector interfaces:
    Note: If you generated a Collector Status report, you'll be able to make use of it here.
    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.

  3. 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.

  4. 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.

  5. 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.


  • No labels