--- title: "Distributed search" slug: "distributed-search-2" tags: ["Install and Get Started", "NDR 4.x", "Customer", "Network Security"] updated: 2026-11-17T09:22:39Z published: 2026-11-17T09:22:39Z canonical: "docs.trellix.com/distributed-search-2" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # Distributed search Distributed search enables you to search across multiple NDR devices and retrieve PCAP data from multiple PX packet capture appliances. Distributed search requires one NDR appliance set up as the director node and other NDR appliances set up as the data nodes. This setup is similar to the NDR cluster setup. See [Clusters](/network-and-platform/docs/getting-started-with-trellix-ndr-5). ![](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/NDR_Distributed_Search_V2.png?sv=2026-02-06&spr=https&st=2026-11-19T12%3A14%3A33Z&se=2026-11-19T13%3A14%3A33Z&sr=c&sp=r&sig=2r9bc19dqsQ39WI430OTPbKCVyypaA%2FfSCW4VSBOB10%3D) *Distributed Search* | Distributed Search Components | Definitions | | --- | --- | | Director node | An NDR appliance that is a centralized location from which to initiate distributed searches to the data nodes. The director node does not collect metadata directly from NDR data nodes or PX appliances but can pull PCAP from any connected PX appliance. > [!NOTE] > Note > > By default, all NDR appliances are configured as a master data node. Use the CLI to change your NDR appliance master data node configuration to a director. | | Primary data node | An NDR appliance that is connected to one PX appliance and one or more NDR data nodes or multiple PX appliances and one or more NDR data nodes. The master data node collects metadata from connected PX appliances and shares the data load across the connected NDR data nodes. | | Data node | NDR appliances connected to the Master Data Node and used to store and search metadata. | In distributed search, multiple NDR appliances, known as NDR clusters, operate independently. NDR director nodes query these devices. This approach relies on Elasticsearch tribe nodes to operate. To configure NDR for distributed search, open the following ports on any firewall between the data nodes and the director node: - TCP 22 on both sides. - TCP and UDP 1194 on both sides. ### Converting an NDR series appliance to a director node Converting an NDR appliance to a director node erases Elasticsearch data, and the appliance becomes an aggregation unit. Perform this procedure on the NDR Series appliance that you want to convert to a director node. > [!WARNING] > Caution > > Converting a Trellix NDR console to a director node is irreversible. You cannot revert an appliance to standard console mode without performing a factory default reset. Running a factory default reset permanently erases all system configurations, search indexes, and collected data. To convert an NDR Series appliance into a director node in the CLI: 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` 5. Enter director mode: `npadmin@ia# director` 6. Select **y** to confirm that you want to convert the appliance into a director node. 7. Select **y** to configure the OpenVPN. This process might take 2 minutes. Your NDR appliance is now a director node. You must add master data nodes to the configuration. See [Adding data nodes to the director node](/network-and-platform/docs/distributed-search-2#adding-data-nodes-to-the-director-node). ##### Revert a director node to a standard console To convert a director node back to a standard Trellix NDR console, you must perform a factory default reset. > [!WARNING] > Warning > > Executing a factory default reset permanently deletes all data, logs, and configurations from the appliance. Back up critical data before proceeding. **Prerequisites:** You must have administrative access credentials (npadmin) to the CLI. 1. Log in to the Trellix NDR console CLI as **npadmin**. 2. Enter privileged mode: **enable** 3. Enter the npadmin password. 4. Enter configuration mode: **configure system** 5. Run the factory default reset command: **make-factory-defaults** 6. Confirm the system prompt to clear all appliance data and restore factory default settings. ##### Director menu options reference When you enter director configuration mode (**enable** > **configure system** > **director**), the CLI displays the director menu options. ![NDR_images_Direcor_menu.png](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/uuid-8e7e0b69-1746-26b0-2c31-c8a5de609072(3).png?sv=2026-02-06&spr=https&st=2026-11-19T12%3A14%3A33Z&se=2026-11-19T13%3A14%3A33Z&sr=c&sp=r&sig=2r9bc19dqsQ39WI430OTPbKCVyypaA%2FfSCW4VSBOB10%3D) The following table describes all available options in the director menu: | Menu Option | Description | | --- | --- | | **#: Data Nodes** | Displays all data nodes currently connected to the director node. | | **#: Delete Data Node** | Removes the selected data node from the director node configuration. | | **A: Add Data Node** | Adds a data node or cluster master to the director node configuration package. | | **S: Configure Openvpn Subnet** | Defines the subnet from which an IP address is allocated to the OpenVPN tunnel interface on a connected master node. Each director node requires a distinct subnet. | | **I: Configure Openvpn ServerID** | Specifies the unique server identification IP address of the director node for OpenVPN client connections. | | **P: Configure Openvpn Protocol** | Specifies the transmission protocol for OpenVPN traffic (**udp** or **tcp**). | | **C: Cancel without saving changes** | Discards all uncommitted menu edits and exits director configuration mode. | | **Q: Quit and save changes** | Commits all configuration changes and exits director configuration mode. | ### Converting an NDR Series Appliance into a Data Node Converting an NDR Series appliance to a data node stops indexing and Elasticsearch while the change takes effect. Perform this procedure on the NDR Series appliance that you would like to convert to a data node. To convert an NDR Series appliance to a data node: 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` 5. Enter data node: `npadmin@ia# datanode` 6. Select **a**, and then enter the director node's IP address. 7. You will see messages about validation and then OpenVPN and PX_ACM restarting. 8. You will see a confirmation screen: `Currently part of tribe node setup...` ### Adding data nodes to the director node You must add the data nodes to the director node. Perform this procedure on the director node. To add data nodes to the director node: 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` 5. Enter director mode: `npadmin@ia# director` 6. Select `a` to add a data node. 7. Enter the cluster name that you want to join: `clus-1` 8. Enter the cluster master hostname. This must be a FQDN or an eth0 IPv4 address. `10.128.33.249` 9. Enter the cluster network subnet in CIDR notation. Press enter if adding single-host cluster. `2.2.2.0/8 Validation 2.2.2.0/8 against` > [!NOTE] > Note > > This is the address range used for eth1 of the data nodes. For example, your cluster network subnet might use range 2.2.2.0/24. 10. Enter the elasticsearch cluster bind_host (eth1 IP Address of cluster master): `2.2.2.249` `Key generation successful. Moving the key to the client now.` 11. When prompted enter the npscp user password of the host: `The authenticity of host '10.128.33.249 (10.128.33.249)' can't be established.` `ECDSA key fingerprint is 14:6d:4f:65:4b:37:6b:03:50:5a:0a:45:b7:fd:67:b0.` `Are you sure you want to continue connecting (yes/no)? yes` `Warning: Permanently added '10.128.33.249' (ECDSA) to the list of known hosts.` `npscp@10.128.33.249's password:` `clus-1.tar.gz 100% 5395 5.3KB/s 00:00` `Transfer completed SUCCESSFULLY 10.128.33.249` `Transfer of keys was successful. You will need to go to the Data Node and accept the keys now.` 12. Select `q` to quit and save changes. You must now go to the data node CLI and associate it with this director. This is explained in [Adding a data node to the director node](/network-and-platform/docs/distributed-search-2#adding-a-data-node-to-the-director-node). ### Adding a data node to the director node This section provides instructions for adding your NDR data node to your NDR director node. To add a data node to the director node: 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` 5. Enter data node: `npadmin@ia# datanode` 6. Select option `A` to add the director. 7. Enter the IP address of the director. ### Removing a data node from the director node Perform this procedure on the data node that you would like to remove from the director node. To remove a data node from the director node: 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` 5. Enter data node: `npadmin@ia# datanode` 6. Select r to remove the appliance as part of the setup. 7. Confirm the removal of the data node.