Skip to content

Commit 7d6d7c3

Browse files
authored
Merge pull request #287412 from tarTech23/erspnew
ERSPAN reduced version
2 parents 2a855ab + 5de998c commit 7d6d7c3

File tree

4 files changed

+43
-36
lines changed

4 files changed

+43
-36
lines changed

articles/defender-for-iot/organizations/ot-deploy/activate-deploy-sensor.md

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ This article is one in a series of articles describing the [deployment path](ot-
1313

1414
Several initial setup steps can be performed in the browser or via CLI.
1515

16-
- Use the browser if you can connect physical cables from your switch to the sensor to identify your interfaces correctly. Make sure to reconfigure your network adapter to match the default settings on the sensor.
17-
- Use the CLI if you know your networking details without needing to connect physical cables. Use the CLI if you can only connect to the sensor via iLo / iDrac
16+
- Use the browser if you can connect physical cables from your switch to the sensor to identify your interfaces correctly. Make sure to reconfigure your network adapter to match the default settings on the sensor.
17+
- Use the CLI if you know your networking details without needing to connect physical cables. Use the CLI if you can only connect to the sensor via iLo / iDrac
1818

1919
Configuring your setup via the CLI still requires you to complete the last few steps in the browser.
2020

@@ -154,7 +154,7 @@ Use the **Certificates** tab to deploy an SSL/TLS certificate on your OT sensor.
154154
>
155155
> For more information, see [Manage SSL/TLS certificates](../how-to-manage-individual-sensors.md#manage-ssltls-certificates).
156156
157-
1. In the **Validation of on-premises management console certificate** area, select **Mandatory** to validate an on-premises management console's certificate against a certificate revocation list (CRL), as [configured in your certificate](../best-practices/certificate-requirements.md#crt-file-requirements).
157+
1. In the **Validation of on-premises management console certificate** area, select **Mandatory** to validate an on-premises management console's certificate against a certificate revocation list (CRL), as [configured in your certificate](../best-practices/certificate-requirements.md#crt-file-requirements).
158158

159159
For more information, see [SSL/TLS certificate requirements for on-premises resources](../best-practices/certificate-requirements.md) and [Create SSL/TLS certificates for OT appliances](create-ssl-certificates.md).
160160

@@ -170,6 +170,10 @@ Use this procedure to configure the following initial setup settings via CLI:
170170

171171
Continue with [activating](#activate-your-ot-sensor) and [configuring SSL/TLS certificate settings](#define-ssltls-certificate-settings) in the browser.
172172

173+
> [!NOTE]
174+
> The information in this article applies to the sensor version 24.1.5. If you are running an earlier version, see [configure ERSPAN mirroring](../traffic-mirroring/configure-mirror-erspan.md).
175+
>
176+
173177
**To configure initial setup settings via CLI**:
174178

175179
1. In the installation screen, after the default networking details are shown, press **ENTER** to continue.
@@ -185,60 +189,64 @@ Continue with [activating](#activate-your-ot-sensor) and [configuring SSL/TLS ce
185189

186190
When prompted to confirm your password, enter your new password again. For more information, see [Default privileged users](../manage-users-sensor.md#default-privileged-users).
187191

188-
The `Package configuration` Linux configuration wizard opens. In this wizard, use the up or down arrows to navigate, and the **SPACE** bar to select an option. Press **ENTER** to advance to the next screen.
189-
190-
1. In the wizard's `Select monitor interfaces` screen, select any of the interfaces you want to monitor with this sensor.
191-
192-
The system selects the first interface it finds as the management interface, and we recommend that you leave the default selection. If you decide to use a different port as the management interface, the change is implemented only after the sensor restarts. In such cases, make sure that the sensor is connected as needed.
192+
1. After changing the password, the `Sensor Config` wizard automatically starts. Continue to step 5.
193193

194-
For example:
194+
If you're logging in on subsequent occasions continue to step 4.
195195

196-
:::image type="content" source="../media/install-software-ot-sensor/select-monitor-interfaces.png" alt-text="Screenshot of the Select monitor interfaces screen.":::
196+
1. To start the `Sensor Config` wizard, at the prompt type `network reconfigure`. If you are using the cyberx user, type `ERSPAN=1 python3 -m cyberx.config.configure`.
197197

198-
> [!IMPORTANT]
199-
> Make sure that you select only interfaces that are connected.
200-
>
201-
> If you select interfaces that are enabled but not connected, the sensor will show a *No traffic monitored* health notification in the Azure portal. If you connect more traffic sources after installation and want to monitor them with Defender for IoT, you can add them later via the [CLI](../references-work-with-defender-for-iot-cli-commands.md).
202-
203-
1. In the `Select management interface` screen, select the interface you want to use to connect to the Azure portal or an on-premises management console.
198+
1. The `Sensor Config` screen shows the present setup of the interfaces. Ensure that one interface is set as the management interface. In this wizard, use the up or down arrows to navigate, and the **SPACE** bar to select an option. Press **ENTER** to advance to the next screen.
204199

205-
For example:
200+
Select the interface you want to configure, for example:
206201

207-
:::image type="content" source="../media/install-software-ot-sensor/select-management-interface.png" alt-text="Screenshot of the Select management interface screen.":::
202+
:::image type="content" source="media/activate-deploy-sensor/ersp-cli-settings.png" alt-text="Screenshot of the Select monitor interfaces screen.":::
208203

209-
1. In the `Enter sensor IP address` screen, enter the IP address you want to use for this sensor. Use this IP address to connect to the sensor via CLI or the browser. For example:
204+
1. In the `Select type` screen select the new configuration type for this interface.
210205

211-
:::image type="content" source="../media/install-software-ot-sensor/enter-sensor-ip-address.png" alt-text="Screenshot of the Enter sensor IP address screen.":::
206+
> [!IMPORTANT]
207+
> Make sure that you select only interfaces that are connected.
208+
>
209+
> If you select interfaces that are enabled but not connected, the sensor will show a *No traffic monitored* health notification in the Azure portal. If you connect more traffic sources after installation and want to monitor them with Defender for IoT, you can add them later via the [CLI](../references-work-with-defender-for-iot-cli-commands.md).
210+
>
212211
213-
1. In the `Enter path to the mounted backups folder` screen, enter the path to the sensor's mounted backups. We recommend using the default path of `/opt/sensor/persist/backups`. For example:
212+
An interface can be set as either **Management**, **Monitor**, **Tunnel** or **Unused**. You may wish to set an interface as **Unused** as a temporary setting, to reset it, or if a mistake was made in the original setup.
214213

215-
:::image type="content" source="../media/install-software-ot-sensor/mounted-backups.png" alt-text="Screenshot of the mounted backups folder configuration.":::
214+
1. To configure a **Management** interface:
216215

217-
1. In the `Enter Subnet Mask` screen, enter the IP address for the sensor's subnet mask. For example:
216+
1. Select the interface.
217+
1. Select **Management**.
218+
1. Type the sensor's **IP address**, **DNS server** IP address and the default **Gateway** IP address.
218219

219-
:::image type="content" source="../media/install-software-ot-sensor/subnet-mask.png" alt-text="Screenshot of the Enter Subnet Mask screen.":::
220+
:::image type="content" source="media/activate-deploy-sensor/ersp-cli-management-settings.png" alt-text="Screenshot of the interface Management screen.":::
220221

221-
1. In the `Enter Gateway` screen, enter the sensor's default gateway IP address. For example:
222+
1. Select **Back**.
222223

223-
:::image type="content" source="../media/install-software-ot-sensor/enter-gateway.png" alt-text="Screenshot of the Enter Gateway screen.":::
224+
1. To configure a **Monitor** interface:
224225

225-
1. In the `Enter DNS server` screen, enter the sensor's DNS server IP address. For example:
226+
1. Select the interface.
227+
1. Select **Monitor**. The **Sensor Config** screen updates.
226228

227-
:::image type="content" source="../media/install-software-ot-sensor/enter-dns-server.png" alt-text="Screenshot of the Enter DNS server screen.":::
229+
1. To configure an **ERSPAN** interface:
228230

229-
1. In the `Enter hostname` screen, enter a name you want to use as the sensor hostname. Make sure that you use the same hostname as is defined in the DNS server. For example:
231+
1. Select **Type**.
232+
1. Select **ERSPAN**.
233+
1. Select **Confirm**.
230234

231-
:::image type="content" source="../media/install-software-ot-sensor/enter-hostname.png" alt-text="Screenshot of the Enter hostname screen.":::
235+
1. To configure an interface as **Unused**:
232236

233-
1. In the `Run this sensor as a proxy server (Preview)` screen, select `<Yes>` only if you want to configure a proxy, and then enter the proxy credentials as prompted. For more information, see [Configure proxy settings on an OT sensor](../connect-sensors.md).
237+
1. Select the interface.
238+
1. Select the existing status.
239+
1. Select **Unused**. The **Sensor Config** screen updates.
234240

235-
The default configuration is without a proxy.
241+
1. After configuring all of the interfaces, select **Save**.
236242

237-
1. The configuration process starts running, reboots, and then prompts you to sign in again. For example:
243+
### Automatic backup folder location
238244

239-
:::image type="content" source="../media/install-software-ot-sensor/final-cli-sign-in.png" alt-text="Screenshot of the final sign-in prompt at the end of the initial CLI configuration.":::
245+
The sensor automatically creates a backup folder. To change the location of the mounted backups you must:
240246

241-
At this point, open a browser to the IP address you'd defined for your sensor and continue the setup in the browser. For more information, see [Activate your OT sensor](#activate-your-ot-sensor).
247+
1. Log in to the sensor using the **admin** user.
248+
1. Type the following code in the CLI interface: `system backup path` and then add the path location, for example `/opt/sensor/backup`.
249+
1. The backup runs automatically and might take up to one minute.
242250

243251
> [!NOTE]
244252
> During initial setup, options for ERSPAN monitoring ports are available only in the browser-based procedure.
@@ -250,6 +258,5 @@ At this point, open a browser to the IP address you'd defined for your sensor an
250258

251259
> [!div class="step-by-step"]
252260
> [« Validate an OT sensor software installation](post-install-validation-ot-software.md)
253-
254261
> [!div class="step-by-step"]
255262
> [Configure proxy settings on an OT sensor »](../connect-sensors.md)
1021 Bytes
Loading
9.09 KB
Loading
14 KB
Loading

0 commit comments

Comments
 (0)