The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages expected in November 2026. We hope you enjoy the updated experience.

Managing NDR appliance configurations

Prev Next

The NDR CLI Configuration menu allows you to easily manage and maintain your NDR appliance configuration settings. You can manually back up and restore your NDR appliance configuration settings, view a log of all configuration files stored on your appliance, and upload or transfer your backup configuration settings to another NDR appliance. The table below defines each configuration command.

Configuration Commands

Description

configuration apply

Apply the current configuration settings to your NDR appliance, regenerate managed files, and restart services.

configuration delete

Delete a specified configuration file from your NDR appliance.

configuration fetch

Transfer a configuration file from a specified remote URL to your NDR appliance. The configuration file url or the source configuration filename is required to complete the fetch.

configuration load

Load a specified configuration file to your NDR appliance without applying configuration changes.

configuration switch-to

Switch to a specified configuration file stored on your NDR appliance.

configuration upload

Transfer a specified configuration file from your NDR appliance to a specified remote URL. The configuration file url or the source configuration filename is required to complete the transfer.

configuration write

Back up the current configurations to a file on your NDR appliance.

show configuration files

Show the configuration files available on the NDR appliance.

Backing Up a Configuration File

The configuration write command allows you to back up the current configurations on your NDR appliance by creating a tar.xz file and storing it on the NDR appliance. This file stores the NDR appliance keys necessary for communicating with other NDR appliances and the OpenVPN, the PX appliance keys required for ssh tunnel, rsync, and acm communication, and the customized user content.

Important

You cannot merge backup user account configurations with existing user-account configurations already established on your NDR appliance. You can only apply backup user account configurations to a clean NDR appliance.

To back up the current NDR appliance configuration:

  1. Log in to the NDR as npadmin using the NDR IP address or FQDN. For example:

    $ ssh npadmin@10.1.0.1

    or

    $ ssh npadmin@exampleFQDN

  2. Enter privileged mode:

    npadmin@ia> enable

  3. Enter the npadmin password. The password can be 5 to 24 characters long.

    [sudo] password for npadmin: <password>

  4. Enter configuration mode:

    npadmin@ia# configure system

Restoring a configuration file

If your NDR appliance experiences a system failure the Configuration menu allows you to restore your configuration settings, regenerate managed files, and restart the NDR services. You can also switch to a different configuration file stored on your NDR appliance and apply the new settings.

To restore the NDR appliance configuration:
  1. Enter configure system mode:

    npadmin@ia# configure system

  2. Enter configuration apply to reset the current configuration:

    npadmin@ia(config)# configuration apply

To switch to a different configuration file to your NDR appliance:
  1. Enter configure system mode:

    npadmin@ia# configure system

  2. To load and apply a specific configuration file, enter configuration switch-to and the filename:

    npadmin@ia(config)# configuration switch-to <filename>

    Note

    The configuration filename is required in the command. For example, configuration switch-to ia1-20010104.tar.xz.

Viewing stored configuration files

The NDR appliance can store multiple configuration files and make them available to access and apply at any time. You can view a log record of the configuration files saved on your NDR appliance and details about each file, including the filename, a file modification timestamp, file size, and MD5 hash.

To view the configuration files on your NDR appliance:
  1. Enter configure system mode:

    npadmin@ia# configure system

  2. Enter the show configuration file command to view all of the configuration files on your system:

    npadmin@ia(config)# show configuration files

Deleting configuration files

You can delete configuration files on your appliance that are no longer in use.

To delete a configuration file:
  1. Enter configure system mode:

    npadmin@ia# configure system

  2. Enter configuration delete and the configuration filename:

    npadmin@ia(config)# configuration delete

    Note

    The configuration filename is required in the command. For example, configuration delete ia1-20010104.tar.xz.

Loading and modifying a configuration file

You can load, review, and modify the settings in a specific configuration file before applying the configurations to your NDR appliance.

To load a configuration file:

disrupted.

Do you want to review network settings before proceeding? (y/n)?

Important

Modifying the NDR appliance network settings may cause communication disruptions.

Save Settings [y/n]? y

  1. Enter configure system mode:

    npadmin@ia# configure system

  2. Enter configuration load and the configuration filename:

    npadmin@ia(config)# configuration load <filename>

    Note

    The configuration filename is required in the command. For example, configuration delete ia1-20010104.tar.xz.

  3. Enter y to review the network settings:

  4. Press Enter through each network setting to keep the saved value or enter a new value and press Enter.

  5. Enter y to save the new configuration settings:

  6. Press Enter to save and exit.